syncpack 10.0.0 → 10.1.0

package/README.md

@@ -26,6 +26,11 @@ Organise package.json files according to a conventional format, where fields app
 order and nested fields are ordered alphabetically. Shorthand properties are used where available,
 such as the `"repository"` and `"bugs"` fields.
 
+### [lint](https://jamiemason.github.io/syncpack/lint)
+
+Lint all versions and ranges and exit with 0 or 1 based on whether all files match your Syncpack
+configuration file.
+
 ### [lint-semver-ranges](https://jamiemason.github.io/syncpack/lint-semver-ranges)
 
 Check whether dependency versions used within "dependencies", "devDependencies", etc follow a

package/dist/bin-lint/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin-lint/index.js

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const chalk_1 = __importDefault(require("chalk"));
+const commander_1 = require("commander");
+const disk_1 = require("../lib/disk");
+const show_help_on_error_1 = require("../lib/show-help-on-error");
+const option_1 = require("../option");
+const lint_cli_1 = require("./lint-cli");
+commander_1.program.description('  lint all versions and ranges');
+commander_1.program.on('--help', () => {
+    console.log((0, chalk_1.default) `
+Examples:
+  {dim # uses config file for resolving packages}
+  syncpack lint
+  {dim # uses config file defined by --config when provided}
+  syncpack lint --config {yellow ./config/.syncpackrc}
+
+Resolving Packages:
+  1. If using Pnpm Workspaces, read {yellow packages} from {yellow pnpm-workspace.yaml} in the root of the project.
+  2. If using Yarn Workspaces, read {yellow workspaces} from {yellow package.json}.
+  3. If using Lerna, read {yellow packages} from {yellow lerna.json}.
+  4. Default to {yellow "package.json"} and {yellow "packages/*/package.json"}.
+
+Reference:
+  globs            {blue.underline https://github.com/isaacs/node-glob#glob-primer}
+  lerna.json       {blue.underline https://github.com/lerna/lerna#lernajson}
+  Yarn Workspaces  {blue.underline https://yarnpkg.com/lang/en/docs/workspaces}
+  Pnpm Workspaces  {blue.underline https://pnpm.js.org/en/workspaces}
+`);
+});
+(0, show_help_on_error_1.showHelpOnError)(commander_1.program);
+commander_1.program.option(...option_1.option.config).parse(process.argv);
+(0, lint_cli_1.lintCli)({
+    configPath: commander_1.program.opts().config,
+}, disk_1.disk);

package/dist/bin-lint/lint-cli.d.ts

@@ -0,0 +1,3 @@
+import type { CliConfig } from '../config/types';
+import type { Disk } from '../lib/disk';
+export declare function lintCli(input: Partial<CliConfig>, disk: Disk): void;

package/dist/bin-lint/lint-cli.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lintCli = void 0;
+const pipe_1 = require("tightrope/fn/pipe");
+const get_context_1 = require("../get-context");
+const exit_if_invalid_1 = require("../lib/exit-if-invalid");
+const lint_1 = require("./lint");
+function lintCli(input, disk) {
+    (0, pipe_1.pipe)((0, get_context_1.getContext)(input, disk), lint_1.lint, exit_if_invalid_1.exitIfInvalid);
+}
+exports.lintCli = lintCli;

package/dist/bin-lint/lint.d.ts

@@ -0,0 +1,2 @@
+import type { Context } from '../get-context';
+export declare function lint(ctx: Context): Context;

