syncpack 12.0.1 → 12.2.0

package/dist/report.js

@@ -1,67 +1,132 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Report = void 0;
-const effect_1 = require("effect");
 var Report;
 (function (Report) {
+    class Excluded {
+        _tagGroup = 'Excluded';
+        isInvalid = false;
+        instance;
+        constructor(instance) {
+            this.instance = instance;
+        }
+    }
+    class Unfixable {
+        _tagGroup = 'Unfixable';
+        isInvalid = true;
+        unfixable;
+        constructor(unfixable) {
+            this.unfixable = unfixable;
+        }
+    }
+    class Fixable {
+        _tagGroup = 'Fixable';
+        isInvalid = true;
+        fixable;
+        constructor(fixable) {
+            this.fixable = fixable;
+        }
+    }
     /** Semver Groups are disabled by default */
-    class Disabled extends effect_1.Data.TaggedClass('Disabled') {
+    class Disabled extends Excluded {
+        _tag = 'Disabled';
     }
     Report.Disabled = Disabled;
     /** Has a name which does not match the `--filter` RegExp */
-    class FilteredOut extends effect_1.Data.TaggedClass('FilteredOut') {
+    class FilteredOut extends Excluded {
+        _tag = 'FilteredOut';
     }
     Report.FilteredOut = FilteredOut;
     /** Is in an ignored version group */
-    class Ignored extends effect_1.Data.TaggedClass('Ignored') {
+    class Ignored extends Excluded {
+        _tag = 'Ignored';
     }
     Report.Ignored = Ignored;
     /** Version satisfies the rules of its version group */
-    class Valid extends effect_1.Data.TaggedClass('Valid') {
+    class Valid {
+        _tag = 'Valid';
+        _tagGroup = 'Valid';
+        isInvalid = false;
+        specifier;
+        constructor(specifier) {
+            this.specifier = specifier;
+        }
     }
     Report.Valid = Valid;
     /** Must be removed */
-    class Banned extends effect_1.Data.TaggedClass('Banned') {
+    class Banned extends Fixable {
+        _tag = 'Banned';
     }
     Report.Banned = Banned;
     /** Version mismatches and should use a higher version found on another */
-    class HighestSemverMismatch extends effect_1.Data.TaggedClass('HighestSemverMismatch') {
+    class HighestSemverMismatch extends Fixable {
+        _tag = 'HighestSemverMismatch';
     }
     Report.HighestSemverMismatch = HighestSemverMismatch;
     /** Version mismatches the `.version` of the package developed in this repo */
-    class LocalPackageMismatch extends effect_1.Data.TaggedClass('LocalPackageMismatch') {
+    class LocalPackageMismatch extends Fixable {
+        _tag = 'LocalPackageMismatch';
+        localInstance;
+        constructor(fixable, localInstance) {
+            super(fixable);
+            this.localInstance = localInstance;
+        }
     }
     Report.LocalPackageMismatch = LocalPackageMismatch;
     /** Version mismatches and should use a lower version found on another */
-    class LowestSemverMismatch extends effect_1.Data.TaggedClass('LowestSemverMismatch') {
+    class LowestSemverMismatch extends Fixable {
+        _tag = 'LowestSemverMismatch';
     }
     Report.LowestSemverMismatch = LowestSemverMismatch;
     /** Version is not identical to the `pinVersion` of its Pinned version group */
-    class PinnedMismatch extends effect_1.Data.TaggedClass('PinnedMismatch') {
+    class PinnedMismatch extends Fixable {
+        _tag = 'PinnedMismatch';
     }
     Report.PinnedMismatch = PinnedMismatch;
     /** Version is identical but the semver range does not match its semver group */
-    class SemverRangeMismatch extends effect_1.Data.TaggedClass('SemverRangeMismatch') {
+    class SemverRangeMismatch extends Fixable {
+        _tag = 'SemverRangeMismatch';
     }
     Report.SemverRangeMismatch = SemverRangeMismatch;
     /** Version mismatches the version used by the packages in the `snapTo` array */
-    class SnappedToMismatch extends effect_1.Data.TaggedClass('SnappedToMismatch') {
+    class SnappedToMismatch extends Fixable {
+        _tag = 'SnappedToMismatch';
+        localInstance;
+        constructor(fixable, localInstance) {
+            super(fixable);
+            this.localInstance = localInstance;
+        }
     }
     Report.SnappedToMismatch = SnappedToMismatch;
     /** Dependency should match a local package.json which is missing a .version */
-    class MissingLocalVersion extends effect_1.Data.TaggedClass('MissingLocalVersion') {
+    class MissingLocalVersion extends Unfixable {
+        _tag = 'MissingLocalVersion';
+        localInstance;
+        constructor(unfixable, localInstance) {
+            super(unfixable);
+            this.localInstance = localInstance;
+        }
     }
     Report.MissingLocalVersion = MissingLocalVersion;
     /** Dependency is not present in any of the packages in the `snapTo` array */
-    class MissingSnappedToMismatch extends effect_1.Data.TaggedClass('MissingSnappedToMismatch') {
+    class MissingSnappedToMismatch extends Unfixable {
+        _tag = 'MissingSnappedToMismatch';
     }
     Report.MissingSnappedToMismatch = MissingSnappedToMismatch;
     /** Specifier does not cover the specifiers of every other instance in this group */
-    class SameRangeMismatch extends effect_1.Data.TaggedClass('SameRangeMismatch') {
+    class SameRangeMismatch extends Unfixable {
+        _tag = 'SameRangeMismatch';
+        /** the raw specifiers which this instance's specifier did not cover */
+        mismatches;
+        constructor(unfixable, mismatches) {
+            super(unfixable);
+            this.mismatches = mismatches;
+        }
     }
     Report.SameRangeMismatch = SameRangeMismatch;
     /** Version mismatches and is not semver, syncpack cannot guess what to do */
-    class UnsupportedMismatch extends effect_1.Data.TaggedClass('UnsupportedMismatch') {
+    class UnsupportedMismatch extends Unfixable {
+        _tag = 'UnsupportedMismatch';
     }
     Report.UnsupportedMismatch = UnsupportedMismatch;
 })(Report || (exports.Report = Report = {}));

package/dist/schema.json

@@ -2,62 +2,52 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "additionalProperties": false,
     "definitions": {
-        "Record<string,CustomTypeConfig.Any>": {
-            "additionalProperties": false,
-            "type": "object"
-        },
-        "SemverGroupConfig.Any": {
+        "DependencyType": {
             "anyOf": [
                 {
-                    "$ref": "#/definitions/{isDisabled:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;range?:never;}"
+                    "additionalProperties": false,
+                    "properties": {},
+                    "type": "object"
                 },
                 {
-                    "$ref": "#/definitions/{isIgnored:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isDisabled?:never;range?:never;}"
-                },
-                {
-                    "$ref": "#/definitions/{range:SemverRange;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isDisabled?:never;isIgnored?:never;}"
+                    "enum": [
+                        "!dev",
+                        "!local",
+                        "!overrides",
+                        "!peer",
+                        "!pnpmOverrides",
+                        "!prod",
+                        "!resolutions",
+                        "dev",
+                        "local",
+                        "overrides",
+                        "peer",
+                        "pnpmOverrides",
+                        "prod",
+                        "resolutions"
+                    ],
+                    "type": "string"
                 }
             ]
         },
-        "SemverRange": {
-            "default": "",
-            "description": "Aliases for semver range formats supported by syncpack\n\nDefaults to `\"\"` to ensure that exact dependency versions are used instead of\nloose ranges, but this can be overridden in your config file.\n\n| Supported Range |   Example |\n| --------------- | --------: |\n| `\"<\"`           |  `<1.4.2` |\n| `\"<=\"`          | `<=1.4.2` |\n| `\"\"`            |   `1.4.2` |\n| `\"~\"`           |  `~1.4.2` |\n| `\"^\"`           |  `^1.4.2` |\n| `\">=\"`          | `>=1.4.2` |\n| `\">\"`           |  `>1.4.2` |\n| `\"*\"`           |       `*` |",
-            "enum": [
-                "",
-                "*",
-                ".x",
-                "<",
-                "<=",
-                ">",
-                ">=",
-                "^",
-                "~"
-            ],
-            "type": "string"
+        "Record<string,CustomTypeConfig.Any>": {
+            "additionalProperties": false,
+            "type": "object"
         },
-        "VersionGroupConfig.Any": {
+        "SemverGroupConfig.Any": {
             "anyOf": [
                 {
-                    "$ref": "#/definitions/{isBanned:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;pinVersion?:never;snapTo?:never;policy?:never;preferVersion?:never;}"
-                },
-                {
-                    "$ref": "#/definitions/{isIgnored:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isBanned?:never;pinVersion?:never;snapTo?:never;policy?:never;preferVersion?:never;}"
+                    "$ref": "#/definitions/SemverGroupConfig.Disabled"
                 },
                 {
-                    "$ref": "#/definitions/{pinVersion:string;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;snapTo?:never;policy?:never;preferVersion?:never;}"
+                    "$ref": "#/definitions/SemverGroupConfig.Ignored"
                 },
                 {
-                    "$ref": "#/definitions/{snapTo:string[];dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;policy?:never;preferVersion?:never;}"
-                },
-                {
-                    "$ref": "#/definitions/{policy:\"sameRange\";dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;snapTo?:never;preferVersion?:never;}"
-                },
-                {
-                    "$ref": "#/definitions/{preferVersion?:\"highestSemver\"|\"lowestSemver\";dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;snapTo?:never;policy?:never;}"
+                    "$ref": "#/definitions/SemverGroupConfig.WithRange"
                 }
             ]
         },
-        "{isBanned:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;pinVersion?:never;snapTo?:never;policy?:never;preferVersion?:never;}": {
+        "SemverGroupConfig.Disabled": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -68,11 +58,11 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
-                "isBanned": {
+                "isDisabled": {
                     "const": true,
                     "type": "boolean"
                 },
@@ -84,11 +74,17 @@
                         "type": "string"
                     },
                     "type": "array"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{isDisabled:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;range?:never;}": {
+        "SemverGroupConfig.Ignored": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -99,11 +95,11 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
-                "isDisabled": {
+                "isIgnored": {
                     "const": true,
                     "type": "boolean"
                 },
@@ -115,11 +111,17 @@
                         "type": "string"
                     },
                     "type": "array"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{isIgnored:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isBanned?:never;pinVersion?:never;snapTo?:never;policy?:never;preferVersion?:never;}": {
+        "SemverGroupConfig.WithRange": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -130,14 +132,10 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
-                "isIgnored": {
-                    "const": true,
-                    "type": "boolean"
-                },
                 "label": {
                     "type": "string"
                 },
@@ -146,11 +144,95 @@
                         "type": "string"
                     },
                     "type": "array"
+                },
+                "range": {
+                    "$ref": "#/definitions/SemverRange"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{isIgnored:true;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isDisabled?:never;range?:never;}": {
+        "SemverRange": {
+            "default": "",
+            "description": "Aliases for semver range formats supported by syncpack\n\nDefaults to `\"\"` to ensure that exact dependency versions are used instead of\nloose ranges, but this can be overridden in your config file.\n\n| Supported Range |   Example |\n| --------------- | --------: |\n| `\"<\"`           |  `<1.4.2` |\n| `\"<=\"`          | `<=1.4.2` |\n| `\"\"`            |   `1.4.2` |\n| `\"~\"`           |  `~1.4.2` |\n| `\"^\"`           |  `^1.4.2` |\n| `\">=\"`          | `>=1.4.2` |\n| `\">\"`           |  `>1.4.2` |\n| `\"*\"`           |       `*` |",
+            "enum": [
+                "",
+                "*",
+                ".x",
+                "<",
+                "<=",
+                ">",
+                ">=",
+                "^",
+                "workspace:",
+                "~"
+            ],
+            "type": "string"
+        },
+        "SpecifierType": {
+            "anyOf": [
+                {
+                    "additionalProperties": false,
+                    "properties": {},
+                    "type": "object"
+                },
+                {
+                    "enum": [
+                        "!alias",
+                        "!delete",
+                        "!exact",
+                        "!file",
+                        "!hosted-git",
+                        "!latest",
+                        "!range",
+                        "!tag",
+                        "!unsupported",
+                        "!url",
+                        "!workspace-protocol",
+                        "alias",
+                        "delete",
+                        "exact",
+                        "file",
+                        "hosted-git",
+                        "latest",
+                        "range",
+                        "tag",
+                        "unsupported",
+                        "url",
+                        "workspace-protocol"
+                    ],
+                    "type": "string"
+                }
+            ]
+        },
+        "VersionGroupConfig.Any": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.Banned"
+                },
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.Ignored"
+                },
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.Pinned"
+                },
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.SameRange"
+                },
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.SnappedTo"
+                },
+                {
+                    "$ref": "#/definitions/VersionGroupConfig.Standard"
+                }
+            ]
+        },
+        "VersionGroupConfig.Banned": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -161,11 +243,11 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
-                "isIgnored": {
+                "isBanned": {
                     "const": true,
                     "type": "boolean"
                 },
@@ -177,11 +259,17 @@
                         "type": "string"
                     },
                     "type": "array"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{pinVersion:string;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;snapTo?:never;policy?:never;preferVersion?:never;}": {
+        "VersionGroupConfig.Ignored": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -192,10 +280,14 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
+                "isIgnored": {
+                    "const": true,
+                    "type": "boolean"
+                },
                 "label": {
                     "type": "string"
                 },
@@ -205,13 +297,16 @@
                     },
                     "type": "array"
                 },
-                "pinVersion": {
-                    "type": "string"
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{policy:\"sameRange\";dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;snapTo?:never;preferVersion?:never;}": {
+        "VersionGroupConfig.Pinned": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -222,7 +317,7 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
@@ -235,14 +330,19 @@
                     },
                     "type": "array"
                 },
-                "policy": {
-                    "const": "sameRange",
+                "pinVersion": {
                     "type": "string"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{preferVersion?:\"highestSemver\"|\"lowestSemver\";dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;snapTo?:never;policy?:never;}": {
+        "VersionGroupConfig.SameRange": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -253,7 +353,7 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
@@ -266,17 +366,20 @@
                     },
                     "type": "array"
                 },
-                "preferVersion": {
-                    "enum": [
-                        "highestSemver",
-                        "lowestSemver"
-                    ],
+                "policy": {
+                    "const": "sameRange",
                     "type": "string"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{range:SemverRange;dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isDisabled?:never;isIgnored?:never;}": {
+        "VersionGroupConfig.SnappedTo": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -287,7 +390,7 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
@@ -300,13 +403,22 @@
                     },
                     "type": "array"
                 },
-                "range": {
-                    "$ref": "#/definitions/SemverRange"
+                "snapTo": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "specifierTypes": {
+                    "items": {
+                        "$ref": "#/definitions/SpecifierType"
+                    },
+                    "type": "array"
                 }
             },
             "type": "object"
         },
-        "{snapTo:string[];dependencies?:string[];dependencyTypes?:string[];label?:string;packages?:string[];isIgnored?:never;isBanned?:never;pinVersion?:never;policy?:never;preferVersion?:never;}": {
+        "VersionGroupConfig.Standard": {
             "additionalProperties": false,
             "properties": {
                 "dependencies": {
@@ -317,7 +429,7 @@
                 },
                 "dependencyTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/DependencyType"
                     },
                     "type": "array"
                 },
@@ -330,9 +442,16 @@
                     },
                     "type": "array"
                 },
-                "snapTo": {
+                "preferVersion": {
+                    "enum": [
+                        "highestSemver",
+                        "lowestSemver"
+                    ],
+                    "type": "string"
+                },
+                "specifierTypes": {
                     "items": {
-                        "type": "string"
+                        "$ref": "#/definitions/SpecifierType"
                     },
                     "type": "array"
                 }
@@ -346,7 +465,7 @@
         },
         "dependencyTypes": {
             "items": {
-                "type": "string"
+                "$ref": "#/definitions/DependencyType"
             },
             "type": "array"
         },
@@ -380,6 +499,12 @@
             },
             "type": "array"
         },
+        "specifierTypes": {
+            "items": {
+                "$ref": "#/definitions/SpecifierType"
+            },
+            "type": "array"
+        },
         "versionGroups": {
             "items": {
                 "$ref": "#/definitions/VersionGroupConfig.Any"

package/dist/semver-group/create-semver-groups.js

@@ -45,10 +45,14 @@ function createSemverGroups(ctx) {
                 : ['**'];
             const dependencies = (0, is_array_of_strings_1.isArrayOfStrings)(config.dependencies) ? config.dependencies : ['**'];
             const packages = (0, is_array_of_strings_1.isArrayOfStrings)(config.packages) ? config.packages : ['**'];
+            const specifierTypes = (0, is_array_of_strings_1.isArrayOfStrings)(config.specifierTypes)
+                ? config.specifierTypes
+                : ['**'];
             if (config.isIgnored === true) {
                 semverGroups.push(effect_1.Effect.succeed(new ignored_1.IgnoredSemverGroup({
                     dependencies,
                     dependencyTypes,
+                    specifierTypes,
                     isIgnored: true,
                     label,
                     packages,
@@ -58,6 +62,7 @@ function createSemverGroups(ctx) {
                 semverGroups.push(effect_1.Effect.succeed(new with_range_1.WithRangeSemverGroup(false, {
                     dependencies,
                     dependencyTypes,
+                    specifierTypes,
                     label,
                     packages,
                     range: config.range,
@@ -68,6 +73,7 @@ function createSemverGroups(ctx) {
     semverGroups.push(effect_1.Effect.succeed(new disabled_1.DisabledSemverGroup(true, {
         dependencies: ['**'],
         dependencyTypes: ['**'],
+        specifierTypes: ['**'],
         label: 'Default Semver Group',
         packages: ['**'],
         isDisabled: true,