@pnpm/lockfile.settings-checker 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2024 Zoltan Kochan and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @pnpm/lockfile.settings-checker
+
+> Utilities to check if lockfile settings are out-of-date.
+
+## Installation
+
+```sh
+pnpm add @pnpm/lockfile.settings-checker
+```
+
+## License
+
+MIT

package/lib/calcPatchHashes.d.ts

@@ -0,0 +1,2 @@
+import { type PatchFile } from '@pnpm/lockfile.types';
+export declare function calcPatchHashes(patches: Record<string, string>, lockfileDir: string): Promise<Record<string, PatchFile>>;

package/lib/calcPatchHashes.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.calcPatchHashes = calcPatchHashes;
+const path_1 = __importDefault(require("path"));
+const p_map_values_1 = __importDefault(require("p-map-values"));
+const crypto_base32_hash_1 = require("@pnpm/crypto.base32-hash");
+async function calcPatchHashes(patches, lockfileDir) {
+    return (0, p_map_values_1.default)(async (patchFilePath) => {
+        return {
+            hash: await (0, crypto_base32_hash_1.createBase32HashFromFile)(patchFilePath),
+            path: path_1.default.relative(lockfileDir, patchFilePath).replaceAll('\\', '/'),
+        };
+    }, patches);
+}
+//# sourceMappingURL=calcPatchHashes.js.map

package/lib/calcPatchHashes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calcPatchHashes.js","sourceRoot":"","sources":["../src/calcPatchHashes.ts"],"names":[],"mappings":";;;;;AAKA,0CAOC;AAZD,gDAAuB;AACvB,gEAAqC;AACrC,iEAAmE;AAG5D,KAAK,UAAU,eAAe,CAAE,OAA+B,EAAE,WAAmB;IACzF,OAAO,IAAA,sBAAU,EAAC,KAAK,EAAE,aAAa,EAAE,EAAE;QACxC,OAAO;YACL,IAAI,EAAE,MAAM,IAAA,6CAAwB,EAAC,aAAa,CAAC;YACnD,IAAI,EAAE,cAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC;SACtE,CAAA;IACH,CAAC,EAAE,OAAO,CAAC,CAAA;AACb,CAAC"}

package/lib/createOverridesMapFromParsed.d.ts

@@ -0,0 +1,2 @@
+import { type VersionOverride } from '@pnpm/parse-overrides';
+export declare function createOverridesMapFromParsed(parsedOverrides: VersionOverride[] | undefined): Record<string, string>;

package/lib/createOverridesMapFromParsed.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOverridesMapFromParsed = createOverridesMapFromParsed;
+function createOverridesMapFromParsed(parsedOverrides) {
+    if (!parsedOverrides)
+        return {};
+    const overridesMap = {};
+    for (const { selector, newPref } of parsedOverrides) {
+        overridesMap[selector] = newPref;
+    }
+    return overridesMap;
+}
+//# sourceMappingURL=createOverridesMapFromParsed.js.map

package/lib/createOverridesMapFromParsed.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createOverridesMapFromParsed.js","sourceRoot":"","sources":["../src/createOverridesMapFromParsed.ts"],"names":[],"mappings":";;AAEA,oEAOC;AAPD,SAAgB,4BAA4B,CAAE,eAA8C;IAC1F,IAAI,CAAC,eAAe;QAAE,OAAO,EAAE,CAAA;IAC/B,MAAM,YAAY,GAA2B,EAAE,CAAA;IAC/C,KAAK,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,eAAe,EAAE,CAAC;QACpD,YAAY,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAA;IAClC,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC"}

package/lib/getOutdatedLockfileSetting.d.ts