package/dist/bin-lint/lint.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lint = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const constants_1 = require("../constants");
+const get_semver_groups_1 = require("../get-semver-groups");
+const get_version_groups_1 = require("../get-version-groups");
+function lint(ctx) {
+    let totalInstances = 0;
+    const instanceCounts = {};
+    const versionGroups = (0, get_version_groups_1.getVersionGroups)(ctx);
+    const versionCounts = {
+        BANNED: 0,
+        FILTERED_OUT: 0,
+        HIGHEST_SEMVER_MISMATCH: 0,
+        IGNORED: 0,
+        LOWEST_SEMVER_MISMATCH: 0,
+        PINNED_MISMATCH: 0,
+        SEMVER_UNSATISFIED: 0,
+        SNAPPED_TO_MISMATCH: 0,
+        UNSUPPORTED_MISMATCH: 0,
+        VALID: 0,
+        WORKSPACE_MISMATCH: 0,
+        WORKSPACE_UNSATISFIED: 0,
+    };
+    versionGroups.forEach((group) => {
+        group.inspect().forEach((report) => {
+            if (!report.isValid)
+                ctx.isInvalid = true;
+            if (!versionCounts[report.status]) {
+                versionCounts[report.status] = 0;
+            }
+            versionCounts[report.status]++;
+        });
+    });
+    const semverGroups = (0, get_semver_groups_1.getSemverGroups)(ctx);
+    const semverCounts = {
+        FILTERED_OUT: 0,
+        IGNORED: 0,
+        VALID: 0,
+        WORKSPACE_SEMVER_RANGE_MISMATCH: 0,
+        SEMVER_RANGE_MISMATCH: 0,
+        UNSUPPORTED_VERSION: 0,
+    };
+    semverGroups.forEach((group) => {
+        group.inspect().forEach((report) => {
+            const status = report.status;
+            const strategyName = report.instance.strategy.name;
+            if (!report.isValid)
+                ctx.isInvalid = true;
+            if (!semverCounts[status])
+                semverCounts[status] = 0;
+            semverCounts[status]++;
+            if (!instanceCounts[strategyName])
+                instanceCounts[strategyName] = 0;
+            instanceCounts[strategyName]++;
+            totalInstances++;
+        });
+    });
+    const fileCount = ctx.packageJsonFiles.length;
+    info(fileCount, `package.json file${fileCount > 1 ? 's' : ''}`);
+    info(totalInstances, 'total dependences');
+    Object.entries(instanceCounts).forEach(([name, count]) => {
+        info(count, `in package.${name
+            .replace(/^dev$/, 'devDependencies')
+            .replace(/^peer$/, 'peerDependencies')
+            .replace(/^pnpmOverrides$/, 'pnpm.overrides')
+            .replace(/^prod$/, 'dependencies')
+            .replace(/^workspace$/, 'version')}`);
+    });
+    console.log(chalk_1.default.blue('Version mismatches'));
+    expectSome(versionCounts.VALID, 'are valid');
+    expectNone(versionCounts.HIGHEST_SEMVER_MISMATCH, 'should have matching versions (prefer highest semver)');
+    expectNone(versionCounts.LOWEST_SEMVER_MISMATCH, 'should have matching versions (prefer lowest semver)');
+    expectNone(versionCounts.WORKSPACE_MISMATCH, 'should match workspace package version');
+    expectNone(versionCounts.BANNED, 'are banned from use');
+    expectNone(versionCounts.PINNED_MISMATCH, 'should be pinned to a specific version');
+    expectNone(versionCounts.SNAPPED_TO_MISMATCH, 'should snap to version used by another package');
+    info(versionCounts.FILTERED_OUT, 'are filtered out');
+    info(versionCounts.IGNORED, 'are ignored');
+    info(versionCounts.UNSUPPORTED_MISMATCH, 'have unsupported version format');
+    console.log(chalk_1.default.blue('Semver range mismatches'));
+    expectSome(semverCounts.VALID, 'are valid');
+    expectNone(semverCounts.SEMVER_RANGE_MISMATCH, 'should use specific semver range');
+    expectNone(semverCounts.WORKSPACE_SEMVER_RANGE_MISMATCH, 'should use exact version in version property of package.json');
+    info(semverCounts.FILTERED_OUT, 'are filtered out');
+    info(semverCounts.IGNORED, 'are ignored');
+    info(semverCounts.UNSUPPORTED_VERSION, 'have unsupported version format');
+    return ctx;
+    function expectNone(count = 0, ...rest) {
+        if (count === 0) {
+            console.log(chalk_1.default.dim(constants_1.ICON.skip), pad(count), ...rest);
+        }
+        else {
+            console.log(chalk_1.default.red(constants_1.ICON.cross, pad(count), ...rest));
+        }
+    }
+    function expectSome(count = 0, ...rest) {
+        if (count > 0) {
+            console.log(chalk_1.default.dim(constants_1.ICON.skip), pad(count), ...rest);
+        }
+        else {
+            console.log(chalk_1.default.red(constants_1.ICON.cross, pad(count), ...rest));
+        }
+    }
+    function info(count = 0, ...rest) {
+        console.log(chalk_1.default.dim(constants_1.ICON.skip), pad(count), ...rest);
+    }
+    function pad(count) {
+        return String(count).padStart(String(totalInstances).length, ' ');
+    }
+}
+exports.lint = lint;

package/dist/bin.js

@@ -9,6 +9,9 @@ commander_1.program
 })
     .command('format', 'sort and shorten properties according to a convention', {
     executableFile: './bin-format/index.js',
+})
+    .command('lint', 'lint all versions and ranges', {
+    executableFile: './bin-lint/index.js',
 })
     .command('lint-semver-ranges', 'check dependency versions comply with the given semver range format', {
     executableFile: './bin-lint-semver-ranges/index.js',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "syncpack",
   "description": "Consistent dependency versions in large JavaScript Monorepos",
-  "version": "10.0.0",
+  "version": "10.1.0",
   "author": "Jamie Mason <jamie@foldleft.io> (https://github.com/JamieMason)",
   "bin": {
     "syncpack": "dist/bin.js",