Add debug logs

Author: avivkeller

src/linter/engine.mjs

@@ -6,23 +6,29 @@
  * @param {import('./types').LintRule} rules Lint rules to validate the entries against
  */
 const createLinterEngine = rules => {
+  console.log('Initializing linter engine with rules:', rules);
+
   /**
    * Validates a ApiDocMetadataEntry entry against all defined rules
    *
    * @param {ApiDocMetadataEntry} entry
    * @returns {import('./types').LintIssue[]}
    */
   const lint = entry => {
+    console.log('Linting entry:', entry);
     const issues = [];
 
     for (const rule of rules) {
+      console.log('Applying rule:', rule);
       const ruleIssues = rule(entry);
+      console.log('Issues found by rule:', ruleIssues);
 
       if (ruleIssues.length > 0) {
         issues.push(...ruleIssues);
       }
     }
 
+    console.log('Final issues for entry:', issues);
     return issues;
   };
 
@@ -33,12 +39,15 @@ const createLinterEngine = rules => {
    * @returns {import('./types').LintIssue[]}
    */
   const lintAll = entries => {
+    console.log('Linting all entries:', entries);
     const issues = [];
 
     for (const entry of entries) {
+      console.log('Linting individual entry:', entry);
       issues.push(...lint(entry));
     }
 
+    console.log('Final issues for all entries:', issues);
     return issues;
   };
 

src/linter/index.mjs

@@ -11,18 +11,31 @@ import rules from './rules/index.mjs';
  * @param {string[]} disabledRules List of disabled rules names
  */
 const createLinter = (dryRun, disabledRules) => {
+  console.log(
+    'Initializing linter with dryRun:',
+    dryRun,
+    'and disabledRules:',
+    disabledRules
+  );
+
   /**
    * Retrieves all enabled rules
    *
    * @returns {import('./types').LintRule[]}
    */
   const getEnabledRules = () => {
+    console.log('Filtering enabled rules from:', rules);
     return Object.entries(rules)
-      .filter(([ruleName]) => !disabledRules.includes(ruleName))
+      .filter(([ruleName]) => {
+        const isEnabled = !disabledRules.includes(ruleName);
+        console.log(`Rule: ${ruleName}, Enabled: ${isEnabled}`);
+        return isEnabled;
+      })
       .map(([, rule]) => rule);
   };
 
   const engine = createLinterEngine(getEnabledRules(disabledRules));
+  console.log('Linter engine created:', engine);
 
   /**
    * Lint issues found during validations
@@ -37,7 +50,10 @@ const createLinter = (dryRun, disabledRules) => {
    * @param entries
    */
   const lintAll = entries => {
-    issues.push(...engine.lintAll(entries));
+    console.log('Linting all entries:', entries);
+    const foundIssues = engine.lintAll(entries);
+    console.log('Issues found:', foundIssues);
+    issues.push(...foundIssues);
   };
 
   /**
@@ -47,13 +63,17 @@ const createLinter = (dryRun, disabledRules) => {
    * @returns {void}
    */
   const report = reporterName => {
+    console.log('Reporting issues with reporter:', reporterName);
     if (dryRun) {
+      console.log('Dry run enabled, skipping reporting.');
       return;
     }
 
     const reporter = reporters[reporterName];
+    console.log('Using reporter:', reporter);
 
     for (const issue of issues) {
+      console.log('Reporting issue:', issue);
       reporter(issue);
     }
   };
@@ -64,7 +84,9 @@ const createLinter = (dryRun, disabledRules) => {
    * @returns {boolean}
    */
   const hasError = () => {
-    return issues.some(issue => issue.level === 'error');
+    const hasError = issues.some(issue => issue.level === 'error');
+    console.log('Checking for errors, found:', hasError);
+    return hasError;
   };
 
   return {

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

@@ -8,26 +8,51 @@ import { valid } from 'semver';
  * @returns {Array<import('../types').LintIssue>}
  */
 export const invalidChangeVersion = entry => {
+  console.log('Received entry:', entry);
+
   if (entry.changes.length === 0) {
+    console.log('No changes found, returning empty array.');
     return [];
   }
 
+  console.log('Processing changes:', entry.changes);
+
   const allVersions = entry.changes
-    .filter(change => change.version)
-    .flatMap(change =>
-      Array.isArray(change.version) ? change.version : [change.version]
-    );
-
-  const invalidVersions = allVersions.filter(
-    version => valid(version) === null
-  );
-
-  return invalidVersions.map(version => ({
-    level: 'warn',
-    message: LINT_MESSAGES.invalidChangeVersion.replace('{{version}}', version),
-    location: {
-      path: entry.api_doc_source,
-      position: entry.yaml_position,
-    },
-  }));
+    .filter(change => {
+      console.log('Checking change:', change);
+      return change.version;
+    })
+    .flatMap(change => {
+      console.log('Extracting version from change:', change);
+      return Array.isArray(change.version) ? change.version : [change.version];
+    });
+
+  console.log('All extracted versions:', allVersions);
+
+  const invalidVersions = allVersions.filter(version => {
+    const isValid = valid(version);
+    console.log(`Checking version: ${version}, valid: ${isValid}`);
+    return isValid === null;
+  });
+
+  console.log('Invalid versions found:', invalidVersions);
+
+  const issues = invalidVersions.map(version => {
+    const issue = {
+      level: 'warn',
+      message: LINT_MESSAGES.invalidChangeVersion.replace(
+        '{{version}}',
+        version
+      ),
+      location: {
+        path: entry.api_doc_source,
+        position: entry.yaml_position,
+      },
+    };
+    console.log('Generated issue:', issue);
+    return issue;
+  });
+
+  console.log('Final issues array:', issues);
+  return issues;
 };