feat: replace linter reporters to transports

Author: araujogui

README.md

@@ -79,12 +79,12 @@ Usage: @nodejs/doc-kit lint [options]
 Run linter independently
 
 Options:
-  -i, --input <patterns...>  Input file patterns (glob)
-  --ignore [patterns...]     Ignore patterns (comma-separated)
-  --disable-rule [rules...]  Disable linter rules (choices: "duplicate-stability-nodes", "invalid-change-version", "missing-introduced-in")
-  --dry-run                  Dry run mode (default: false)
-  -r, --reporter <reporter>  Linter reporter to use
-  -h, --help                 display help for command
+  -i, --input <patterns...>     Input file patterns (glob)
+  --ignore [patterns...]        Ignore patterns (comma-separated)
+  --disable-rule [rules...]     Disable linter rules (choices: "duplicate-stability-nodes", "invalid-change-version", "missing-introduced-in")
+  --dry-run                     Dry run mode (default: false)
+  -r, --transport <transport>   Logger transport to use
+  -h, --help                    display help for command
 ```
 
 ### `interactive`
@@ -106,7 +106,7 @@ Usage: @nodejs/doc-kit list [options] <types>
 List the given type
 
 Arguments:
-  types       The type to list (choices: "generators", "rules", "reporters")
+  types       The type to list (choices: "generators", "rules", "transports")
 
 Options:
   -h, --help  display help for command

bin/commands/lint.mjs

@@ -1,22 +1,21 @@
 import process from 'node:process';
 
 import createLinter from '../../src/linter/index.mjs';
-import reporters from '../../src/linter/reporters/index.mjs';
 import rules from '../../src/linter/rules/index.mjs';
 import { getEnabledRules } from '../../src/linter/utils/rules.mjs';
 import { Logger } from '../../src/logger/index.mjs';
+import { availableTransports } from '../../src/logger/transports/index.mjs';
 import { loadAndParse } from '../utils.mjs';
 
 const availableRules = Object.keys(rules);
-const availableReporters = Object.keys(reporters);
 
 /**
  * @typedef {Object} LinterOptions
  * @property {Array<string>|string} input - Glob/path for input files.
  * @property {Array<string>|string} [ignore] - Glob/path for ignoring files.
  * @property {string[]} [disableRule] - Linter rules to disable.
  * @property {boolean} [dryRun] - Dry-run mode.
- * @property {keyof reporters} reporter - Reporter for linter output.
+ * @property {keyof transports} transport - Transport for logger output.
  */
 
 /**
@@ -63,13 +62,13 @@ export default {
         initialValue: false,
       },
     },
-    reporter: {
-      flags: ['-r', '--reporter <reporter>'],
-      desc: 'Linter reporter to use',
+    transport: {
+      flags: ['-r', '--transport <transport>'],
+      desc: 'Linter transport to use',
       prompt: {
         type: 'select',
-        message: 'Choose a reporter',
-        options: availableReporters.map(r => ({ label: r, value: r })),
+        message: 'Choose a transport',
+        options: availableTransports.map(t => ({ label: t, value: t })),
       },
     },
   },
@@ -81,6 +80,8 @@ export default {
    */
   async action(opts) {
     try {
+      Logger.init(opts.transport);
+
       const rules = getEnabledRules(opts.disableRule);
       const linter = createLinter(rules, opts.dryRun);
 
@@ -91,6 +92,7 @@ export default {
       process.exitCode = +linter.hasError();
     } catch (error) {
       Logger.getInstance().error('Error running the linter:', error);
+
       process.exitCode = 1;
     }
   },

bin/commands/list.mjs

@@ -1,17 +1,16 @@
 import { publicGenerators } from '../../src/generators/index.mjs';
-import reporters from '../../src/linter/reporters/index.mjs';
 import rules from '../../src/linter/rules/index.mjs';
 import { Logger } from '../../src/logger/index.mjs';
+import { availableTransports } from '../../src/logger/transports/index.mjs';
 
 const availableRules = Object.keys(rules);
-const availableReporters = Object.keys(reporters);
 
-export const types = ['generators', 'rules', 'reporters'];
+export const types = ['generators', 'rules', 'transports'];
 
 /**
- * Lists available generators, rules, or reporters based on the given type.
+ * Lists available generators, rules, or transports based on the given type.
  *
- * @param {'generators' | 'rules' | 'reporters'} type - The type of items to list.
+ * @param {'generators' | 'rules' | 'transports'} type - The type of items to list.
  */
 export default function list(type) {
   const list =
@@ -22,7 +21,7 @@ export default function list(type) {
         )
       : type === 'rules'
         ? availableRules
-        : availableReporters;
+        : availableTransports;
 
   Logger.getInstance().info(list.join('\n'));
 }

src/linter/index.mjs

@@ -1,7 +1,7 @@
 'use strict';
 
 import createContext from './context.mjs';
-import reporters from './reporters/index.mjs';
+import { Logger } from '../logger/index.mjs';
 
 /**
  * Creates a linter instance to validate API documentation ASTs against a
@@ -37,23 +37,39 @@ const createLinter = (rules, dryRun = false) => {
   };
 
   /**
-   * Reports collected issues using the specified reporter.
+   * Reports collected issues using the default logger.
    *
-   * @param {keyof typeof reporters} [reporterName] Reporter name
    * @returns {void}
    */
-  const report = (reporterName = 'console') => {
+  const report = () => {
     if (dryRun) {
       return;
     }
 
-    const reporter = reporters[reporterName];
-
     for (const issue of issues) {
-      reporter(issue);
+      logIssue(issue);
     }
   };
 
+  /**
+   * Logs an issue using the default logger instance.
+   *
+   * @param {import('./types').LintIssue} issue
+   * @returns {void}
+   */
+  const logIssue = issue => {
+    const logger = Logger.getInstance();
+
+    const logFn = logger[issue.level];
+
+    logFn(issue.message, {
+      file: {
+        path: issue.location.path,
+        position: issue.location.position,
+      },
+    });
+  };
+
   /**
    * Checks if any error-level issues were collected.
    *

src/linter/reporters/__tests__/console.test.mjs

@@ -1,5 +1,4 @@
 import { Root } from 'mdast';
-import reporters from './reporters/index.mjs';
 import { VFile } from 'vfile';
 
 export type IssueLevel = 'info' | 'warn' | 'error';
@@ -22,12 +21,10 @@ export interface LintIssue {
 
 type LintRule = (context: LintContext) => void;
 
-export type Reporter = (message: LintIssue) => void;
-
 export interface Linter {
   readonly issues: LintIssue[];
   lint: (file: VFile, tree: Root) => void;
-  report: (reporterName: keyof typeof reporters) => void;
+  report: () => void;
   hasError: () => boolean;
 }