feat: introduced CLI mode to the parser (#36)

* feat: introduced CLI mode to the parser

* fix: top level await

* chore: remove .gitkeep

* refactor: uses loaders, parsers, and generators

* refactor: multiple target mode

* refactor: import order changed

* chore: package name added

* refactor: code review

Author: canerakdas

bin/.gitkeep

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+
+import { argv } from 'node:process';
+import { resolve } from 'node:path';
+
+import { Command, Option } from 'commander';
+
+import createGenerator from '../src/generators.mjs';
+import createLoader from '../src/loader.mjs';
+import createParser from '../src/parser.mjs';
+import generators from '../src/generators/index.mjs';
+
+const program = new Command();
+
+program
+  .name('api-docs-tooling')
+  .description('CLI tool to generate API documentation of a Node.js project.')
+  .requiredOption(
+    '-i, --input <patterns...>',
+    'Specify input file patterns using glob syntax'
+  )
+  .requiredOption('-o, --output <path>', 'Specify the output directory path')
+  .addOption(
+    new Option(
+      '-t, --target [mode...]',
+      'Set the processing target mode'
+    ).choices(Object.keys(generators))
+  )
+  .parse(argv);
+
+/**
+ * @typedef {keyof generators} Target A list of the available generator names.
+ *
+ * @typedef {Object} Options
+ * @property {Array<string>|string} input Specifies the glob/path for input files.
+ * @property {string} output Specifies the directory where output files will be saved.
+ * @property {Target} target Specifies the generator target mode.
+ *
+ * @name ProgramOptions
+ * @type {Options}
+ * @description The return type for values sent to the program from the CLI.
+ */
+const { input, output, target } = program.opts();
+
+const { loadFiles } = createLoader();
+const { parseApiDocs } = createParser();
+
+const apiDocFiles = loadFiles(input);
+
+const parsedApiDocs = await parseApiDocs(apiDocFiles);
+
+const { runGenerators } = createGenerator(parsedApiDocs);
+
+await runGenerators({
+  generators: target,
+  output: resolve(output),
+});

bin/cli.mjs

@@ -1,9 +1,13 @@
 {
+  "name": "@node-core/api-docs-tooling",
   "scripts": {
     "lint": "eslint .",
     "format": "prettier --write .",
     "prepare": "husky"
   },
+  "bin": {
+    "api-docs-tooling": "./bin/cli.mjs"
+  },
   "devDependencies": {
     "@eslint/js": "^9.8.0",
     "@types/node": "^20.14.11",
@@ -16,6 +20,7 @@
   },
   "dependencies": {
     "github-slugger": "^2.0.0",
+    "commander": "^12.1.0",
     "glob": "^11.0.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",

package-lock.json

@@ -3,4 +3,4 @@
 import jsonSimple from './json-simple/index.mjs';
 import legacyHtml from './legacy-html/index.mjs';
 
-export default { jsonSimple, legacyHtml };
+export default { 'json-simple': jsonSimple, 'legacy-html': legacyHtml };

package.json

@@ -15,7 +15,7 @@ import { join } from 'node:path';
  * @type {import('../types.d.ts').GeneratorMetadata<Input, string>}
  */
 export default {
-  name: 'jsonSimple',
+  name: 'json-simple',
 
   version: '1.0.0',
 

src/generators/index.mjs

@@ -12,7 +12,7 @@
  * @type {import('../types.d.ts').GeneratorMetadata<Input, void>}
  */
 export default {
-  name: 'legacyHtml',
+  name: 'legacy-html',
 
   version: '1.0.0',