Merge pull request #18 from iterative/auto-generate-commands

Author: yathomasi

.github/workflows/update-commands.yml

@@ -0,0 +1,31 @@
+name: Update tool commands list for Prismjs
+on:
+  schedule:
+    - cron: '0 10 * * 1-5'
+
+jobs:
+  fetch-commands:
+    name: Run script to fetch commands
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: 'yarn'
+      - uses: iterative/setup-cml@v1
+
+      - name: Install required package
+        run: yarn workspace @dvcorg/gatsby-theme-iterative add isomorphic-fetch
+
+      - name: Fetch commands
+        run: yarn get-commands all
+
+      - name: Check
+        run: |
+          if [[ `git status packages/gatsby-theme-iterative/config/prismjs --porcelain` ]]; then
+           cml pr create packages/gatsby-theme-iterative/config/prismjs --title "Update tool commands"
+          else 
+            echo "No changes!"
+          fi
+        env:
+          REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package.json

@@ -15,6 +15,7 @@
     "build": "yarn workspace example build",
     "serve": "yarn workspace example serve",
     "develop": "yarn workspace example develop",
+    "get-commands": "yarn workspace @dvcorg/gatsby-theme-iterative get-commands",
     "prepare": "husky install"
   },
   "workspaces": [

packages/gatsby-theme-iterative/config/prismjs/get-commands.js

@@ -0,0 +1,79 @@
+const fs = require('fs')
+require('isomorphic-fetch')
+
+const args = process.argv.slice(2)
+const tool = args[0] || 'dvc'
+
+const repoList = {
+  dvc: { repo: 'dvc.org', branch: 'main' },
+  cml: { repo: 'cml.dev', branch: 'master' },
+  mlem: { repo: 'mlem.ai', branch: 'main' }
+}
+
+const paths = ['command-reference', 'cli-reference', 'ref']
+
+const getUrl = (repo, branch = 'main') => {
+  return `https://raw.githubusercontent.com/iterative/${repo}/${branch}/content/docs/sidebar.json`
+}
+
+const writeCommandsToFile = async (commands, tool) => {
+  const file = `${__dirname}/${tool}-commands.js`
+
+  const start = 'module.exports = [\n'
+  const end = ']\n'
+  const content =
+    start + `${commands.map(cmd => `  '${cmd}'`).join(',\n')}\n` + end
+
+  fs.writeFileSync(file, content)
+}
+
+const getCommands = async tool => {
+  const url = getUrl(repoList[tool].repo, repoList[tool].branch)
+  const res = await fetch(url)
+  const sidebar = await res.json()
+  const cmdRef = sidebar.find(item => paths.includes(item.slug))
+  if (!cmdRef) {
+    throw new Error(`Could not find command reference in sidebar.json`)
+  }
+  const commands = []
+  cmdRef.children.forEach(item => {
+    const { label, children } = item
+    if (Array.isArray(children)) {
+      children.forEach(subitem => {
+        const { label } = subitem
+        commands.push(label)
+      })
+    }
+    commands.push(label)
+  })
+
+  writeCommandsToFile(commands, tool)
+}
+
+switch (tool) {
+  case 'dvc':
+  case 'cml':
+  case 'mlem':
+    {
+      getCommands(tool).catch(err => {
+        console.error(err)
+      })
+    }
+    break
+  case 'all': {
+    // dvc
+    getCommands('dvc').catch(err => {
+      console.error(err)
+    })
+    // cml
+    getCommands('cml').catch(err => {
+      console.error(err)
+    })
+    // mlem
+    getCommands('mlem').catch(err => {
+      console.error(err)
+    })
+  }
+  default:
+    break
+}

packages/gatsby-theme-iterative/package.json

@@ -6,6 +6,9 @@
   "types": "src/typings.d.ts",
   "author": "Roger Parent (@rogermparent)",
   "license": "MIT",
+  "scripts": {
+    "get-commands": "node config/prismjs/get-commands.js"
+  },
   "dependencies": {
     "@reach/portal": "^0.17.0",
     "@reach/router": "^1.3.4",