@@ -0,0 +1,12 @@
+import { type Lockfile, type PatchFile } from '@pnpm/lockfile.types';
+export type ChangedField = 'patchedDependencies' | 'overrides' | 'packageExtensionsChecksum' | 'ignoredOptionalDependencies' | 'settings.autoInstallPeers' | 'settings.excludeLinksFromLockfile' | 'settings.peersSuffixMaxLength' | 'pnpmfileChecksum';
+export declare function getOutdatedLockfileSetting(lockfile: Lockfile, { overrides, packageExtensionsChecksum, ignoredOptionalDependencies, patchedDependencies, autoInstallPeers, excludeLinksFromLockfile, peersSuffixMaxLength, pnpmfileChecksum, }: {
+    overrides?: Record<string, string>;
+    packageExtensionsChecksum?: string;
+    patchedDependencies?: Record<string, PatchFile>;
+    ignoredOptionalDependencies?: string[];
+    autoInstallPeers?: boolean;
+    excludeLinksFromLockfile?: boolean;
+    peersSuffixMaxLength?: number;
+    pnpmfileChecksum?: string;
+}): ChangedField | null;

package/lib/getOutdatedLockfileSetting.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOutdatedLockfileSetting = getOutdatedLockfileSetting;
+const equals_1 = __importDefault(require("ramda/src/equals"));
+function getOutdatedLockfileSetting(lockfile, { overrides, packageExtensionsChecksum, ignoredOptionalDependencies, patchedDependencies, autoInstallPeers, excludeLinksFromLockfile, peersSuffixMaxLength, pnpmfileChecksum, }) {
+    if (!(0, equals_1.default)(lockfile.overrides ?? {}, overrides ?? {})) {
+        return 'overrides';
+    }
+    if (lockfile.packageExtensionsChecksum !== packageExtensionsChecksum) {
+        return 'packageExtensionsChecksum';
+    }
+    if (!(0, equals_1.default)(lockfile.ignoredOptionalDependencies?.sort() ?? [], ignoredOptionalDependencies?.sort() ?? [])) {
+        return 'ignoredOptionalDependencies';
+    }
+    if (!(0, equals_1.default)(lockfile.patchedDependencies ?? {}, patchedDependencies ?? {})) {
+        return 'patchedDependencies';
+    }
+    if ((lockfile.settings?.autoInstallPeers != null && lockfile.settings.autoInstallPeers !== autoInstallPeers)) {
+        return 'settings.autoInstallPeers';
+    }
+    if (lockfile.settings?.excludeLinksFromLockfile != null && lockfile.settings.excludeLinksFromLockfile !== excludeLinksFromLockfile) {
+        return 'settings.excludeLinksFromLockfile';
+    }
+    if (lockfile.settings?.peersSuffixMaxLength != null && lockfile.settings.peersSuffixMaxLength !== peersSuffixMaxLength ||
+        lockfile.settings?.peersSuffixMaxLength == null && peersSuffixMaxLength !== 1000) {
+        return 'settings.peersSuffixMaxLength';
+    }
+    if (lockfile.pnpmfileChecksum !== pnpmfileChecksum) {
+        return 'pnpmfileChecksum';
+    }
+    return null;
+}
+//# sourceMappingURL=getOutdatedLockfileSetting.js.map

