check-peer-dependencies 4.1.0 → 4.3.0

package/.idea/workspace.xml

@@ -22,10 +22,8 @@
     <select />
   </component>
   <component name="ChangeListManager">
-    <list default="true" id="ebeb713d-6dc4-42d1-a42e-54aad95d9c0a" name="Default Changelist" comment="chore: update all dependencies">
+    <list default="true" id="ebeb713d-6dc4-42d1-a42e-54aad95d9c0a" name="Default Changelist" comment="feat: detect yarn2 lockfile (and then use 'yarn up')&#10;&#10;Note: yarn2 pnp will likely never be supported">
       <change beforePath="$PROJECT_DIR$/src/checkPeerDependencies.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/checkPeerDependencies.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/cli.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/cli.ts" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/src/packageUtils.ts" beforeDir="false" afterPath="$PROJECT_DIR$/src/packageUtils.ts" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
     <option name="HIGHLIGHT_CONFLICTS" value="true" />
@@ -33,9 +31,22 @@
     <option name="LAST_RESOLUTION" value="IGNORE" />
   </component>
   <component name="Git.Settings">
+    <option name="RECENT_BRANCH_BY_REPOSITORY">
+      <map>
+        <entry key="$PROJECT_DIR$" value="yarn2-sorta-notreally" />
+      </map>
+    </option>
     <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
     <option name="UPDATE_TYPE" value="REBASE" />
   </component>
+  <component name="GitSEFilterConfiguration">
+    <file-type-list>
+      <filtered-out-file-type name="LOCAL_BRANCH" />
+      <filtered-out-file-type name="REMOTE_BRANCH" />
+      <filtered-out-file-type name="TAG" />
+      <filtered-out-file-type name="COMMIT_BY_MESSAGE" />
+    </file-type-list>
+  </component>
   <component name="GitToolBoxStore">
     <option name="projectConfigVersion" value="2" />
     <option name="recentBranches">
@@ -58,6 +69,12 @@
       </RecentBranches>
     </option>
   </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectColorInfo"><![CDATA[{
+  "associatedIndex": 6
+}]]></component>
   <component name="ProjectId" id="1SkfJRmHXPtjMGY19cBVwFevkIM" />
   <component name="ProjectLevelVcsManager">
     <OptionsSetting value="false" id="Update" />
@@ -68,22 +85,17 @@
     <option name="hideEmptyMiddlePackages" value="true" />
     <option name="showLibraryContents" value="true" />
   </component>
-  <component name="PropertiesComponent">
-    <property name="SHARE_PROJECT_CONFIGURATION_FILES" value="true" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
-    <property name="node.js.detected.package.eslint" value="true" />
-    <property name="node.js.detected.package.tslint" value="true" />
-    <property name="node.js.path.for.package.eslint" value="project" />
-    <property name="node.js.path.for.package.tslint" value="project" />
-    <property name="node.js.selected.package.eslint" value="(autodetect)" />
-    <property name="node.js.selected.package.tslint" value="(autodetect)" />
-    <property name="nodejs_interpreter_path.stuck_in_default_project" value="undefined stuck path" />
-    <property name="nodejs_npm_path_reset_for_default_project" value="true" />
-    <property name="nodejs_package_manager_path" value="yarn" />
-    <property name="settings.editor.selected.configurable" value="preferences.pluginManager" />
-    <property name="ts.external.directory.path" value="$PROJECT_DIR$/node_modules/typescript/lib" />
-    <property name="vue.rearranger.settings.migration" value="true" />
-  </component>
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "git-widget-placeholder": "optional",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "yarn",
+    "ts.external.directory.path": "/Users/chris/projects/check-peer-dependencies/node_modules/typescript/lib"
+  }
+}]]></component>
   <component name="RecentsManager">
     <key name="es6.move.members.recent.items">
       <recent name="$PROJECT_DIR$/src/packageUtils.ts" />
@@ -306,13 +318,8 @@
         </entry>
       </map>
     </option>
-    <option name="oldMeFiltersMigrated" value="true" />
   </component>
   <component name="VcsManagerConfiguration">
