fix: direct links to install apps on correct repository, add toc

octokit · Mar 25, 2021 · 8aec6cb · 8aec6cb
1 parent f8616e2
commit 8aec6cb
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 9 deletions.
diff --git a/create-octokit-project.js b/create-octokit-project.js
@@ -88,7 +88,7 @@ async function main() {
   });
 
   const {
-    data: { login, name, email, blog: website },
+    data: { id: userId, login, name, email, blog: website },
   } = await octokit.request("GET /user");
 
   try {
@@ -102,6 +102,14 @@ async function main() {
     const [owner, repo] = answers.repository.split("/");
     const isUserRepo = answers.repository.startsWith(login);
 
+    let ownerId = userId;
+    if (!isUserRepo) {
+      const { data } = await octokit.request("GET /orgs/{org}", {
+        org: owner,
+      });
+      ownerId = data.id;
+    }
+
     // create project folder and chdir into it
     console.log(`Creating ${answers.path}`);
     await mkdir(answers.path, { recursive: true });
@@ -145,7 +153,9 @@ async function main() {
     await command("git add .github/ISSUE_TEMPLATE");
     await command("git commit -m 'docs(ISSUE_TEMPLATES): initial version'");
 
-    await createRepository(octokit, {
+    const {
+      data: { id: repositoryId },
+    } = await createRepository(octokit, {
       isUserRepo,
       owner,
       repo,
@@ -169,6 +179,8 @@ async function main() {
     await createPullRequest(octokit, {
       owner,
       repo,
+      ownerId,
+      repositoryId,
     });
 
     await createPackageJson(answers);
@@ -423,6 +435,7 @@ async function main() {
     await command(`git commit README.md -m 'docs(README): badges'`);
 
     await createReadme({
+      useOctokitOrg,
       addBadges: true,
       addUsage: true,
       repo,

diff --git a/lib/create-pull-request.js b/lib/create-pull-request.js
@@ -1,13 +1,20 @@
 module.exports = createPullRequest;
 
-async function createPullRequest(octokit, { owner, repo }) {
+async function createPullRequest(
+  octokit,
+  { owner, repo, ownerId, repositoryId }
+) {
   let body = `- [ ] Implement features. Create separate \`feat: ...\` commits for each feature of the initial version
 - [ ] 100% test coverage
-- [ ] Install https://github.com/apps/wip
-- [ ] Install https://github.com/apps/renovate
 `;
 
-  if (owner !== "octokit") {
+  if (owner === "octokit") {
+    body += `- [ ] [Install the WIP app](https://github.com/apps/wip/installations/new/permissions?suggested_target_id=${ownerId}&repository_ids[]=${repositoryId})
+- [ ] [Install the Renovate app](https://github.com/apps/renovate/installations/new/permissions?suggested_target_id=${ownerId}&repository_ids[]=${repositoryId})
+- [ ] [Install the Octokit JS Board app](https://github.com/apps/octokit-js-project-board/installations/new/permissions?suggested_target_id=${ownerId}&repository_ids[]=${repositoryId})
+- [ ] [Install the prettier-toc-me app](https://github.com/apps/prettier-toc-me/installations/new/permissions?suggested_target_id=${ownerId}&repository_ids[]=${repositoryId})
+`;
+  } else {
     body += `- [ ] Create npm token at \`https://www.npmjs.com/settings/<your npm username>/tokens/create\` (with "Read and Publish" selected) and add it as \`NPM_TOKEN\` at Then create secret at https://github.com/${owner}/${repo}/settings/secrets`;
   }
 

diff --git a/lib/create-readme.js b/lib/create-readme.js
@@ -9,6 +9,7 @@ async function createReadme({
   packageName,
   addWip,
   addBadges,
+  useOctokitOrg,
   addUsage,
   supportsBrowsers,
   supportsNode,
@@ -42,6 +43,17 @@ async function createReadme({
   }
 
   if (addUsage) {
+    if (useOctokitOrg) {
+      content += `<details>
+<summary>Table of contents</summary>
+
+<!-- toc -->
+
+</details>
+
+`;
+    }
+
     const UsageTitle = octokitUsageExample ? "Standalone usage" : "usage";
     content += `## ${UsageTitle}
 

diff --git a/lib/create-repository.js b/lib/create-repository.js
@@ -14,11 +14,10 @@ async function createRepository(
   };
 
   if (isUserRepo) {
-    await octokit.request("POST /user/repos", createRepoOptions);
-    return;
+    return octokit.request("POST /user/repos", createRepoOptions);
   }
 
-  await octokit.request("POST /orgs/{org}/repos", {
+  return octokit.request("POST /orgs/{org}/repos", {
     org: owner,
     ...createRepoOptions,
   });