all-contributors-for-repository 0.3.1 → 0.4.0

package/README.md

@@ -86,6 +86,8 @@ Additionally, based on PR [conventional commit titles](https://www.conventionalc
 > 	await $`npx all-contributors add ${contributor} ${contributionTypes}`;
 > }
 > ```
+>
+> See [populate-all-contributors-for-repository](https://github.com/JoshuaKGoldberg/populate-all-contributors-for-repository) for a project that does just that. 📋
 
 ### Options
 

package/lib/collect/api.d.ts

@@ -4,7 +4,7 @@ interface RequestDefaults {
     owner: string;
     repo: string;
 }
-declare function createOctokit(auth: string | undefined): Octokit;
+declare function createOctokit(auth: string | undefined): Promise<Octokit>;
 interface RequestOptionsWithPage extends RequestDefaults {
     page: number;
     per_page: number;

package/lib/collect/api.js

@@ -1,12 +1,13 @@
-import { Octokit } from "octokit";
+import { octokitFromAuthSafe } from "octokit-from-auth";
 const perPage = 100;
-function createOctokit(auth) {
-  return new (Octokit.defaults({
+async function createOctokit(auth) {
+  return await octokitFromAuthSafe({
+    auth,
     headers: {
       "X-GitHub-Api-Version": "2022-11-28"
     },
     per_page: perPage
-  }))({ auth });
+  });
 }
 async function paginate(defaults, request) {
   const items = [];

package/lib/collect/api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collect/api.ts"],"sourcesContent":["import { Octokit } from \"octokit\";\n\nconst perPage = 100;\n\nexport interface RequestDefaults {\n\towner: string;\n\trepo: string;\n}\n\nexport function createOctokit(auth: string | undefined): Octokit {\n\treturn new (Octokit.defaults({\n\t\theaders: {\n\t\t\t\"X-GitHub-Api-Version\": \"2022-11-28\",\n\t\t},\n\t\tper_page: perPage,\n\t}))({ auth });\n}\n\nexport interface RequestOptionsWithPage extends RequestDefaults {\n\tpage: number;\n\tper_page: number;\n}\n\nexport async function paginate<T>(\n\tdefaults: RequestDefaults,\n\trequest: (requestOptions: RequestOptionsWithPage) => Promise<T[]>,\n) {\n\tconst items: T[] = [];\n\n\tfor (let i = 0; i < 10; i += 1) {\n\t\tconst response = await request({ page: i, per_page: perPage, ...defaults });\n\n\t\titems.push(...response);\n\n\t\tif (response.length < 100) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\treturn items;\n}\n"],"mappings":"AAAA,SAAS,eAAe;AAExB,MAAM,UAAU;AAOT,SAAS,cAAc,MAAmC;AAChE,SAAO,KAAK,QAAQ,SAAS;AAAA,IAC5B,SAAS;AAAA,MACR,wBAAwB;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,EACX,CAAC,GAAG,EAAE,KAAK,CAAC;AACb;AAOA,eAAsB,SACrB,UACA,SACC;AACD,QAAM,QAAa,CAAC;AAEpB,WAAS,IAAI,GAAG,IAAI,IAAI,KAAK,GAAG;AAC/B,UAAM,WAAW,MAAM,QAAQ,EAAE,MAAM,GAAG,UAAU,SAAS,GAAG,SAAS,CAAC;AAE1E,UAAM,KAAK,GAAG,QAAQ;AAEtB,QAAI,SAAS,SAAS,KAAK;AAC1B;AAAA,IACD;AAAA,EACD;AAEA,SAAO;AACR;","names":[]}
+{"version":3,"sources":["../../src/collect/api.ts"],"sourcesContent":["import { Octokit } from \"octokit\";\nimport { octokitFromAuthSafe } from \"octokit-from-auth\";\n\nconst perPage = 100;\n\nexport interface RequestDefaults {\n\towner: string;\n\trepo: string;\n}\n\nexport async function createOctokit(\n\tauth: string | undefined,\n): Promise<Octokit> {\n\treturn await octokitFromAuthSafe({\n\t\tauth,\n\t\theaders: {\n\t\t\t\"X-GitHub-Api-Version\": \"2022-11-28\",\n\t\t},\n\t\tper_page: perPage,\n\t});\n}\n\nexport interface RequestOptionsWithPage extends RequestDefaults {\n\tpage: number;\n\tper_page: number;\n}\n\nexport async function paginate<T>(\n\tdefaults: RequestDefaults,\n\trequest: (requestOptions: RequestOptionsWithPage) => Promise<T[]>,\n) {\n\tconst items: T[] = [];\n\n\tfor (let i = 0; i < 10; i += 1) {\n\t\tconst response = await request({ page: i, per_page: perPage, ...defaults });\n\n\t\titems.push(...response);\n\n\t\tif (response.length < 100) {\n\t\t\tbreak;\n\t\t}\n\t}\n\n\treturn items;\n}\n"],"mappings":"AACA,SAAS,2BAA2B;AAEpC,MAAM,UAAU;AAOhB,eAAsB,cACrB,MACmB;AACnB,SAAO,MAAM,oBAAoB;AAAA,IAChC;AAAA,IACA,SAAS;AAAA,MACR,wBAAwB;AAAA,IACzB;AAAA,IACA,UAAU;AAAA,EACX,CAAC;AACF;AAOA,eAAsB,SACrB,UACA,SACC;AACD,QAAM,QAAa,CAAC;AAEpB,WAAS,IAAI,GAAG,IAAI,IAAI,KAAK,GAAG;AAC/B,UAAM,WAAW,MAAM,QAAQ,EAAE,MAAM,GAAG,UAAU,SAAS,GAAG,SAAS,CAAC;AAE1E,UAAM,KAAK,GAAG,QAAQ;AAEtB,QAAI,SAAS,SAAS,KAAK;AAC1B;AAAA,IACD;AAAA,EACD;AAEA,SAAO;AACR;","names":[]}

package/lib/collect/index.js

@@ -8,7 +8,7 @@ import { collectRepoEvents } from "./collecting/collectRepoEvents.js";
 import { processContributors } from "./processing/processContributors.js";
 async function collect(options) {
   const defaults = { owner: options.owner, repo: options.repo };
-  const octokit = createOctokit(options.auth);
+  const octokit = await createOctokit(options.auth);
   const [acceptedIssues, issueEvents, mergedPulls, repoEvents] = await Promise.all([
     collectAcceptedIssues(defaults, octokit, options.labelAcceptingPrs),
     collectIssueEvents(defaults, octokit),

package/lib/collect/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/collect/index.ts"],"sourcesContent":["import { ContributorsContributions } from \"../ContributorsCollection.js\";\nimport { AllContributorsForRepositoryOptions } from \"../options.js\";\nimport { addAcceptedIssues } from \"./adding/addAcceptedIssues.js\";\nimport { addMergedPulls } from \"./adding/addMergedPulls.js\";\nimport { createOctokit } from \"./api.js\";\nimport { collectAcceptedIssues } from \"./collecting/collectAcceptedIssues.js\";\nimport { collectIssueEvents } from \"./collecting/collectIssueEvents.js\";\nimport { collectMergedPulls } from \"./collecting/collectMergedPulls.js\";\nimport { collectRepoEvents } from \"./collecting/collectRepoEvents.js\";\nimport { processContributors } from \"./processing/processContributors.js\";\n\nexport async function collect(\n\toptions: AllContributorsForRepositoryOptions,\n): Promise<ContributorsContributions> {\n\tconst defaults = { owner: options.owner, repo: options.repo };\n\tconst octokit = createOctokit(options.auth);\n\n\t// 1. Collect event data from the GitHub API\n\tconst [acceptedIssues, issueEvents, mergedPulls, repoEvents] =\n\t\tawait Promise.all([\n\t\t\tcollectAcceptedIssues(defaults, octokit, options.labelAcceptingPrs),\n\t\t\tcollectIssueEvents(defaults, octokit),\n\t\t\tcollectMergedPulls(defaults, octokit),\n\t\t\tcollectRepoEvents(defaults, octokit),\n\t\t]);\n\n\t// 2. Process individual contributors from those events\n\tconst contributors = processContributors(issueEvents, repoEvents, options);\n\n\t// 3. Add additional contributors based on issues and pulls\n\taddAcceptedIssues(Object.values(acceptedIssues), contributors, options);\n\tawait addMergedPulls(mergedPulls, contributors, octokit);\n\n\t// 4. Collect the contributions under each contributor\n\treturn contributors.collect();\n}\n"],"mappings":"AAEA,SAAS,yBAAyB;AAClC,SAAS,sBAAsB;AAC/B,SAAS,qBAAqB;AAC9B,SAAS,6BAA6B;AACtC,SAAS,0BAA0B;AACnC,SAAS,0BAA0B;AACnC,SAAS,yBAAyB;AAClC,SAAS,2BAA2B;AAEpC,eAAsB,QACrB,SACqC;AACrC,QAAM,WAAW,EAAE,OAAO,QAAQ,OAAO,MAAM,QAAQ,KAAK;AAC5D,QAAM,UAAU,cAAc,QAAQ,IAAI;AAG1C,QAAM,CAAC,gBAAgB,aAAa,aAAa,UAAU,IAC1D,MAAM,QAAQ,IAAI;AAAA,IACjB,sBAAsB,UAAU,SAAS,QAAQ,iBAAiB;AAAA,IAClE,mBAAmB,UAAU,OAAO;AAAA,IACpC,mBAAmB,UAAU,OAAO;AAAA,IACpC,kBAAkB,UAAU,OAAO;AAAA,EACpC,CAAC;AAGF,QAAM,eAAe,oBAAoB,aAAa,YAAY,OAAO;AAGzE,oBAAkB,OAAO,OAAO,cAAc,GAAG,cAAc,OAAO;AACtE,QAAM,eAAe,aAAa,cAAc,OAAO;AAGvD,SAAO,aAAa,QAAQ;AAC7B;","names":[]}
+{"version":3,"sources":["../../src/collect/index.ts"],"sourcesContent":["import { ContributorsContributions } from \"../ContributorsCollection.js\";\nimport { AllContributorsForRepositoryOptions } from \"../options.js\";\nimport { addAcceptedIssues } from \"./adding/addAcceptedIssues.js\";\nimport { addMergedPulls } from \"./adding/addMergedPulls.js\";\nimport { createOctokit } from \"./api.js\";\nimport { collectAcceptedIssues } from \"./collecting/collectAcceptedIssues.js\";\nimport { collectIssueEvents } from \"./collecting/collectIssueEvents.js\";\nimport { collectMergedPulls } from \"./collecting/collectMergedPulls.js\";\nimport { collectRepoEvents } from \"./collecting/collectRepoEvents.js\";\nimport { processContributors } from \"./processing/processContributors.js\";\n\nexport async function collect(\n\toptions: AllContributorsForRepositoryOptions,\n): Promise<ContributorsContributions> {\n\tconst defaults = { owner: options.owner, repo: options.repo };\n\tconst octokit = await createOctokit(options.auth);\n\n\t// 1. Collect event data from the GitHub API\n\tconst [acceptedIssues, issueEvents, mergedPulls, repoEvents] =\n\t\tawait Promise.all([\n\t\t\tcollectAcceptedIssues(defaults, octokit, options.labelAcceptingPrs),\n\t\t\tcollectIssueEvents(defaults, octokit),\n\t\t\tcollectMergedPulls(defaults, octokit),\n\t\t\tcollectRepoEvents(defaults, octokit),\n\t\t]);\n\n\t// 2. Process individual contributors from those events\n\tconst contributors = processContributors(issueEvents, repoEvents, options);\n\n\t// 3. Add additional contributors based on issues and pulls\n\taddAcceptedIssues(Object.values(acceptedIssues), contributors, options);\n\tawait addMergedPulls(mergedPulls, contributors, octokit);\n\n\t// 4. Collect the contributions under each contributor\n\treturn contributors.collect();\n}\n"],"mappings":"AAEA,SAAS,yBAAyB;AAClC,SAAS,sBAAsB;AAC/B,SAAS,qBAAqB;AAC9B,SAAS,6BAA6B;AACtC,SAAS,0BAA0B;AACnC,SAAS,0BAA0B;AACnC,SAAS,yBAAyB;AAClC,SAAS,2BAA2B;AAEpC,eAAsB,QACrB,SACqC;AACrC,QAAM,WAAW,EAAE,OAAO,QAAQ,OAAO,MAAM,QAAQ,KAAK;AAC5D,QAAM,UAAU,MAAM,cAAc,QAAQ,IAAI;AAGhD,QAAM,CAAC,gBAAgB,aAAa,aAAa,UAAU,IAC1D,MAAM,QAAQ,IAAI;AAAA,IACjB,sBAAsB,UAAU,SAAS,QAAQ,iBAAiB;AAAA,IAClE,mBAAmB,UAAU,OAAO;AAAA,IACpC,mBAAmB,UAAU,OAAO;AAAA,IACpC,kBAAkB,UAAU,OAAO;AAAA,EACpC,CAAC;AAGF,QAAM,eAAe,oBAAoB,aAAa,YAAY,OAAO;AAGzE,oBAAkB,OAAO,OAAO,cAAc,GAAG,cAAc,OAAO;AACtE,QAAM,eAAe,aAAa,cAAc,OAAO;AAGvD,SAAO,aAAa,QAAQ;AAC7B;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "all-contributors-for-repository",
-	"version": "0.3.1",
+	"version": "0.4.0",
 	"description": "Generates an allcontributors list for an existing repository. 🤝",
 	"repository": {
 		"type": "git",
@@ -40,7 +40,8 @@
 		"co-author-to-username": "^0.1.1",
 		"conventional-commits-parser": "^6.0.0",
 		"description-to-co-authors": "^0.3.0",
-		"octokit": "^4.0.0"
+		"octokit": "^4.0.0",
+		"octokit-from-auth": "^0.3.0"
 	},
 	"devDependencies": {
 		"@release-it/conventional-changelog": "^9.0.0",
@@ -65,7 +66,7 @@
 		"eslint-plugin-yml": "^1.11.0",
 		"husky": "^9.0.0",
 		"jsonc-eslint-parser": "^2.4.0",
-		"knip": "5.39.2",
+		"knip": "5.40.0",
 		"lint-staged": "^15.2.0",
 		"markdownlint": "^0.37.0",
 		"markdownlint-cli": "^0.43.0",