fix: add legacy-html-assets generator

Move asset folder copying to its own generator that we can call separately from
the legacy-html generator

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

bin/commands/generate.mjs

@@ -18,7 +18,7 @@ const availableGenerators = Object.keys(publicGenerators);
 
 /**
  * @typedef {Object} Options
- * @property {Array<string>|string} input - Specifies the glob/path for input files.
+ * @property {Array<string>|string} [input] - Specifies the glob/path for input files.
  * @property {Array<string>|string} [ignore] - Specifies the glob/path for ignoring files.
  * @property {Array<keyof publicGenerators>} target - Specifies the generator target mode.
  * @property {string} version - Specifies the target Node.js version.
@@ -42,7 +42,6 @@ export default {
         type: 'text',
         message: 'Enter input glob patterns',
         variadic: true,
-        required: true,
       },
     },
     ignore: {
@@ -131,7 +130,7 @@ export default {
    * @returns {Promise<void>}
    */
   async action(opts) {
-    const docs = await loadAndParse(opts.input, opts.ignore);
+    const docs = await loadAndParse(opts.inpu ?? [], opts.ignore);
     const releases = await parseChangelog(opts.changelog);
 
     const rawTypeMap = await loadFromURL(opts.typeMap);

eslint.config.mjs

@@ -92,7 +92,7 @@ export default defineConfig([
   },
   {
     files: [
-      'src/generators/legacy-html/assets/*.js',
+      'src/generators/legacy-html-assets/assets/*.js',
       'src/generators/web/ui/**/*',
     ],
     languageOptions: {

src/generators/index.mjs

@@ -7,6 +7,7 @@ import jsonSimple from './json-simple/index.mjs';
 import jsxAst from './jsx-ast/index.mjs';
 import legacyHtml from './legacy-html/index.mjs';
 import legacyHtmlAll from './legacy-html-all/index.mjs';
+import legacyHtmlAssets from './legacy-html-assets/index.mjs';
 import legacyJson from './legacy-json/index.mjs';
 import legacyJsonAll from './legacy-json-all/index.mjs';
 import llmsTxt from './llms-txt/index.mjs';
@@ -18,6 +19,7 @@ import web from './web/index.mjs';
 export const publicGenerators = {
   'json-simple': jsonSimple,
   'legacy-html': legacyHtml,
+  'legacy-html-assets': legacyHtmlAssets,
   'legacy-html-all': legacyHtmlAll,
   'man-page': manPage,
   'legacy-json': legacyJson,

src/generators/legacy-html/assets/api.js …erators/legacy-html-assets/assets/api.jssrc/generators/legacy-html/assets/api.js renamed to src/generators/legacy-html-assets/assets/api.js src/generators/legacy-html/assets/api.js renamed to src/generators/legacy-html-assets/assets/api.js

@@ -0,0 +1,50 @@
+// @ts-check
+'use strict';
+
+import { cp, rm } from 'node:fs/promises';
+import { join } from 'node:path';
+
+/**
+ * TODO docs
+ *
+ * @type {GeneratorMetadata<Input, Array<TemplateValues>>}
+ */
+export default {
+  name: 'legacy-html-assets',
+
+  version: '1.0.0',
+
+  description: 'TODO',
+
+  dependsOn: 'metadata',
+
+  /**
+   * Generates the legacy version of the API docs in HTML
+   * @param {Input} _
+   * @param {Partial<GeneratorOptions>} options
+   */
+  async generate(_, { output }) {
+    if (!output) {
+      return;
+    }
+
+    // Define the output folder for API docs assets
+    const assetsFolder = join(output, 'assets');
+
+    // Removes the current assets directory to copy the new assets
+    // and prevent stale assets from existing in the output directory
+    // If the path does not exists, it will simply ignore and continue
+    await rm(assetsFolder, { recursive: true, force: true, maxRetries: 10 });
+
+    // Current directory path relative to the `index.mjs` file
+    const baseDir = import.meta.dirname;
+
+    // We copy all the other assets to the output folder at the end of the process
+    // to ensure that all latest changes on the styles are applied to the output
+    // Note.: This is not meant to be used for DX/developer purposes.
+    await cp(join(baseDir, 'assets'), assetsFolder, {
+      recursive: true,
+      force: true,
+    });
+  },
+};

…ors/legacy-html/assets/js-flavor-cjs.svg …acy-html-assets/assets/js-flavor-cjs.svgsrc/generators/legacy-html/assets/js-flavor-cjs.svg renamed to src/generators/legacy-html-assets/assets/js-flavor-cjs.svg src/generators/legacy-html/assets/js-flavor-cjs.svg renamed to src/generators/legacy-html-assets/assets/js-flavor-cjs.svg

@@ -1,6 +1,6 @@
 'use strict';
 
-import { cp, readFile, rm, writeFile } from 'node:fs/promises';
+import { readFile, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 
 import HTMLMinifier from '@minify-html/node';
@@ -168,24 +168,6 @@ export default {
       }
     }
 
-    if (output) {
-      // Define the output folder for API docs assets
-      const assetsFolder = join(output, 'assets');
-
-      // Removes the current assets directory to copy the new assets
-      // and prevent stale assets from existing in the output directory
-      // If the path does not exists, it will simply ignore and continue
-      await rm(assetsFolder, { recursive: true, force: true, maxRetries: 10 });
-
-      // We copy all the other assets to the output folder at the end of the process
-      // to ensure that all latest changes on the styles are applied to the output
-      // Note.: This is not meant to be used for DX/developer purposes.
-      await cp(join(baseDir, 'assets'), assetsFolder, {
-        recursive: true,
-        force: true,
-      });
-    }
-
     return generatedValues;
   },
 };