feat(#157): add package list generator (#163)

package.json

@@ -13,7 +13,7 @@
     "build:docs": "./packages/docgen/bin/druxt-docgen.js",
     "changeset": "changeset",
     "clean": "yarn clean:dist && yarn clean:docs",
-    "clean:docs": "rimraf docs/content/api/packages || true",
+    "clean:docs": "rimraf docs/content/api || true",
     "clean:dist": "rimraf packages/*/dist || true",
     "dev": "siroc dev",
     "lint": "eslint --ext .js,.vue packages/*/src",

packages/docgen/src/index.js

@@ -13,12 +13,33 @@ const cwd = path.join(__dirname, '..')
  * DruxtDocgen class.
  */
 class DruxtDocgen {
+  constructor() {
+    this.destination = 'docs/content/api/'
+  }
+
   /**
    * Generate documentation for source JS and Vue files.
    */
-  async generateDocs () {
+  async generateDocs() {
     consola.info('Generating docs')
 
+    /**
+     * Generate list of packages.
+     */
+    await this.generatePackageList()
+
+    /**
+     * Generate API documents.
+     */
+    await this.generateApiDocs()
+  }
+
+  /**
+   * Generate API documents.
+   */
+  async generateApiDocs() {
+    consola.info('Generating API documents')
+
     const files = await globby([
       // Javascript.
       'packages/**/src/**/*.js',
@@ -27,30 +48,76 @@ class DruxtDocgen {
       // Exclude fixtures, mocks and tests.
       '!**/__*__/**/*',
     ])
-  
+
     for (const file of files) {
       // Get JSDoc template data from file.
       const templateData = jsdoc2md.getTemplateDataSync({
         configure: path.resolve(__dirname, '../jsdoc.json'),
         files: file,
       })
-  
+
       // Process file based on extension.
       if (file.match(/\.js$/)) {
         await this.processJs(file, templateData)
       }
       else {
         await this.processVue(file, templateData)
       }
-  
-      this.writeData(file, templateData)
+
+      this.writeTemplateData(file, templateData)
     }
   }
 
+  /**
+   * Generate list of packages.
+   */
+  async generatePackageList() {
+    consola.info('Generating package list')
+
+    const packageFiles = await globby('packages/**/package.json')
+    const packages = packageFiles
+      // Load package data.
+      .map((file) => ({
+        ...require(path.resolve(__dirname, '../../..', file)),
+        __dir: file.split('/')[1],
+      }))
+      // Filter and sort data
+      .filter((o) => !o.private)
+      .sort((a, b) => a.__dir === 'druxt' ? -1 : a < b)
+      // Process package data.
+      .map((pkg) =>
+        `## ${pkg.name}
+
+<div class="text-sm">
+
+Version: \`${pkg.version}\`
+
+</div>
+
+${pkg.description}
+
+[Read the docs](/api/packages/${pkg.__dir}/)
+`)
+
+    const destination = this.destination + 'README.md'
+    mkdirp.sync(path.dirname(destination))
+
+    fs.writeFileSync(destination, `---
+title: Packages
+---
+
+${packages.join('\n* * *\n\n')}
+
+* * *
+
+_Note: The contents of this file where automatically generated by the [Druxt Docgen](https://github.com/druxt/druxt.js/tree/develop/packages/docgen)._
+`)
+  }
+
   /**
    * Process Javascript files.
    */
-  async processJs (file, templateData) {
+  async processJs(file, templateData) {
     templateData.map(item => {
       // Vuex state scope fix.
       if (item.name === 'state' && item.scope === 'inner') {
@@ -69,7 +136,7 @@ class DruxtDocgen {
   /**
    * Process Vue.js files.
    */
-  async processVue (file, templateData) {
+  async processVue(file, templateData) {
     // Get data from vue-docgen-api.
     const data = await vueDocs.parse(file)
 
@@ -106,12 +173,12 @@ class DruxtDocgen {
   }
 
   /**
-   * Write data to file system.
+   * Write template data to file system.
    *
    * @param {string} file - The file name.
    * @param {*} data - The JSDoc / Vuedoc generated data.
    */
-  writeData (file, templateData) {
+  writeTemplateData(file, templateData) {
     if (!templateData) return
 
     const content = dmd(templateData, {
@@ -124,7 +191,7 @@ class DruxtDocgen {
     })
     if (!content) return
 
-    const destination = 'docs/content/api/' + file.replace('src/', '').replace(/\.[^/.]+$/, '.md')
+    const destination = this.destination + file.replace('src/', '').replace(/\.[^/.]+$/, '.md')
     mkdirp.sync(path.dirname(destination))
 
     // Build frontmatter.