syncpack 12.1.0 → 12.3.0

package/dist/config/types.d.ts

@@ -1,3 +1,5 @@
+import type { CUSTOM_TYPES } from '../constants';
+import type { Specifier } from '../specifier';
 /**
  * Aliases for semver range formats supported by syncpack
  *
@@ -18,11 +20,15 @@
  * @default ""
  */
 export type SemverRange = '' | '*' | '>' | '>=' | '.x' | '<' | '<=' | '^' | '~' | 'workspace:';
+type DefaultDependencyType = keyof typeof CUSTOM_TYPES;
+export type DependencyType = DefaultDependencyType | `!${DefaultDependencyType}` | (string & {});
+export type SpecifierType = Specifier.Any['name'] | `!${Specifier.Any['name']}` | (string & {});
 export interface GroupConfig {
     dependencies?: string[];
-    dependencyTypes?: string[];
+    dependencyTypes?: DependencyType[];
     label?: string;
     packages?: string[];
+    specifierTypes?: SpecifierType[];
 }
 export declare namespace SemverGroupConfig {
     interface Disabled extends GroupConfig {
@@ -85,25 +91,42 @@ export interface CliConfig {
     readonly filter: string;
     readonly indent: string;
     readonly source: string[];
+    readonly specs: string;
     readonly types: string;
 }
 export interface RcConfig {
     /** @see https://jamiemason.github.io/syncpack/config/custom-types */
     customTypes: Record<string, CustomTypeConfig.Any>;
     /** @see https://jamiemason.github.io/syncpack/config/dependency-types */
-    dependencyTypes: string[];
+    dependencyTypes: DependencyType[];
     /** @see https://jamiemason.github.io/syncpack/config/filter */
     filter: string;
+    /** @see https://jamiemason.github.io/syncpack/config/format-bugs */
+    formatBugs: boolean;
+    /** @see https://jamiemason.github.io/syncpack/config/format-repository */
+    formatRepository: boolean;
     /** @see https://jamiemason.github.io/syncpack/config/indent */
     indent: string;
+    /** @see https://jamiemason.github.io/syncpack/config/lint-formatting */
+    lintFormatting: boolean;
+    /** @see https://jamiemason.github.io/syncpack/config/lint-semver-ranges */
+    lintSemverRanges: boolean;
+    /** @see https://jamiemason.github.io/syncpack/config/lint-versions */
+    lintVersions: boolean;
     /** @see https://jamiemason.github.io/syncpack/config/semver-groups */
     semverGroups: SemverGroupConfig.Any[];
     /** @see https://jamiemason.github.io/syncpack/config/sort-az */
     sortAz: string[];
+    /** @see https://jamiemason.github.io/syncpack/config/sort-exports */
+    sortExports: string[];
     /** @see https://jamiemason.github.io/syncpack/config/sort-first */
     sortFirst: string[];
+    /** @see https://jamiemason.github.io/syncpack/config/sort-packages */
+    sortPackages: boolean;
     /** @see https://jamiemason.github.io/syncpack/config/source */
     source: string[];
+    /** @see https://jamiemason.github.io/syncpack/config/specifier-types */
+    specifierTypes: SpecifierType[];
     /** @see https://jamiemason.github.io/syncpack/config/version-groups */
     versionGroups: VersionGroupConfig.Any[];
 }

package/dist/constants.d.ts

@@ -24,44 +24,83 @@ export declare const RANGE: {
     readonly WORKSPACE: "workspace:";
 };
 export declare const INTERNAL_TYPES: readonly ["dev", "local", "overrides", "peer", "pnpmOverrides", "prod", "resolutions"];
+export declare const CUSTOM_TYPES: {
+    readonly dev: {
+        readonly strategy: "versionsByName";
+        readonly path: "devDependencies";
+    };
+    readonly local: {
+        readonly strategy: "name~version";
+        readonly namePath: "name";
+        readonly path: "version";
+    };
+    readonly overrides: {
+        readonly strategy: "versionsByName";
+        readonly path: "overrides";
+    };
+    readonly peer: {
+        readonly strategy: "versionsByName";
+        readonly path: "peerDependencies";
+    };
+    readonly pnpmOverrides: {
+        readonly strategy: "versionsByName";
+        readonly path: "pnpm.overrides";
+    };
+    readonly prod: {
+        readonly strategy: "versionsByName";
+        readonly path: "dependencies";
+    };
+    readonly resolutions: {
+        readonly strategy: "versionsByName";
+        readonly path: "resolutions";
+    };
+};
 export declare const DEFAULT_CONFIG: {
     customTypes: {
-        dev: {
-            strategy: "versionsByName";
-            path: string;
+        readonly dev: {
+            readonly strategy: "versionsByName";
+            readonly path: "devDependencies";
         };
-        local: {
-            strategy: "name~version";
-            namePath: string;
-            path: string;
+        readonly local: {
+            readonly strategy: "name~version";
+            readonly namePath: "name";
+            readonly path: "version";
         };
-        overrides: {
-            strategy: "versionsByName";
-            path: string;
+        readonly overrides: {
+            readonly strategy: "versionsByName";
+            readonly path: "overrides";
         };
-        peer: {
-            strategy: "versionsByName";
-            path: string;
+        readonly peer: {
+            readonly strategy: "versionsByName";
+            readonly path: "peerDependencies";
         };
-        pnpmOverrides: {
-            strategy: "versionsByName";
-            path: string;
+        readonly pnpmOverrides: {
+            readonly strategy: "versionsByName";
+            readonly path: "pnpm.overrides";
         };
-        prod: {
-            strategy: "versionsByName";
-            path: string;
+        readonly prod: {
+            readonly strategy: "versionsByName";
+            readonly path: "dependencies";
         };
-        resolutions: {
-            strategy: "versionsByName";
-            path: string;
+        readonly resolutions: {
+            readonly strategy: "versionsByName";
+            readonly path: "resolutions";
         };
     };
-    dependencyTypes: string[];
+    dependencyTypes: "**"[];
     filter: string;
+    formatBugs: true;
+    formatRepository: true;
     indent: string;
+    lintFormatting: true;
+    lintSemverRanges: true;
+    lintVersions: true;
     semverGroups: never[];
     sortAz: string[];
+    sortExports: string[];
     sortFirst: string[];
+    sortPackages: true;
     source: string[];
+    specifierTypes: "**"[];
     versionGroups: never[];
 };

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_CONFIG = exports.INTERNAL_TYPES = exports.RANGE = exports.ICON = exports.CWD = void 0;
+exports.DEFAULT_CONFIG = exports.CUSTOM_TYPES = exports.INTERNAL_TYPES = exports.RANGE = exports.ICON = exports.CWD = void 0;
 /** Single source of truth, intended to aid testing or to override */
 exports.CWD = process.env.MOCK_CWD || process.cwd();
 /** Single source of truth for icons used in output */
@@ -35,43 +35,50 @@ exports.INTERNAL_TYPES = [
     'prod',
     'resolutions',
 ];
-exports.DEFAULT_CONFIG = {
-    customTypes: {
-        dev: {
-            strategy: 'versionsByName',
-            path: 'devDependencies',
-        },
-        local: {
-            strategy: 'name~version',
-            namePath: 'name',
-            path: 'version',
-        },
-        overrides: {
-            strategy: 'versionsByName',
-            path: 'overrides',
-        },
-        peer: {
-            strategy: 'versionsByName',
-            path: 'peerDependencies',
-        },
-        pnpmOverrides: {
-            strategy: 'versionsByName',
-            path: 'pnpm.overrides',
-        },
-        prod: {
-            strategy: 'versionsByName',
-            path: 'dependencies',
-        },
-        resolutions: {
-            strategy: 'versionsByName',
-            path: 'resolutions',
-        },
+exports.CUSTOM_TYPES = {
+    dev: {
+        strategy: 'versionsByName',
+        path: 'devDependencies',
+    },
+    local: {
+        strategy: 'name~version',
+        namePath: 'name',
+        path: 'version',
+    },
+    overrides: {
+        strategy: 'versionsByName',
+        path: 'overrides',
+    },
+    peer: {
+        strategy: 'versionsByName',
+        path: 'peerDependencies',
+    },
+    pnpmOverrides: {
+        strategy: 'versionsByName',
+        path: 'pnpm.overrides',
     },
+    prod: {
+        strategy: 'versionsByName',
+        path: 'dependencies',
+    },
+    resolutions: {
+        strategy: 'versionsByName',
+        path: 'resolutions',
+    },
+};
+exports.DEFAULT_CONFIG = {
+    customTypes: exports.CUSTOM_TYPES,
     dependencyTypes: ['**'],
     filter: '.',
+    formatBugs: true,
+    formatRepository: true,
     indent: '  ',
+    lintFormatting: true,
+    lintSemverRanges: true,
+    lintVersions: true,
     semverGroups: [],
     sortAz: [
+        'bin',
         'contributors',
         'dependencies',
         'devDependencies',
@@ -80,7 +87,20 @@ exports.DEFAULT_CONFIG = {
         'resolutions',
         'scripts',
     ],
+    sortExports: [
+        'types',
+        'node-addons',
+        'node',
+        'browser',
+        'import',
+        'require',
+        'development',
+        'production',
+        'default',
+    ],
     sortFirst: ['name', 'description', 'version', 'author'],
+    sortPackages: true,
     source: ['package.json', 'packages/*/package.json'],
+    specifierTypes: ['**'],
     versionGroups: [],
 };

package/dist/get-instances/instance.d.ts

@@ -2,6 +2,7 @@ import type { Effect } from 'effect';
 import type { Strategy } from '../config/get-custom-types';
 import type { PackageJsonFile } from '../get-package-json-files/package-json-file';
 import type { SemverGroup } from '../semver-group';
+import { Specifier } from '../specifier';
 import type { VersionGroup } from '../version-group';
 import type { Delete } from '../version-group/lib/delete';
 export declare class Instance {
@@ -10,7 +11,7 @@ export declare class Instance {
     /** The .name property of the package.json file of this instance */
     pkgName: string;
     /** The specifier as it is on disk before being fixed */
-    rawSpecifier: string;
+    rawSpecifier: Specifier.Any;
     /** The package this dependency is installed in this specific time */
     packageJsonFile: PackageJsonFile;
     /** Locates where in the file this dependency is installed */

package/dist/get-instances/instance.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Instance = void 0;
+const specifier_1 = require("../specifier");
 class Instance {
     /** The name of this dependency */
     name;
@@ -19,16 +20,16 @@ class Instance {
     constructor(name, rawSpecifier, packageJsonFile, strategy) {
         this.name = name;
         this.pkgName = packageJsonFile.jsonFile.contents.name || 'PACKAGE_JSON_HAS_NO_NAME';
-        this.rawSpecifier = rawSpecifier;
         this.packageJsonFile = packageJsonFile;
         this.strategy = strategy;
         this.semverGroup = null;
         this.versionGroup = null;
+        this.rawSpecifier = specifier_1.Specifier.create(this, rawSpecifier);
     }
     /** Mutate the package.json file in memory with the latest version specifier */
     write(rawSpecifier) {
-        this.rawSpecifier = rawSpecifier;
-        return this.strategy.write(this.packageJsonFile, [this.name, this.rawSpecifier]);
+        this.rawSpecifier = specifier_1.Specifier.create(this, rawSpecifier);
+        return this.strategy.write(this.packageJsonFile, [this.name, this.rawSpecifier.raw]);
     }
 }
 exports.Instance = Instance;

package/dist/guards/can-add-to-group.js

@@ -4,11 +4,12 @@ exports.canAddToGroup = void 0;
 const minimatch_1 = require("minimatch");
 const is_non_empty_array_1 = require("tightrope/guard/is-non-empty-array");
 function canAddToGroup(packageJsonFilesByName, group, instance) {
-    const { dependencies, dependencyTypes, packages } = group.config;
+    const { dependencies, dependencyTypes, packages, specifierTypes } = group.config;
     return (group.canAdd(instance) &&
         matchesDependencyTypes(dependencyTypes, instance) &&
         matchesPackages(packages, instance) &&
-        matchesDependencies(packageJsonFilesByName, group, dependencies, instance));
+        matchesDependencies(packageJsonFilesByName, group, dependencies, instance) &&
+        matchesSpecifierTypes(specifierTypes, instance));
 }
 exports.canAddToGroup = canAddToGroup;
 function matchesDependencies(packageJsonFilesByName, group, dependencies, instance) {
@@ -28,14 +29,20 @@ function matchesPackages(packages, instance) {
     return packages.some((pattern) => (0, minimatch_1.minimatch)(instance.pkgName, pattern));
 }
 function matchesDependencyTypes(dependencyTypes, instance) {
+    return matchesKnownList(dependencyTypes, instance.strategy.name);
+}
+function matchesSpecifierTypes(specifierTypes, instance) {
+    return matchesKnownList(specifierTypes, instance.rawSpecifier.name);
+}
+function matchesKnownList(values, value) {
     // matches if not defined
-    if (!(0, is_non_empty_array_1.isNonEmptyArray)(dependencyTypes))
+    if (!(0, is_non_empty_array_1.isNonEmptyArray)(values))
         return true;
-    if (dependencyTypes.join('') === '**')
+    if (values.join('') === '**')
         return true;
     const negative = [];
     const positive = [];
-    dependencyTypes.forEach((name) => {
+    values.forEach((name) => {
         if (name.startsWith('!')) {
             negative.push(name.replace('!', ''));
         }
@@ -43,7 +50,7 @@ function matchesDependencyTypes(dependencyTypes, instance) {
             positive.push(name);
         }
     });
-    if ((0, is_non_empty_array_1.isNonEmptyArray)(negative) && !negative.includes(instance.strategy.name))
+    if ((0, is_non_empty_array_1.isNonEmptyArray)(negative) && !negative.includes(value))
         return true;
-    return (0, is_non_empty_array_1.isNonEmptyArray)(positive) && positive.includes(instance.strategy.name);
+    return (0, is_non_empty_array_1.isNonEmptyArray)(positive) && positive.includes(value);
 }

package/dist/io/to-json.d.ts

@@ -0,0 +1,9 @@
+import type { Ctx } from '../get-context';
+import type { PackageJsonFile } from '../get-package-json-files/package-json-file';
+type Ending = '\n' | '\r' | '\r\n' | string;
+export declare const newlines: {
+    detect(source: string): Ending;
+    fix(source: string, lineEnding: Ending): string;
+};
+export declare function toJson(ctx: Ctx, file: PackageJsonFile): string;
+export {};

package/dist/io/to-json.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toJson = exports.newlines = void 0;
+const os_1 = require("os");
+const get_indent_1 = require("../config/get-indent");
+const CR = '\r';
+const CRLF = '\r\n';
+const LF = '\n';
+exports.newlines = {
+    detect(source) {
+        const cr = source.split(CR).length;
+        const lf = source.split(LF).length;
+        const crlf = source.split(CRLF).length;
+        if (cr + lf === 0)
+            return os_1.EOL;
+        if (crlf === cr && crlf === lf)
+            return CRLF;
+        if (cr > lf)
+            return CR;
+        return LF;
+    },
+    fix(source, lineEnding) {
+        return source.replace(/\r\n|\n|\r/g, lineEnding);
+    },
+};
+function toJson(ctx, file) {
+    const contents = file.jsonFile.contents;
+    const indent = (0, get_indent_1.getIndent)(ctx.config);
+    const EOL = exports.newlines.detect(file.jsonFile.json);
+    const source = `${JSON.stringify(contents, null, indent)}${EOL}`;
+    return exports.newlines.fix(source, EOL);
+}
+exports.toJson = toJson;

package/dist/io/write-if-changed.d.ts

@@ -3,9 +3,3 @@ import type { Io } from '.';
 import type { Ctx } from '../get-context';
 import type { WriteFileError } from './write-file-sync';
 export declare function writeIfChanged(ctx: Ctx): Effect.Effect<Io, WriteFileError, Ctx>;
-type Ending = '\n' | '\r' | '\r\n' | string;
-export declare const newlines: {
-    detect(source: string): Ending;
-    fix(source: string, lineEnding: Ending): string;
-};
-export {};

package/dist/io/write-if-changed.js

@@ -3,43 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.newlines = exports.writeIfChanged = void 0;
+exports.writeIfChanged = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const effect_1 = require("effect");
-const os_1 = require("os");
-const get_indent_1 = require("../config/get-indent");
 const constants_1 = require("../constants");
+const to_json_1 = require("./to-json");
 const write_file_sync_1 = require("./write-file-sync");
 function writeIfChanged(ctx) {
-    return (0, effect_1.pipe)(effect_1.Effect.all(ctx.packageJsonFiles.map((file) => (0, effect_1.pipe)(effect_1.Effect.Do, effect_1.Effect.bind('nextJson', () => toJson(file)), effect_1.Effect.bind('hasChanged', ({ nextJson }) => effect_1.Effect.succeed(file.jsonFile.json !== nextJson)), effect_1.Effect.flatMap(({ hasChanged, nextJson }) => hasChanged
+    return (0, effect_1.pipe)(effect_1.Effect.all(ctx.packageJsonFiles.map((file) => (0, effect_1.pipe)(effect_1.Effect.Do, effect_1.Effect.bind('nextJson', () => effect_1.Effect.succeed((0, to_json_1.toJson)(ctx, file))), effect_1.Effect.bind('hasChanged', ({ nextJson }) => effect_1.Effect.succeed(file.jsonFile.json !== nextJson)), effect_1.Effect.flatMap(({ hasChanged, nextJson }) => hasChanged
         ? (0, effect_1.pipe)((0, write_file_sync_1.writeFileSync)(file.jsonFile.filePath, nextJson), effect_1.Effect.flatMap(() => effect_1.Effect.logInfo((0, chalk_1.default) `{green ${constants_1.ICON.tick}} ${file.jsonFile.shortPath}`)))
         : effect_1.Effect.logInfo((0, chalk_1.default) `{dim ${constants_1.ICON.skip} ${file.jsonFile.shortPath}}`))))), effect_1.Effect.map(() => ctx));
-    function toJson(file) {
-        const contents = file.jsonFile.contents;
-        const indent = (0, get_indent_1.getIndent)(ctx.config);
-        const EOL = exports.newlines.detect(file.jsonFile.json);
-        const source = `${JSON.stringify(contents, null, indent)}${EOL}`;
-        return effect_1.Effect.succeed(exports.newlines.fix(source, EOL));
-    }
 }
 exports.writeIfChanged = writeIfChanged;
-const CR = '\r';
-const CRLF = '\r\n';
-const LF = '\n';
-exports.newlines = {
-    detect(source) {
-        const cr = source.split(CR).length;
-        const lf = source.split(LF).length;
-        const crlf = source.split(CRLF).length;
-        if (cr + lf === 0)
-            return os_1.EOL;
-        if (crlf === cr && crlf === lf)
-            return CRLF;
-        if (cr > lf)
-            return CR;
-        return LF;
-    },
-    fix(source, lineEnding) {
-        return source.replace(/\r\n|\n|\r/g, lineEnding);
-    },
-};

package/dist/option.d.ts

@@ -3,6 +3,7 @@ export declare const option: {
     readonly filter: readonly ["-f, --filter [pattern]", string];
     readonly indent: readonly ["-i, --indent [value]", `override indentation. defaults to "${string}"`];
     readonly source: readonly ["-s, --source [pattern]", "glob pattern for package.json files to read from", typeof collect, string[]];
+    readonly specs: readonly ["-s, --specs <names>", string];
     readonly types: readonly ["-t, --types <names>", string];
 };
 declare function collect(value: string, previous: string[]): string[];

package/dist/option.js

@@ -19,6 +19,10 @@ exports.option = {
         collect,
         [],
     ],
+    specs: [
+        '-s, --specs <names>',
+        (0, chalk_1.default) `only include dependencies whose version specifier match these types (eg. {yellow specs=latest,range,workspace-protocol})`,
+    ],
     types: [
         '-t, --types <names>',
         (0, chalk_1.default) `only include dependencies matching these types (eg. {yellow types=dev,prod,myCustomType})`,