v11.3.1 - fixed provided packageData being discarded for remote data

Author: balupton

HISTORY.md

@@ -1,5 +1,10 @@
 # History
 
+## v11.3.1 2023 December 28
+
+-   Fixed a regression in v11.2.0 where `packageData` would always be fetched remotely, now if it is probided, it is respected once again
+-   Thank you to the sponsors: [Andrew Nesbitt](https://nesbitt.io), [Balsa](https://balsa.com), [Codecov](https://codecov.io/), [Poonacha Medappa](https://poonachamedappa.com), [Rob Morris](https://github.com/Rob-Morris), [Sentry](https://sentry.io), [Syntax](https://syntax.fm)
+
 ## v11.3.0 2023 December 28
 
 -   Default cents thresholds to `100` in the API, rather than just the CLI

README.md

@@ -56,27 +56,27 @@ Interact with the GitHub API, fetching commits, repositories, members, and backe
 ### [Deno](https://deno.land "Deno is a secure runtime for JavaScript and TypeScript, it is an alternative for Node.js")
 
 ``` typescript
-import pkg from 'https://unpkg.com/@bevry/github-api@^11.3.0/edition-deno/index.ts'
+import pkg from 'https://unpkg.com/@bevry/github-api@^11.3.1/edition-deno/index.ts'
 ```
 ### [Skypack](https://www.skypack.dev "Skypack is a JavaScript Delivery Network for modern web apps")
 
 ``` html
 <script type="module">
-    import pkg from '//cdn.skypack.dev/@bevry/github-api@^11.3.0'
+    import pkg from '//cdn.skypack.dev/@bevry/github-api@^11.3.1'
 </script>
 ```
 ### [unpkg](https://unpkg.com "unpkg is a fast, global content delivery network for everything on npm")
 
 ``` html
 <script type="module">
-    import pkg from '//unpkg.com/@bevry/github-api@^11.3.0'
+    import pkg from '//unpkg.com/@bevry/github-api@^11.3.1'
 </script>
 ```
 ### [jspm](https://jspm.io "Native ES Modules CDN")
 
 ``` html
 <script type="module">
-    import pkg from '//dev.jspm.io/@bevry/github-api@11.3.0'
+    import pkg from '//dev.jspm.io/@bevry/github-api@11.3.1'
 </script>
 ```
 ### [Editions](https://editions.bevry.me "Editions are the best way to produce and consume packages you care about.")

package-lock.json

@@ -1,13 +1,13 @@
 {
   "name": "@bevry/github-api",
-  "version": "11.3.0",
+  "version": "11.3.1",
   "license": "Artistic-2.0",
   "description": "Interact with the GitHub API, fetching commits, repositories, members, and backers (authors, maintainers, contributors, funders, sponsors, donors)",
   "homepage": "https://github.com/bevry/github-api",
   "funding": "https://bevry.me/fund",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bevry/github-api.git"
+    "url": "git+https://github.com/bevry/github-api.git"
   },
   "bugs": {
     "url": "https://github.com/bevry/github-api/issues"

package.json

@@ -9,6 +9,7 @@ import writeFile from '@bevry/fs-write'
 
 // local
 import {
+	shouldAutomate,
 	Backers,
 	getBackers,
 	renderBackers,
@@ -88,17 +89,14 @@ const queryOptions: CliBackersQueryOptions = {
 	sponsorCentsThreshold: null,
 	donorCentsThreshold: null,
 }
-function auto(value: any) {
-	return value == null || value === true
-}
 async function action() {
 	// query
-	if (auto(queryOptions.githubSlug)) {
+	if (shouldAutomate(queryOptions.githubSlug)) {
 		queryOptions.githubSlug =
 			getGitHubSlugFromUrl(execSync('git remote get-url origin').toString()) ||
 			null
 	}
-	if (auto(queryOptions.packagePath)) {
+	if (shouldAutomate(queryOptions.packagePath)) {
 		if (await isReadable('package.json')) {
 			queryOptions.packagePath = 'package.json'
 			queryOptions.packageData = (await readJSON(
@@ -113,7 +111,7 @@ async function action() {
 		}
 	}
 	if (
-		auto(queryOptions.githubSlug) &&
+		shouldAutomate(queryOptions.githubSlug) &&
 		queryOptions.packageData &&
 		typeof queryOptions.packageData === 'object'
 	) {
@@ -124,7 +122,7 @@ async function action() {
 	// fetch
 	if (!result) result = await getBackers(queryOptions)
 	// write
-	if (auto(renderOptions.writePath)) {
+	if (shouldAutomate(renderOptions.writePath)) {
 		renderOptions.writePath = queryOptions.packagePath || 'package.json'
 	}
 	if (
@@ -133,7 +131,7 @@ async function action() {
 	) {
 		renderOptions.packageData = queryOptions.packageData
 	}
-	if (auto(renderOptions.format)) {
+	if (shouldAutomate(renderOptions.format)) {
 		if (typeof renderOptions.writePath === 'string') {
 			if (renderOptions.writePath.endsWith('package.json'))
 				renderOptions.format = BackersRenderFormat.package
@@ -151,7 +149,7 @@ async function action() {
 			else if (renderOptions.writePath.endsWith('.html'))
 				renderOptions.format = BackersRenderFormat.html
 		}
-		if (auto(renderOptions.format))
+		if (shouldAutomate(renderOptions.format))
 			renderOptions.format = BackersRenderFormat.string // @todo add a raw mode
 	}
 	// output

source/bin.ts

@@ -15,6 +15,14 @@ export { Fellow, PromisePool, Errlop }
 import { env } from 'node:process'
 const envCredentials = env as GitHubCredentials
 
+export function shouldAutomate(value: any): boolean {
+	return value == null || value === true
+}
+
+export function getFallback(value: any, fallback: any) {
+	return shouldAutomate(value) ? fallback : value
+}
+
 // ====================================
 // Our Types
 
@@ -513,8 +521,13 @@ export async function getBackersFromThanksDev(
 	username: string,
 	opts: BackersQueryOptions = {},
 ): Promise<ThanksDevBackers> {
-	const sponsorCentsThreshold = opts.sponsorCentsThreshold ?? 100
-	const donorCentsThreshold = opts.donorCentsThreshold ?? 100
+	// defaults
+	const sponsorCentsThreshold: number = getFallback(
+		opts.sponsorCentsThreshold,
+		100,
+	)
+	const donorCentsThreshold: number = getFallback(opts.donorCentsThreshold, 100)
+	// prepare
 	let sponsors: Array<ThanksDevDonor> = [],
 		donors: Array<ThanksDevDonor> = []
 	// monthly
@@ -618,8 +631,16 @@ export async function getBackersFromOpenCollective(
 	opts: BackersQueryOptions = {},
 ): Promise<OpenCollectiveBackers> {
 	try {
-		const sponsorCentsThreshold = opts.sponsorCentsThreshold ?? 100
-		const donorCentsThreshold = opts.donorCentsThreshold ?? 100
+		// defaults
+		const sponsorCentsThreshold: number = getFallback(
+			opts.sponsorCentsThreshold,
+			100,
+		)
+		const donorCentsThreshold: number = getFallback(
+			opts.donorCentsThreshold,
+			100,
+		)
+		// fetch
 		const url = `https://opencollective.com/${username}/members.json`
 		const resp = await fetch(url, {})
 		const profiles: OpenCollectiveResponse = await resp.json()
@@ -1899,11 +1920,15 @@ export async function getBackers(
 			{}
 	try {
 		// if auto-detect package data, fetch from slug if not offline
-		if (githubSlug && opts.packageData !== false && opts.offline !== true) {
+		if (
+			githubSlug &&
+			shouldAutomate(opts.packageData) &&
+			opts.offline !== true
+		) {
 			packageData = await getPackageData(githubSlug, {})
 		}
 		// if auto-detect slug, fetch from package data
-		if (opts.githubSlug !== false && packageData) {
+		if (shouldAutomate(opts.githubSlug) && packageData) {
 			githubSlug = getGitHubSlugFromPackageData(packageData) || ''
 		}