code review

Author: avivkeller

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

@@ -4,23 +4,38 @@ import { env } from 'node:process';
 
 const NODE_RELEASED_VERSIONS = env.NODE_RELEASED_VERSIONS?.split(',');
 
+/**
+ * Checks if the given version is "REPLACEME" and the array length is 1.
+ *
+ * @param {string} version - The version to check.
+ * @param {number} length - Length of the version array.
+ * @returns {boolean} True if conditions match, otherwise false.
+ */
+const isValidReplaceMe = (version, length) =>
+  length === 1 && version === 'REPLACEME';
+
 /**
  * Determines if a given version is invalid.
  *
  * @param {string} version - The version to check.
- * @returns {boolean} True if the version is invalid, false otherwise.
+ * @param {unknown} _ - Unused parameter.
+ * @param {{ length: number }} context - Array containing the length property.
+ * @returns {boolean} True if the version is invalid, otherwise false.
  */
 const isInvalid = NODE_RELEASED_VERSIONS
-  ? version =>
-      version !== 'REPLACEME' &&
-      !NODE_RELEASED_VERSIONS.includes(version.replace(/^v/, ''))
-  : version => version !== 'REPLACEME' && !valid(version);
+  ? (version, _, { length }) =>
+      !(
+        isValidReplaceMe(version, length) ||
+        NODE_RELEASED_VERSIONS.includes(version.replace(/^v/, ''))
+      )
+  : (version, _, { length }) =>
+      !(isValidReplaceMe(version, length) || valid(version));
 
 /**
- * Checks if any change version is invalid.
+ * Identifies invalid change versions from metadata entries.
  *
- * @param {ApiDocMetadataEntry[]} entries - The metadata entries to check.
- * @returns {Array<import('../types').LintIssue>} List of lint issues found.
+ * @param {ApiDocMetadataEntry[]} entries - Metadata entries to check.
+ * @returns {import('../types').LintIssue[]} List of detected lint issues.
  */
 export const invalidChangeVersion = entries =>
   entries.flatMap(({ changes, api_doc_source, yaml_position }) =>

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

@@ -65,4 +65,30 @@ describe('invalidChangeVersion', () => {
       },
     ]);
   });
+
+  it('should return an issue if a change version contains a REPLACEME and a version', () => {
+    const issues = invalidChangeVersion([
+      {
+        ...assertEntry,
+        changes: [
+          ...assertEntry.changes,
+          { version: ['v24.0.0', 'REPLACEME'] },
+        ],
+      },
+    ]);
+
+    deepEqual(issues, [
+      {
+        level: 'error',
+        location: {
+          path: 'doc/api/assert.md',
+          position: {
+            start: { column: 1, line: 7, offset: 103 },
+            end: { column: 35, line: 7, offset: 137 },
+          },
+        },
+        message: 'Invalid version number: REPLACEME',
+      },
+    ]);
+  });
 });