refactor: some improvements

Author: araujogui

bin/cli.mjs

@@ -12,7 +12,7 @@ import generators from '../src/generators/index.mjs';
 import createMarkdownLoader from '../src/loaders/markdown.mjs';
 import createMarkdownParser from '../src/parsers/markdown.mjs';
 import createNodeReleases from '../src/releases.mjs';
-import { Linter } from '../src/linter/index.mjs';
+import createLinter from '../src/linter/index.mjs';
 import reporters from '../src/linter/reporters/index.mjs';
 
 const availableGenerators = Object.keys(generators);
@@ -52,7 +52,9 @@ program
       'Set the processing target modes'
     ).choices(availableGenerators)
   )
-  .addOption(new Option('--skip-linting', 'Skip linting').default(false))
+  .addOption(
+    new Option('--lint-dry-run', 'Run linter in dry-run mode').default(false)
+  )
   .addOption(
     new Option('-r, --reporter [reporter]', 'Specify the linter reporter')
       .choices(Object.keys(reporters))
@@ -68,9 +70,9 @@ program
  * @property {string} output Specifies the directory where output files will be saved.
  * @property {Target[]} target Specifies the generator target mode.
  * @property {string} version Specifies the target Node.js version.
- * @property {string} changelog Specifies the path to the Node.js CHANGELOG.md file
- * @property {boolean} skipLinting Specifies whether to skip linting
- * @property {keyof reporters} reporter Specifies the linter reporter
+ * @property {string} changelog Specifies the path to the Node.js CHANGELOG.md file.
+ * @property {boolean} lintDryRun Specifies whether the linter should run in dry-run mode.
+ * @property {keyof reporters} reporter Specifies the linter reporter.
  *
  * @name ProgramOptions
  * @type {Options}
@@ -82,11 +84,11 @@ const {
   target = [],
   version,
   changelog,
-  skipLinting,
+  lintDryRun,
   reporter,
 } = program.opts();
 
-const linter = skipLinting ? undefined : new Linter();
+const linter = createLinter(lintDryRun);
 
 const { loadFiles } = createMarkdownLoader();
 const { parseApiDocs } = createMarkdownParser();
@@ -100,7 +102,7 @@ const { runGenerators } = createGenerator(parsedApiDocs);
 // Retrieves Node.js release metadata from a given Node.js version and CHANGELOG.md file
 const { getAllMajors } = createNodeReleases(changelog);
 
-linter?.lintAll(parsedApiDocs);
+linter.lintAll(parsedApiDocs);
 
 await runGenerators({
   // A list of target modes for the API docs parser
@@ -115,10 +117,8 @@ await runGenerators({
   releases: await getAllMajors(),
 });
 
-if (linter) {
-  linter.report(reporter);
+linter.report(reporter);
 
-  if (linter.hasError) {
-    exit(1);
-  }
+if (linter.hasError()) {
+  exit(1);
 }

src/generators/types.d.ts

@@ -1,7 +1,6 @@
 import type { SemVer } from 'semver';
 import type availableGenerators from './index.mjs';
 import type { ApiDocReleaseEntry } from '../types';
-import type { Linter } from '../linter/index.mjs';
 
 declare global {
   // All available generators as an inferable type, to allow Generator interfaces
@@ -31,8 +30,6 @@ declare global {
 
     // A list of all Node.js major versions and their respective release information
     releases: Array<ApiDocReleaseEntry>;
-
-    linter: Linter | undefined;
   }
 
   export interface GeneratorMetadata<I extends any, O extends any> {

src/linter/index.mjs

@@ -7,59 +7,77 @@ import { missingIntroducedIn } from './rules/missing-introduced-in.mjs';
 
 /**
  * Lint issues in ApiDocMetadataEntry entries
+ *
+ * @param {boolean} dryRun Whether to run the linter in dry-run mode
  */
-export class Linter {
+const createLinter = dryRun => {
   /**
    * @type {Array<import('./types.d.ts').LintIssue>}
    */
-  #issues = [];
+  const issues = [];
 
   /**
    * @type {Array<import('./types.d.ts').LintRule>}
    */
-  #rules = [missingIntroducedIn, missingChangeVersion, invalidChangeVersion];
+  const rules = [
+    missingIntroducedIn,
+    missingChangeVersion,
+    invalidChangeVersion,
+  ];
 
   /**
    * @param {ApiDocMetadataEntry} entry
    * @returns {void}
    */
-  lint(entry) {
-    for (const rule of this.#rules) {
-      const issues = rule(entry);
+  const lint = entry => {
+    for (const rule of rules) {
+      const ruleIssues = rule(entry);
 
-      if (issues.length > 0) {
-        this.#issues.push(...issues);
+      if (ruleIssues.length > 0) {
+        issues.push(...ruleIssues);
       }
     }
-  }
+  };
 
   /**
    * @param {ApiDocMetadataEntry[]} entries
    * @returns {void}
    */
-  lintAll(entries) {
+  const lintAll = entries => {
     for (const entry of entries) {
-      this.lint(entry);
+      lint(entry);
     }
-  }
+  };
 
   /**
    * @param {keyof reporters} reporterName
    */
-  report(reporterName) {
+  const report = reporterName => {
+    if (dryRun) {
+      return;
+    }
+
     const reporter = reporters[reporterName];
 
-    for (const issue of this.#issues) {
+    for (const issue of issues) {
       reporter(issue);
     }
-  }
+  };
 
   /**
    * Returns whether there are any issues with a level of 'error'
    *
    * @returns {boolean}
    */
-  get hasError() {
-    return this.#issues.some(issue => issue.level === 'error');
-  }
-}
+  const hasError = () => {
+    return issues.some(issue => issue.level === 'error');
+  };
+
+  return {
+    lintAll,
+    report,
+    hasError,
+  };
+};
+
+export default createLinter;