Add optionalDependencies option to --dep-type (#606)

Author: bmish

README.md

@@ -116,7 +116,7 @@ These options are available on the CLI and as parameters to the [Node API](#node
 
 | Name | Description |
 | :-- | :-- |
-| `--dep-type` | Type of dependency to check (`dependencies`, `devDependencies`, `peerDependencies` (optional), `resolutions`) (default: `dependencies`, `devDependencies`, `resolutions`) (option can be repeated). |
+| `--dep-type` | Type of dependency to check (`dependencies`, `devDependencies`, `optionalDependencies` (optional), `peerDependencies` (optional), `resolutions`) (default: `dependencies`, `devDependencies`, `resolutions`) (option can be repeated). |
 | `--fix` | Whether to autofix inconsistencies (using latest version present). |
 | `--ignore-dep` | Dependency to ignore mismatches for (option can be repeated). |
 | `--ignore-dep-pattern` | RegExp of dependency names to ignore mismatches for (option can be repeated). |

lib/dependency-versions.ts

@@ -59,6 +59,7 @@ export function calculateVersionsForEachDependency(
   return dependenciesToVersionsSeen;
 }
 
+// eslint-disable-next-line complexity
 function recordDependencyVersionsForPackageJson(
   dependenciesToVersionsSeen: DependenciesToVersionsSeen,
   package_: Package,
@@ -110,6 +111,24 @@ function recordDependencyVersionsForPackageJson(
     }
   }
 
+  if (
+    depType.includes(DEPENDENCY_TYPE.optionalDependencies) &&
+    package_.packageJson.optionalDependencies
+  ) {
+    for (const [dependency, dependencyVersion] of Object.entries(
+      package_.packageJson.optionalDependencies
+    )) {
+      if (dependencyVersion) {
+        recordDependencyVersion(
+          dependenciesToVersionsSeen,
+          dependency,
+          dependencyVersion,
+          package_
+        );
+      }
+    }
+  }
+
   if (
     depType.includes(DEPENDENCY_TYPE.peerDependencies) &&
     package_.packageJson.peerDependencies
@@ -406,6 +425,27 @@ export function fixVersionsMismatching(
         isFixed = true;
       }
 
+      if (
+        package_.packageJson.optionalDependencies &&
+        package_.packageJson.optionalDependencies[
+          mismatchingVersion.dependency
+        ] &&
+        package_.packageJson.optionalDependencies[
+          mismatchingVersion.dependency
+        ] !== fixedVersion
+      ) {
+        if (!dryrun) {
+          writeDependencyVersion(
+            package_.pathPackageJson,
+            package_.packageJsonEndsInNewline,
+            DEPENDENCY_TYPE.optionalDependencies,
+            mismatchingVersion.dependency,
+            fixedVersion
+          );
+        }
+        isFixed = true;
+      }
+
       if (
         package_.packageJson.peerDependencies &&
         package_.packageJson.peerDependencies[mismatchingVersion.dependency] &&

lib/types.ts

@@ -16,9 +16,9 @@ export type Dependencies = Record<
 export enum DEPENDENCY_TYPE {
   'dependencies' = 'dependencies',
   'devDependencies' = 'devDependencies',
+  'optionalDependencies' = 'optionalDependencies',
   'peerDependencies' = 'peerDependencies',
   'resolutions' = 'resolutions',
-  // TODO: `optionalDependencies`
 }
 
 export type Options = {

test/fixtures/index.ts

@@ -82,6 +82,10 @@ export const FIXTURE_PATH_PEER_DEPENDENCIES = join(
   FIXTURE_PATH,
   'peer-dependencies'
 );
+export const FIXTURE_PATH_OPTIONAL_DEPENDENCIES = join(
+  FIXTURE_PATH,
+  'optional-dependencies'
+);
 
 export const FIXTURE_PATH_ALL_VERSION_TYPES = join(
   FIXTURE_PATH,

test/fixtures/optional-dependencies/package.json

@@ -0,0 +1,12 @@
+{
+    "workspaces": [
+        "*"
+    ],
+    "devDependencies": {
+        "foo": "^1.2.0"
+    },
+    "optionalDependencies": {
+        "foo": "^2.0.0",
+        "bar": "^1.0.0"
+    }
+}

test/fixtures/optional-dependencies/package1/package.json

@@ -0,0 +1,7 @@
+{
+    "name": "package1",
+    "dependencies": {
+      "foo": "1.3.0",
+      "bar": "^1.0.0"
+    }
+}

test/lib/cdvc-test.ts

@@ -1,5 +1,6 @@
 import {
   FIXTURE_PATH_INCONSISTENT_VERSIONS,
+  FIXTURE_PATH_OPTIONAL_DEPENDENCIES,
   FIXTURE_PATH_PEER_DEPENDENCIES,
   FIXTURE_PATH_RESOLUTIONS,
   FIXTURE_PATH_VALID,
@@ -253,6 +254,143 @@ describe('CDVC', function () {
       });
     });
 
+    describe('optional dependencies', function () {
+      it('behaves correctly', function () {
+        const cdvc = new CDVC(FIXTURE_PATH_OPTIONAL_DEPENDENCIES, {
+          depType: ['optionalDependencies'],
+        });
+        const dependencies = cdvc.getDependencies();
+
+        expect(cdvc.hasMismatchingDependencies).toBe(false);
+        expect(cdvc.hasMismatchingDependenciesFixable).toBe(false);
+        expect(cdvc.hasMismatchingDependenciesNotFixable).toBe(false);
+        expect(dependencies).toStrictEqual([
+          {
+            isFixable: false,
+            isMismatching: false,
+            name: 'bar',
+            versions: [
+              {
+                packages: [''],
+                version: '^1.0.0',
+              },
+            ],
+          },
+          {
+            isFixable: false,
+            isMismatching: false,
+            name: 'foo',
+            versions: [
+              {
+                packages: [''],
+                version: '^2.0.0',
+              },
+            ],
+          },
+        ]);
+      });
+
+      describe('mock fs', function () {
+        beforeEach(function () {
+          // Create a mock workspace filesystem for temporary usage in this test because changes will be written to some files.
+          mockFs({
+            'package.json': JSON.stringify({
+              workspaces: ['*'],
+              devDependencies: {
+                foo: '^1.2.0',
+              },
+              optionalDependencies: {
+                foo: '^1.0.0',
+                bar: '^1.0.0',
+              },
+            }),
+            package1: {
+              'package.json': JSON.stringify({
+                name: 'package1',
+                dependencies: {
+                  foo: '^2.0.0',
+                  bar: '^1.0.0',
+                },
+              }),
+            },
+          });
+        });
+
+        afterEach(function () {
+          mockFs.restore();
+        });
+
+        it('fixes the fixable inconsistencies', function () {
+          const cdvc = new CDVC('.', {
+            fix: true,
+            depType: [
+              DEPENDENCY_TYPE.optionalDependencies,
+              DEPENDENCY_TYPE.devDependencies,
+              DEPENDENCY_TYPE.dependencies,
+            ],
+          });
+
+          // Read in package.json files.
+          const packageJsonRootContents = readFileSync('package.json', 'utf8');
+          const packageJson1Contents = readFileSync(
+            'package1/package.json',
+            'utf8'
+          );
+          const packageJsonRoot = JSON.parse(
+            packageJsonRootContents
+          ) as PackageJson;
+          const packageJson1 = JSON.parse(packageJson1Contents) as PackageJson;
+
+          expect(
+            packageJsonRoot.devDependencies &&
+              packageJsonRoot.devDependencies['foo']
+          ).toStrictEqual('^2.0.0');
+
+          expect(
+            packageJsonRoot.optionalDependencies &&
+              packageJsonRoot.optionalDependencies['foo']
+          ).toStrictEqual('^2.0.0');
+
+          expect(
+            packageJson1.dependencies && packageJson1.dependencies['foo']
+          ).toStrictEqual('^2.0.0');
+
+          expect(cdvc.getDependencies()).toStrictEqual([
+            {
+              name: 'bar',
+              isFixable: false,
+              isMismatching: false,
+              versions: [
+                {
+                  version: '^1.0.0',
+                  packages: ['', 'package1'],
+                },
+              ],
+            },
+            {
+              name: 'foo',
+              isFixable: true,
+              isMismatching: true,
+              versions: [
+                {
+                  version: '^1.0.0',
+                  packages: [''],
+                },
+                {
+                  version: '^1.2.0',
+                  packages: [''],
+                },
+                {
+                  version: '^2.0.0',
+                  packages: ['package1'],
+                },
+              ],
+            },
+          ]);
+        });
+      });
+    });
+
     describe('peer dependencies', function () {
       it('behaves correctly', function () {
         const cdvc = new CDVC(FIXTURE_PATH_PEER_DEPENDENCIES, {
@@ -436,7 +574,7 @@ describe('CDVC', function () {
               depType: ['fake'],
             })
         ).toThrowErrorMatchingInlineSnapshot(
-          '"Invalid depType provided. Choices are: dependencies, devDependencies, peerDependencies, resolutions."'
+          '"Invalid depType provided. Choices are: dependencies, devDependencies, optionalDependencies, peerDependencies, resolutions."'
         );
       });
     });