package/lib/getOutdatedLockfileSetting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOutdatedLockfileSetting.js","sourceRoot":"","sources":["../src/getOutdatedLockfileSetting.ts"],"names":[],"mappings":";;;;;AAaA,gEAkDC;AA9DD,8DAAqC;AAYrC,SAAgB,0BAA0B,CACxC,QAAkB,EAClB,EACE,SAAS,EACT,yBAAyB,EACzB,2BAA2B,EAC3B,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACxB,oBAAoB,EACpB,gBAAgB,GAUjB;IAED,IAAI,CAAC,IAAA,gBAAM,EAAC,QAAQ,CAAC,SAAS,IAAI,EAAE,EAAE,SAAS,IAAI,EAAE,CAAC,EAAE,CAAC;QACvD,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,IAAI,QAAQ,CAAC,yBAAyB,KAAK,yBAAyB,EAAE,CAAC;QACrE,OAAO,2BAA2B,CAAA;IACpC,CAAC;IACD,IAAI,CAAC,IAAA,gBAAM,EAAC,QAAQ,CAAC,2BAA2B,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,2BAA2B,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3G,OAAO,6BAA6B,CAAA;IACtC,CAAC;IACD,IAAI,CAAC,IAAA,gBAAM,EAAC,QAAQ,CAAC,mBAAmB,IAAI,EAAE,EAAE,mBAAmB,IAAI,EAAE,CAAC,EAAE,CAAC;QAC3E,OAAO,qBAAqB,CAAA;IAC9B,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,KAAK,gBAAgB,CAAC,EAAE,CAAC;QAC7G,OAAO,2BAA2B,CAAA;IACpC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,EAAE,wBAAwB,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,wBAAwB,KAAK,wBAAwB,EAAE,CAAC;QACnI,OAAO,mCAAmC,CAAA;IAC5C,CAAC;IACD,IACE,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,IAAI,IAAI,IAAI,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,KAAK,oBAAoB;QAClH,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,IAAI,IAAI,IAAI,oBAAoB,KAAK,IAAI,EAChF,CAAC;QACD,OAAO,+BAA+B,CAAA;IACxC,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,KAAK,gBAAgB,EAAE,CAAC;QACnD,OAAO,kBAAkB,CAAA;IAC3B,CAAC;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { calcPatchHashes } from './calcPatchHashes';
+export { createOverridesMapFromParsed } from './createOverridesMapFromParsed';
+export { type ChangedField, getOutdatedLockfileSetting } from './getOutdatedLockfileSetting';

package/lib/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOutdatedLockfileSetting = exports.createOverridesMapFromParsed = exports.calcPatchHashes = void 0;
+var calcPatchHashes_1 = require("./calcPatchHashes");
+Object.defineProperty(exports, "calcPatchHashes", { enumerable: true, get: function () { return calcPatchHashes_1.calcPatchHashes; } });
+var createOverridesMapFromParsed_1 = require("./createOverridesMapFromParsed");
+Object.defineProperty(exports, "createOverridesMapFromParsed", { enumerable: true, get: function () { return createOverridesMapFromParsed_1.createOverridesMapFromParsed; } });
+var getOutdatedLockfileSetting_1 = require("./getOutdatedLockfileSetting");
+Object.defineProperty(exports, "getOutdatedLockfileSetting", { enumerable: true, get: function () { return getOutdatedLockfileSetting_1.getOutdatedLockfileSetting; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAA1C,kHAAA,eAAe,OAAA;AACxB,+EAA6E;AAApE,4IAAA,4BAA4B,OAAA;AACrC,2EAA4F;AAAhE,wIAAA,0BAA0B,OAAA"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@pnpm/lockfile.settings-checker",
+  "version": "1.0.0",
+  "description": "Utilities to check if lockfile settings are out-of-date",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "repository": "https://github.com/pnpm/pnpm/blob/main/lockfile/settings-checker",
+  "keywords": [
+    "pnpm9",
+    "hash",
+    "crypto",
+    "base32"
+  ],
+  "engines": {
+    "node": ">=18.12"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/main/lockfile/settings-checker#readme",
+  "dependencies": {
+    "p-map-values": "^1.0.0",
+    "ramda": "npm:@pnpm/ramda@0.28.1",
+    "sort-keys": "^4.2.0",
+    "@pnpm/lockfile.types": "1.0.3",
+    "@pnpm/crypto.base32-hash": "3.0.0",
+    "@pnpm/parse-overrides": "5.1.1"
+  },
+  "devDependencies": {
+    "@types/ramda": "0.29.12",
+    "@pnpm/prepare": "0.0.103",
+    "@pnpm/lockfile.settings-checker": "1.0.0"
+  },
+  "funding": "https://opencollective.com/pnpm",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\"",
+    "test": "pnpm run compile",
+    "compile": "tsc --build && pnpm run lint --fix"
+  }
+}