chore(lint): missing-metadata

eslint.config.mjs

@@ -65,7 +65,7 @@ export default [
   },
   // Override rules for test files to disable JSDoc rules
   {
-    files: ['src/**/*.test.mjs'],
+    files: ['**/__tests__/**'],
     rules: {
       'jsdoc/check-alignment': 'off',
       'jsdoc/check-indentation': 'off',

src/linter/constants.mjs

@@ -1,6 +1,6 @@
 'use strict';
 
-export const INTRDOCUED_IN_REGEX = /<!--\s?introduced_in=.*-->/;
+export const INTRODUCED_IN_REGEX = /<!--\s?introduced_in=.*-->/;
 
 export const LLM_DESCRIPTION_REGEX = /<!--\s?llm_description=.*-->/;
 

src/linter/rules/__tests__/duplicate-stability-nodes.test.mjs

@@ -1,8 +1,9 @@
 import { deepStrictEqual, strictEqual } from 'node:assert';
-import { describe, it, mock } from 'node:test';
+import { describe, it } from 'node:test';
 
 import { LINT_MESSAGES } from '../../constants.mjs';
 import { duplicateStabilityNodes } from '../duplicate-stability-nodes.mjs';
+import { createContext } from './utils.mjs';
 
 // Mock data structure for creating test entries
 const createStabilityNode = (value, line = 1, column = 1) => ({
@@ -39,15 +40,6 @@ const createHeadingNode = (depth, line = 1, column = 1) => ({
   },
 });
 
-const createContext = (nodes, path = 'file.md') => ({
-  tree: {
-    type: 'root',
-    children: nodes,
-  },
-  path,
-  report: mock.fn(),
-});
-
 describe('duplicateStabilityNodes', () => {
   it('should not report when there are no stability nodes', () => {
     const context = createContext([

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

@@ -1,12 +1,13 @@
 import { deepStrictEqual, strictEqual } from 'node:assert';
 import { spawnSync } from 'node:child_process';
 import { execPath } from 'node:process';
-import { describe, it, mock } from 'node:test';
+import { describe, it } from 'node:test';
 import { fileURLToPath } from 'node:url';
 
 import dedent from 'dedent';
 
 import { invalidChangeVersion } from '../invalid-change-version.mjs';
+import { createContext } from './utils.mjs';
 
 describe('invalidChangeVersion', () => {
   it('should not report if all change versions are non-empty', () => {
@@ -20,19 +21,12 @@ changes:
   - version: v5.0.0
 -->`;
 
-    const context = {
-      tree: {
-        type: 'root',
-        children: [
-          {
-            type: 'html',
-            value: yamlContent,
-          },
-        ],
+    const context = createContext([
+      {
+        type: 'html',
+        value: yamlContent,
       },
-      report: mock.fn(),
-      getIssues: mock.fn(),
-    };
+    ]);
 
     invalidChangeVersion(context);
 
@@ -50,23 +44,16 @@ changes:
   - version:
 -->`;
 
-    const context = {
-      tree: {
-        type: 'root',
-        children: [
-          {
-            type: 'html',
-            value: yamlContent,
-            position: {
-              start: { line: 1, column: 1, offset: 1 },
-              end: { line: 1, column: 1, offset: 1 },
-            },
-          },
-        ],
+    const context = createContext([
+      {
+        type: 'html',
+        value: yamlContent,
+        position: {
+          start: { line: 1, column: 1, offset: 1 },
+          end: { line: 1, column: 1, offset: 1 },
+        },
       },
-      report: mock.fn(),
-      getIssues: mock.fn(),
-    };
+    ]);
 
     invalidChangeVersion(context);
 
@@ -126,19 +113,12 @@ changes:
   - version: v5.0.0
 -->`;
 
-    const context = {
-      tree: {
-        type: 'root',
-        children: [
-          {
-            type: 'html',
-            value: yamlContent,
-          },
-        ],
+    const context = createContext([
+      {
+        type: 'html',
+        value: yamlContent,
       },
-      report: mock.fn(),
-      getIssues: mock.fn(),
-    };
+    ]);
 
     invalidChangeVersion(context);
 
@@ -156,23 +136,16 @@ changes:
   - version: v5.0.0
 -->`;
 
-    const context = {
-      tree: {
-        type: 'root',
-        children: [
-          {
-            type: 'html',
-            value: yamlContent,
-            position: {
-              start: { column: 1, line: 7, offset: 103 },
-              end: { column: 35, line: 7, offset: 137 },
-            },
-          },
-        ],
+    const context = createContext([
+      {
+        type: 'html',
+        value: yamlContent,
+        position: {
+          start: { column: 1, line: 7, offset: 103 },
+          end: { column: 35, line: 7, offset: 137 },
+        },
       },
-      report: mock.fn(),
-      getIssues: mock.fn(),
-    };
+    ]);
 
     invalidChangeVersion(context);
     strictEqual(context.report.mock.callCount(), 1);
@@ -200,23 +173,16 @@ changes:
   - version: v5.0.0
 -->`;
 
-    const context = {
-      tree: {
-        type: 'root',
-        children: [
-          {
-            type: 'html',
-            value: yamlContent,
-            position: {
-              start: { column: 1, line: 7, offset: 103 },
-              end: { column: 35, line: 7, offset: 137 },
-            },
-          },
-        ],
+    const context = createContext([
+      {
+        type: 'html',
+        value: yamlContent,
+        position: {
+          start: { column: 1, line: 7, offset: 103 },
+          end: { column: 35, line: 7, offset: 137 },
+        },
       },
-      report: mock.fn(),
-      getIssues: mock.fn(),
-    };
+    ]);
 
     invalidChangeVersion(context);
     strictEqual(context.report.mock.callCount(), 1);

src/linter/rules/__tests__/missing-metadata.test.mjs

@@ -0,0 +1,54 @@
+import { strictEqual } from 'node:assert';
+import { describe, it } from 'node:test';
+
+import { createContext } from './utils.mjs';
+import { missingMetadata } from '../../rules/missing-metadata.mjs';
+
+describe('missingMetadata', () => {
+  it('should not report when both fields are present', () => {
+    const context = createContext([
+      { type: 'html', value: '<!--introduced_in=12.0.0-->' },
+      { type: 'html', value: '<!--llm_description=desc-->' },
+    ]);
+
+    missingMetadata(context);
+    strictEqual(context.report.mock.callCount(), 0);
+  });
+
+  it('should report only llm_description when introduced_in is present', () => {
+    const context = createContext([
+      { type: 'html', value: '<!--introduced_in=12.0.0-->' },
+    ]);
+
+    missingMetadata(context);
+    strictEqual(context.report.mock.callCount(), 1);
+    strictEqual(context.report.mock.calls[0].arguments[0].level, 'warn');
+  });
+
+  it('should not report llm_description when paragraph fallback exists', () => {
+    const context = createContext([
+      { type: 'html', value: '<!--introduced_in=12.0.0-->' },
+      { type: 'paragraph', children: [{ type: 'text', value: 'desc' }] },
+    ]);
+
+    missingMetadata(context);
+    strictEqual(context.report.mock.callCount(), 0);
+  });
+
+  it('should report both when nothing is present', () => {
+    const context = createContext([{ type: 'heading', depth: 1 }]);
+
+    missingMetadata(context);
+    strictEqual(context.report.mock.callCount(), 2);
+  });
+
+  it('should report only introduced_in when llm_description is present', () => {
+    const context = createContext([
+      { type: 'html', value: '<!--llm_description=desc-->' },
+    ]);
+
+    missingMetadata(context);
+    strictEqual(context.report.mock.callCount(), 1);
+    strictEqual(context.report.mock.calls[0].arguments[0].level, 'info');
+  });
+});

src/linter/rules/__tests__/utils.mjs

@@ -0,0 +1,7 @@
+import { mock } from 'node:test';
+
+export const createContext = children => ({
+  tree: { type: 'root', children },
+  report: mock.fn(),
+  getIssues: mock.fn(),
+});

src/linter/rules/index.mjs

@@ -2,15 +2,13 @@
 
 import { duplicateStabilityNodes } from './duplicate-stability-nodes.mjs';
 import { invalidChangeVersion } from './invalid-change-version.mjs';
-import { missingIntroducedIn } from './missing-introduced-in.mjs';
-import { missingLlmDescription } from './missing-llm-description.mjs';
+import { missingMetadata } from './missing-metadata.mjs';
 
 /**
  * @type {Record<string, import('../types').LintRule>}
  */
 export default {
   'duplicate-stability-nodes': duplicateStabilityNodes,
   'invalid-change-version': invalidChangeVersion,
-  'missing-introduced-in': missingIntroducedIn,
-  'missing-llm-description': missingLlmDescription,
+  'missing-metadata': missingMetadata,
 };