Ignore package.json comments (#534)

Author: bmish

lib/dependency-versions.ts

@@ -212,6 +212,9 @@ function versionsObjectsWithSortedPackages(
   });
 }
 
+const HARDCODED_IGNORED_DEPENDENCIES = new Set([
+  '//', // May be used to add comments to package.json files.
+]);
 export function filterOutIgnoredDependencies(
   mismatchingVersions: MismatchingDependencyVersions,
   ignoredDependencies: string[],
@@ -242,13 +245,20 @@ export function filterOutIgnoredDependencies(
     }
   }
 
-  if (ignoredDependencies.length > 0 || ignoredDependencyPatterns.length > 0) {
+  if (
+    ignoredDependencies.length > 0 ||
+    ignoredDependencyPatterns.length > 0 ||
+    mismatchingVersions.some((mismatchingVersion) =>
+      HARDCODED_IGNORED_DEPENDENCIES.has(mismatchingVersion.dependency)
+    )
+  ) {
     return mismatchingVersions.filter(
       (mismatchingVersion) =>
         !ignoredDependencies.includes(mismatchingVersion.dependency) &&
         !ignoredDependencyPatterns.some((ignoreDependencyPattern) =>
           mismatchingVersion.dependency.match(ignoreDependencyPattern)
-        )
+        ) &&
+        !HARDCODED_IGNORED_DEPENDENCIES.has(mismatchingVersion.dependency)
     );
   }
 

test/fixtures/index.ts

@@ -48,6 +48,10 @@ export const FIXTURE_PATH_INCREASABLE_RANGE = join(
   FIXTURE_PATH,
   'increasable-range'
 );
+export const FIXTURE_PATH_VALID_WITH_COMMENTS = join(
+  FIXTURE_PATH,
+  'valid-with-comments'
+);
 export const FIXTURE_PATH_VALID_WITH_PACKAGES = join(
   FIXTURE_PATH,
   'valid-with-packages'

test/fixtures/valid-with-comments/package.json

@@ -0,0 +1,9 @@
+{
+    "workspaces": ["*"],
+    "devDependencies": {
+        "//": "comment about bar",
+        "bar": "^2.0.0",
+        "//": "comment about baz",
+        "baz": "^3.0.0"
+    }
+}

test/fixtures/valid-with-comments/package1/package.json

@@ -0,0 +1,7 @@
+{
+    "name": "package1",
+    "dependencies": {
+        "//": "comment about foo",
+        "foo": "^1.2.3"
+    }
+}

test/lib/dependency-versions-test.ts

@@ -14,6 +14,7 @@ import {
   FIXTURE_PATH_INCONSISTENT_LOCAL_PACKAGE_VERSION,
   FIXTURE_PATH_RESOLUTIONS,
   FIXTURE_PATH_ALL_VERSION_TYPES,
+  FIXTURE_PATH_VALID_WITH_COMMENTS,
   FIXTURE_PATH_VALID_WITH_WORKSPACE_PREFIX,
   FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX,
 } from '../fixtures/index.js';
@@ -361,6 +362,17 @@ describe('Utils | dependency-versions', function () {
       ).toStrictEqual([]);
     });
 
+    it('filters out comments', function () {
+      const dependencyVersions = calculateMismatchingVersions(
+        calculateVersionsForEachDependency(
+          getPackagesHelper(FIXTURE_PATH_VALID_WITH_COMMENTS)
+        )
+      );
+      expect(
+        filterOutIgnoredDependencies(dependencyVersions, [], [])
+      ).toStrictEqual([]);
+    });
+
     it('throws when unnecessarily ignoring a dependency that has no mismatches', function () {
       const dependencyVersions = calculateMismatchingVersions(
         calculateVersionsForEachDependency(