-    <MESSAGE value="chore: add shelljs dependency" />
-    <MESSAGE value="chore: add yargs and shelljs dependency" />
-    <MESSAGE value="chore: add yargs and shelljs and semver dependencies" />
-    <MESSAGE value="refactor: extract cli.ts" />
     <MESSAGE value="fix(packageManager): remove console.log, switch to boolean parameters" />
     <MESSAGE value="fix(checkPeerDependencies): check for yalc'd packages using installedVersion, not dependerVersion" />
     <MESSAGE value="chore: Add README.md and CHANGELOG.md" />
@@ -334,6 +341,10 @@
     <MESSAGE value="feat(peerDependencyMeta): support peerDependencyMeta in package.json to ignore optional peer dependencies" />
     <MESSAGE value="feat(prerelease): include prerelease when  matching ranges, i.e. the range &quot;&gt;=6.0.0&quot; matches &quot;7.0.0-beta.1&quot;&#10;&#10;BREAKING CHANGE: Matches prerelease versions" />
     <MESSAGE value="chore: update all dependencies" />
-    <option name="LAST_COMMIT_MESSAGE" value="chore: update all dependencies" />
+    <MESSAGE value="feat: load checkPeerDependencies config from package.json (and merge with CLI options)" />
+    <MESSAGE value="feat: Add support for ignoring peer dependencies (via cli option or config stored in package.json)" />
+    <MESSAGE value="fix: Install peer deps as devDependencies if the peer dep came from a dev dependency&#10;fix: Properly install dev dependencies when using npm as the package manager" />
+    <MESSAGE value="feat: detect yarn2 lockfile (and then use 'yarn up')&#10;&#10;Note: yarn2 pnp will likely never be supported" />
+    <option name="LAST_COMMIT_MESSAGE" value="feat: detect yarn2 lockfile (and then use 'yarn up')&#10;&#10;Note: yarn2 pnp will likely never be supported" />
   </component>
 </project>

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 4.3.0 (2023-10-17)
+[Compare `check-peer-dependencies` versions 4.2.0 and 4.3.0](https://github.com/christopherthielen/check-peer-dependencies/compare/4.2.0...4.3.0)
+
+### Bug Fixes
+
+* non-satisfied optional dependency should fail ([7d43b0d](https://github.com/christopherthielen/check-peer-dependencies/commit/7d43b0d))
+
+
+
+
+# 4.2.0 (2023-03-13)
+[Compare `check-peer-dependencies` versions 4.1.0 and 4.2.0](https://github.com/christopherthielen/check-peer-dependencies/compare/4.1.0...4.2.0)
+
+### Bug Fixes
+
+* Install peer deps as devDependencies if the peer dep came from a dev dependency ([6ef3021](https://github.com/christopherthielen/check-peer-dependencies/commit/6ef3021)), closes [#21](https://github.com/christopherthielen/check-peer-dependencies/issues/21)
+* Method for determining the installed version fails [#27](https://github.com/christopherthielen/check-peer-dependencies/issues/27) ([8058585](https://github.com/christopherthielen/check-peer-dependencies/commit/8058585))
+
+
+
+
 # 4.1.0 (2021-11-28)
 [Compare `check-peer-dependencies` versions 4.0.0 and 4.1.0](https://github.com/christopherthielen/check-peer-dependencies/compare/4.0.0...4.1.0)
 

package/README.md

@@ -27,6 +27,8 @@ Options:
                                                       [boolean] [default: false]
       --verbose                    Prints every peer dependency, even those that
                                    are met            [boolean] [default: false]
+      --ignore                     package name to ignore (may specify multiple)
+                                                           [array] [default: []]
       --runOnlyOnRootDependencies  Run tool only on package root dependencies
                                                       [boolean] [default: false]
       --findSolutions              Search for solutions and print package

package/dist/checkPeerDependencies.js

@@ -33,7 +33,8 @@ function getAllNestedPeerDependencies(options) {
     return gatheredDependencies.map(applySemverInformation).map(applyIgnoreInformation);
 }
 var recursiveCount = 0;
-var isProblem = function (dep) { return !dep.semverSatisfies && !dep.isIgnored && !dep.isYalc && !dep.isPeerOptionalDependency; };
+var isProblem = function (dep) { return !dep.semverSatisfies && !dep.isIgnored && !dep.isYalc &&
+    (!dep.isPeerOptionalDependency || !!dep.installedVersion); };
 var reportPeerDependencyStatus = function (dep, byDepender, showSatisfiedDep, verbose) {
     var message = byDepender ?
         dep.depender.name + "@" + dep.depender.version + " requires " + dep.name + " " + dep.version :
@@ -46,18 +47,18 @@ var reportPeerDependencyStatus = function (dep, byDepender, showSatisfiedDep, ve
     else if (dep.isYalc) {
         console.log("  \u2611\uFE0F  " + message + " (" + dep.installedVersion + " is installed via yalc)");
     }
-    else if (dep.installedVersion && dep.isPeerOptionalDependency) {
-        if (verbose) {
-            console.log("  \u2611\uFE0F   " + message + ") OPTIONAL (" + dep.installedVersion + " is installed)");
-        }
-    }
     else if (dep.isIgnored) {
         if (verbose) {
             console.log("  \u2611\uFE0F   " + message + " IGNORED (" + dep.name + " is not installed)");
         }
     }
     else if (dep.installedVersion) {
-        console.log("  \u274C  " + message + ") (" + dep.installedVersion + " is installed)");
+        if (dep.isPeerOptionalDependency) {
+            console.log("  \u274C  " + message + ") OPTIONAL (" + dep.installedVersion + " is installed)");
+        }
+        else {
+            console.log("  \u274C  " + message + ") (" + dep.installedVersion + " is installed)");
+        }
     }
     else if (dep.isPeerOptionalDependency) {
         if (verbose) {

package/dist/packageManager.js

@@ -29,12 +29,12 @@ function getCommandLines(packageManager, resolutions) {
             commands.push("yarn upgrade " + upgrades.join(' '));
         }
     }
-    else if (packageManager === 'npm' && (installs.length || upgrades.length)) {
+    else if (packageManager === 'npm' && (installs.length || upgrades.length || devInstalls.length)) {
         if (installs.length || upgrades.length) {
             commands.push("npm install " + installs.concat(upgrades).join(' '));
         }
         if (devInstalls.length) {
-            commands.push("npm install -D " + installs.concat(upgrades).join(' '));
+            commands.push("npm install -D " + devInstalls);
         }
     }
     return commands;

package/dist/packageUtils.js

@@ -10,14 +10,14 @@ function gatherPeerDependencies(packagePath, options) {
     var visitor = function (path, json, deps) {
         peerDeps = peerDeps.concat(deps.peerDependencies);
     };
-    walkPackageDependencyTree(packagePath, visitor, [], options);
+    walkPackageDependencyTree(packagePath, false, visitor, [], options);
     // Eliminate duplicates
     return peerDeps.reduce(function (acc, dep) {
         return acc.some(function (dep2) { return isSameDep(dep, dep2); }) ? acc : acc.concat(dep);
     }, []);
 }
 exports.gatherPeerDependencies = gatherPeerDependencies;
-function walkPackageDependencyTree(packagePath, visitor, visitedPaths, options) {
+function walkPackageDependencyTree(packagePath, isAncestorDevDependency, visitor, visitedPaths, options) {
     var isRootPackage = visitedPaths.length === 0;
     if (visitedPaths.includes(packagePath)) {
         return;
@@ -28,13 +28,13 @@ function walkPackageDependencyTree(packagePath, visitor, visitedPaths, options)
         throw new Error("package.json missing at " + packageJsonPath + ".");
     }
     var packageJson = readJson_1.readJson(packageJsonPath);
-    var packageDependencies = getPackageMeta(packagePath, packageJson);
+    var packageDependencies = getPackageMeta(packagePath, packageJson, isAncestorDevDependency);
     if (options.debug) {
         console.log(packageJsonPath);
         packageDependencies.peerDependencies.forEach(function (dep) { return console.log(dep); });
     }
     visitor(packagePath, packageJson, packageDependencies);
-    function walkDependency(dependency) {
+    function walkDependency(dependency, isAncestorDevDependency) {
         if (resolve.isCore(dependency.name)) {
             return;
         }
@@ -51,15 +51,15 @@ function walkPackageDependencyTree(packagePath, visitor, visitedPaths, options)
                 throw new Error("WARN: Unable to resolve package " + dependency.name + " from " + packagePath);
             }
         }
-        walkPackageDependencyTree(dependencyPath, visitor, visitedPaths, options);
+        walkPackageDependencyTree(dependencyPath, isAncestorDevDependency, visitor, visitedPaths, options);
     }
     if (isRootPackage)
-        packageDependencies.devDependencies.forEach(walkDependency);
+        packageDependencies.devDependencies.forEach(function (dep) { return walkDependency(dep, true); });
     if (isRootPackage || !options.runOnlyOnRootDependencies)
-        packageDependencies.dependencies.forEach(walkDependency);
+        packageDependencies.dependencies.forEach(function (dep) { return walkDependency(dep, false); });
 }
 exports.walkPackageDependencyTree = walkPackageDependencyTree;
-function buildDependencyArray(type, pkgJson, depender) {
+function buildDependencyArray(type, pkgJson, depender, isAncestorDevDependency) {
     var dependenciesObject = pkgJson[type] || {};
     var peerDependenciesMeta = pkgJson.peerDependenciesMeta || {};
     // backwards compat
@@ -68,7 +68,7 @@ function buildDependencyArray(type, pkgJson, depender) {
     return packageNames.map(function (name) {
         var _a, _b;
         var isPeerOptionalDependency = !!((_a = peerDependenciesMeta[name]) === null || _a === void 0 ? void 0 : _a.optional);
-        var isPeerDevDependency = !!((_b = peerDependenciesMeta[name]) === null || _b === void 0 ? void 0 : _b.dev) || !!peerDevDependencies.includes(name);
+        var isPeerDevDependency = isAncestorDevDependency || !!((_b = peerDependenciesMeta[name]) === null || _b === void 0 ? void 0 : _b.dev) || !!peerDevDependencies.includes(name);
         return {
             name: name,
             type: type,
@@ -79,13 +79,13 @@ function buildDependencyArray(type, pkgJson, depender) {
         };
     });
 }
-function getPackageMeta(packagePath, packageJson) {
+function getPackageMeta(packagePath, packageJson, isAncestorDevDependency) {
     var name = packageJson.name, version = packageJson.version;
     var packageMeta = { name: name, version: version, packagePath: packagePath };
-    packageMeta.dependencies = buildDependencyArray("dependencies", packageJson, packageMeta);
-    packageMeta.devDependencies = buildDependencyArray("devDependencies", packageJson, packageMeta);
-    packageMeta.optionalDependencies = buildDependencyArray("optionalDependencies", packageJson, packageMeta);
-    packageMeta.peerDependencies = buildDependencyArray("peerDependencies", packageJson, packageMeta);
+    packageMeta.dependencies = buildDependencyArray("dependencies", packageJson, packageMeta, isAncestorDevDependency);
+    packageMeta.devDependencies = buildDependencyArray("devDependencies", packageJson, packageMeta, isAncestorDevDependency);
+    packageMeta.optionalDependencies = buildDependencyArray("optionalDependencies", packageJson, packageMeta, isAncestorDevDependency);
+    packageMeta.peerDependencies = buildDependencyArray("peerDependencies", packageJson, packageMeta, isAncestorDevDependency);
     return packageMeta;
 }
 exports.getPackageMeta = getPackageMeta;
@@ -94,7 +94,9 @@ function resolvePackageDir(basedir, packageName) {
     // In resolve() v2.x this callback has a different signature
     // function packageFilter(pkg, pkgfile, pkgdir) {
     function packageFilter(pkg, pkgdir) {
-        packagePath = pkgdir;
+        if (!packagePath || pkg.version) {
+            packagePath = pkgdir;
+        }
         return pkg;
     }
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "check-peer-dependencies",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "Checks peer dependencies of the current package.  Offers solutions for any that are unmet.",
   "main": "dist/check_peer_dependencies.js",
   "scripts": {

package/dist/check_peer_dependencies.js

@@ -1,77 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-exports.__esModule = true;
-var path = require("path");
-var semver = require("semver");
-var shelljs_1 = require("shelljs");
-var packageManager_1 = require("./packageManager");
-var packageUtils_1 = require("./packageUtils");
-var readJson_1 = require("./readJson");
-var solution_1 = require("./solution");
-function checkPeerDependencies(packageManager, installMissingPeerDependencies) {
-    var allNestedPeerDependencies = packageUtils_1.gatherPeerDependencies(".").map(function (dep) {
-        var installedVersion = getInstalledVersion(dep);
-        var semverSatisfies = installedVersion ? semver.satisfies(installedVersion, dep.version) : false;
-        return __assign(__assign({}, dep), { installedVersion: installedVersion, semverSatisfies: semverSatisfies });
-    }).sort(function (a, b) { return ("" + a.name + a.depender).localeCompare("" + b.name + b.depender); });
-    allNestedPeerDependencies.forEach(function (dep) {
-        if (dep.semverSatisfies) {
-            console.log("\u2705  " + dep.depender + " requires  " + dep.name + " " + dep.version + " and " + dep.installedVersion + " is installed");
-        }
-        else if (dep.installedVersion) {
-            console.log("\u274C  " + dep.depender + " requires " + dep.name + " " + dep.version + ", but " + dep.name + " is not installed");
-        }
-        else {
-            console.log("\u274C  " + dep.depender + " requires " + dep.name + " " + dep.version + ", but " + dep.installedVersion + " is installed");
-        }
-    });
-    var problems = allNestedPeerDependencies.filter(function (dep) { return !dep.semverSatisfies && !/file:\.yalc/.exec(dep.dependerVersion); });
-    if (!problems.length) {
-        console.log('No problems found!');
-        return;
-    }
-    console.log('Searching for solutions:');
-    var resolutions = solution_1.findPossibleResolutions(problems, allNestedPeerDependencies);
-    var installs = resolutions.filter(function (r) { return r.resolutionType === 'install'; }).map(function (r) { return r.resolution; });
-    var upgrades = resolutions.filter(function (r) { return r.resolutionType === 'upgrade'; }).map(function (r) { return r.resolution; });
-    var nosolution = resolutions.filter(function (r) { return !r.resolution; });
-    nosolution.forEach(function (solution) {
-        var name = solution.problem.name;
-        var errorPrefix = "Unable to find a version of " + name + " that satisfies the following peerDependencies:";
-        var peerDepRanges = allNestedPeerDependencies.filter(function (dep) { return dep.name === name; })
-            .reduce(function (acc, dep) { return acc.includes(dep.version) ? acc : acc.concat(dep.version); }, []);
-        console.error("\u274C\u274C\u274C  " + errorPrefix + " " + peerDepRanges.join(" and ") + "  \u274C\u274C\u274C");
-    });
-    var commandLines = packageManager_1.getCommandLines(packageManager, installs, upgrades);
-    if (nosolution.length) {
-        console.error();
-    }
-    if (installMissingPeerDependencies) {
-        console.log('Installing peerDependencies...');
-        commandLines.forEach(function (command) { return shelljs_1.exec(command); });
-    }
-    else {
-        commandLines.forEach(function (command) { return console.log(command); });
-        console.log();
-    }
-}
-exports.checkPeerDependencies = checkPeerDependencies;
-function getInstalledVersion(dep) {
-    var peerDependencyDir = packageUtils_1.resolvePackageDir(".", dep.name);
-    if (!peerDependencyDir) {
-        return undefined;
-    }
-    var packageJson = readJson_1.readJson(path.resolve(peerDependencyDir, 'package.json'));
-    return packageJson.version;
-}

package/dist/resolvePackageDir.js

@@ -1,20 +0,0 @@
-"use strict";
-exports.__esModule = true;
-var resolve = require("resolve");
-function resolvePackageDir(basedir, packageName) {
-    var packagePath;
-    function packageFilter(pkg, pkgfile) {
-        packagePath = pkgfile;
-        return pkg;
-    }
-    try {
-        resolve.sync(packageName, { basedir: basedir, packageFilter: packageFilter });
-    }
-    catch (ignored) {
-        // resolve.sync throws if no main: is present
-        // Some packages (such as @types/*) do not have a main
-        // As long as we have a packagePath, it's fine
-    }
-    return packagePath;
-}
-exports.resolvePackageDir = resolvePackageDir;