refactor: some improvements

Author: araujogui

bin/commands/generate.mjs

@@ -12,7 +12,7 @@ import { publicGenerators } from '../../src/generators/index.mjs';
 import createNodeReleases from '../../src/releases.mjs';
 import { loadAndParse } from '../utils.mjs';
 import createLinter from '../../src/linter/index.mjs';
-import rules from '../../src/linter/rules/index.mjs';
+import { getEnabledRules } from '../../src/linter/utils/rules.mjs';
 
 const availableGenerators = Object.keys(publicGenerators);
 
@@ -123,13 +123,14 @@ export default {
    * @returns {Promise<void>}
    */
   async action(opts) {
+    const rules = getEnabledRules(opts.disableRule);
     const linter = opts.skipLint ? undefined : createLinter(rules);
 
     const docs = await loadAndParse(opts.input, opts.ignore, linter);
 
-    linter.report();
+    linter?.report();
 
-    if (linter.hasError()) {
+    if (linter?.hasError()) {
       console.error('Lint failed; aborting generation.');
       process.exit(1);
     }

bin/commands/lint.mjs

@@ -87,7 +87,7 @@ export default {
 
       linter.report();
 
-      process.exitCode = linter.hasError() ? 1 : 0;
+      process.exitCode = +linter.hasError();
     } catch (error) {
       console.error('Error running the linter:', error);
       process.exitCode = 1;

src/generators/legacy-json/utils/buildSection.mjs

@@ -3,14 +3,7 @@ import { getRemarkRehype } from '../../../utils/remark.mjs';
 import { transformNodesToString } from '../../../utils/unist.mjs';
 import { parseList } from './parseList.mjs';
 import { SECTION_TYPE_PLURALS, UNPROMOTED_KEYS } from '../constants.mjs';
-
-/**
- * Converts a value to an array.
- * @template T
- * @param {T | T[]} val - The value to convert.
- * @returns {T[]} The value as an array.
- */
-const enforceArray = val => (Array.isArray(val) ? val : [val]);
+import { enforceArray } from '../../../utils/array.mjs';
 
 /**
  *

src/linter/constants.mjs

@@ -1,5 +1,9 @@
 'use strict';
 
+export const INTRDOCUED_IN_REGEX = /<!--\s?introduced_in=.*-->/;
+
+export const LLM_DESCRIPTION_REGEX = /<!--\s?llm_description=.*-->/;
+
 export const LINT_MESSAGES = {
   missingIntroducedIn: "Missing 'introduced_in' field in the API doc entry",
   missingChangeVersion: 'Missing version field in the API doc entry',

src/linter/context.mjs

@@ -27,12 +27,9 @@ const createContext = (file, tree) => {
      */
     const location = {
       path: file.path,
+      position,
     };
 
-    if (position) {
-      location.position = position;
-    }
-
     issues.push({
       level,
       message,

src/linter/rules/invalid-change-version.mjs

@@ -9,6 +9,7 @@ import {
   normalizeYamlSyntax,
 } from '../../utils/parser/index.mjs';
 import { LINT_MESSAGES } from '../constants.mjs';
+import { enforceArray } from '../../utils/array.mjs';
 
 const NODE_RELEASED_VERSIONS = env.NODE_RELEASED_VERSIONS?.split(',');
 
@@ -55,13 +56,6 @@ const isInvalid = NODE_RELEASED_VERSIONS
   : (version, _, { length }) =>
       !(isValidReplaceMe(version, length) || valid(version));
 
-/**
- *
- * @param version
- */
-const normalizeVersion = version =>
-  Array.isArray(version) ? version : [version];
-
 /**
  * Identifies invalid change versions from metadata entries.
  *
@@ -85,7 +79,7 @@ export const invalidChangeVersion = context => {
     }
 
     changes.forEach(({ version }) =>
-      normalizeVersion(version)
+      enforceArray(version)
         .filter(isInvalid)
         .forEach(version =>
           context.report({

src/linter/rules/missing-introduced-in.mjs

@@ -1,10 +1,8 @@
 'use strict';
 
-import { LINT_MESSAGES } from '../constants.mjs';
+import { INTRDOCUED_IN_REGEX, LINT_MESSAGES } from '../constants.mjs';
 import { findTopLevelEntry } from '../utils/find.mjs';
 
-const regex = /<!--\s?introduced_in=.*-->/;
-
 /**
  * Checks if `introduced_in` field is missing in the top-level entry.
  *
@@ -14,7 +12,7 @@ const regex = /<!--\s?introduced_in=.*-->/;
 export const missingIntroducedIn = context => {
   const introducedIn = findTopLevelEntry(
     context.tree,
-    node => node.type === 'html' && regex.test(node.value)
+    node => node.type === 'html' && INTRDOCUED_IN_REGEX.test(node.value)
   );
 
   if (introducedIn) {

src/linter/rules/missing-llm-description.mjs

@@ -1,8 +1,6 @@
-import { LINT_MESSAGES } from '../constants.mjs';
+import { LINT_MESSAGES, LLM_DESCRIPTION_REGEX } from '../constants.mjs';
 import { findTopLevelEntry } from '../utils/find.mjs';
 
-const regex = /<!--llm_description=.*-->/;
-
 /**
  * Checks if a top-level entry is missing a llm_description field or a paragraph
  * node.
@@ -13,7 +11,7 @@ const regex = /<!--llm_description=.*-->/;
 export const missingLlmDescription = context => {
   const llmDescription = findTopLevelEntry(
     context.tree,
-    node => node.type === 'html' && regex.test(node.value)
+    node => node.type === 'html' && LLM_DESCRIPTION_REGEX.test(node.value)
   );
 
   if (llmDescription) {
@@ -28,7 +26,7 @@ export const missingLlmDescription = context => {
   );
 
   if (paragraph) {
-    return false;
+    return;
   }
 
   context.report({

src/utils/array.mjs

@@ -0,0 +1,7 @@
+/**
+ * Converts a value to an array.
+ * @template T
+ * @param {T | T[]} val - The value to convert.
+ * @returns {T[]} The value as an array.
+ */
+export const enforceArray = val => (Array.isArray(val) ? val : [val]);