Merge pull request #21 from CodeshiftCommunity/generate-docs

📚 Auto generate explore tab on website

Author: danieldelcore

.github/workflows/documentation.yml

@@ -15,6 +15,10 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: '14.x'
+      - name: Generate docs
+        run: |
+          yarn install --frozen-lockfile
+          yarn predocs:start
       - name: Test Build
         run: |
           cd website
@@ -31,6 +35,10 @@ jobs:
       - uses: webfactory/ssh-agent@v0.5.0
         with:
           ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}
+      - name: Generate docs
+        run: |
+          yarn install --frozen-lockfile
+          yarn predocs:start
       - name: Release to GitHub Pages
         env:
           USE_SSH: true

.gitignore

@@ -1,6 +1,7 @@
 # Repo
 .tmp/
 plugin_packages/
+website/docs/explore/*
 
 # Logs
 logs

.nvmrc

@@ -0,0 +1 @@
+14.16.0

package.json

@@ -7,6 +7,7 @@
   "license": "MIT",
   "private": true,
   "scripts": {
+    "predocs:start": "ts-node scripts/docs",
     "docs:start": "cd website && yarn start",
     "postinstall": "preconstruct dev && yarn monorepo:check",
     "build": "yarn clean && preconstruct build",

scripts/docs.ts

@@ -0,0 +1,82 @@
+import fs from 'fs-extra';
+
+const COMMUNITY_PATH = `${__dirname}/../community`;
+const DOCS_PATH = `${__dirname}/../website/docs/explore`;
+
+function cleanTargetDir(path: string) {
+  if (fs.existsSync(path)) fs.emptyDirSync(path);
+}
+
+interface Config {
+  maintainers: string[];
+  transforms: {
+    [key: string]: any;
+  };
+}
+
+interface DocsData {
+  name: string;
+  config: Config;
+}
+
+function main() {
+  const communityCodemods = fs.readdirSync(COMMUNITY_PATH);
+  const data: DocsData[] = [];
+
+  communityCodemods.forEach(dir => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const config = require(`${COMMUNITY_PATH}/${dir}/codeshift.config.js`)
+      .default;
+
+    data.push({
+      name: dir,
+      config,
+    });
+  });
+
+  cleanTargetDir(DOCS_PATH);
+
+  data.forEach(({ name, config }) => {
+    const safeName = name.replace('@', '');
+    const rawName = name.replace('__', '/');
+    const urlSafeName = encodeURIComponent(name);
+    const packageLink = `[${rawName}](https://www.npmjs.com/package/${rawName})`;
+
+    fs.outputFileSync(
+      `${DOCS_PATH}/${name}.mdx`,
+      `---
+id: ${safeName}
+title: ${safeName.replace('__', '/')}
+slug: /${safeName}
+---
+
+**Target package:** ${packageLink}
+
+**Maintainers:**
+${config.maintainers.map(
+  maintainer => `- [${maintainer}](https://github.com/${maintainer})`,
+)}
+
+${Object.keys(config.transforms)
+  .map(
+    key => `## ${key}
+
+[Source](https://github.com/CodeshiftCommunity/CodeshiftCommunity/tree/main/community/${urlSafeName}) | [Report an issue](https://github.com/CodeshiftCommunity/CodeshiftCommunity/issues/new?title=${safeName}@${key})
+
+Migrates ${packageLink} to version ${key}.
+
+### Usage
+
+
+\`\`\`
+npx @codeshift/cli --packages ${name}@${key} path/to/source
+\`\`\`
+`,
+  )
+  .join('')}
+`,
+    );
+  });
+}
+
+main();

tsconfig.json

@@ -24,6 +24,6 @@
       "@codeshift/*": ["../packages/*/src"]
     }
   },
-  "include": ["packages/**/*", "community/**/*", ".tmp/**/*"],
+  "include": ["packages/**/*", "community/**/*", ".tmp/**/*", "scripts"],
   "exclude": ["node_modules", "dist", "__tests__", "**/*.test*", "**/*.spec*"]
 }

website/docusaurus.config.js

@@ -29,6 +29,12 @@ module.exports = {
           label: 'API',
           position: 'left',
         },
+        {
+          type: 'doc',
+          docId: 'explore/atlaskit__avatar',
+          label: 'Explore',
+          position: 'left',
+        },
         {
           href: 'https://github.com/CodeshiftCommunity/CodeshiftCommunity',
           label: 'GitHub',

website/package.json

@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-alpha.72",
-    "@docusaurus/preset-classic": "2.0.0-alpha.72",
+    "@docusaurus/core": "2.0.0-beta.0",
+    "@docusaurus/preset-classic": "2.0.0-beta.0",
     "@mdx-js/react": "^1.6.21",
     "clsx": "^1.1.1",
     "react": "^17.0.1",
@@ -33,4 +33,4 @@
       "last 1 safari version"
     ]
   }
-}
+}

website/sidebars.js

@@ -44,4 +44,10 @@ module.exports = {
       items: ['api/cli', 'api/utils', 'api/test-utils'],
     },
   ],
+  explore: [
+    {
+      dirName: 'explore',
+      type: 'autogenerated',
+    },
+  ],
 };