@pnpm/assert-project 0.0.0-20230605-20230605142810

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2023 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,28 @@
+# @pnpm/assert-project
+
+> Utils for testing projects that use pnpm
+
+## Installation
+
+```
+pnpm install -D @pnpm/assert-project
+```
+
+## Usage
+
+```ts
+import test = require('tape')
+import { assertProject } from '@pnpm/assert-project'
+
+test('...', async t => {
+  // ...
+  const project = assertProject(t, pathToProject)
+
+  await project.has('foo')
+  // Test fails if project has no foo in node_modules
+})
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,34 @@
+import { type LockfileV6 as Lockfile, type ProjectSnapshotV6 as ProjectSnapshot } from '@pnpm/lockfile-types';
+import { type Modules } from '@pnpm/modules-yaml';
+import isExecutable from './isExecutable';
+export { isExecutable, type Modules };
+export type RawLockfile = Lockfile & Partial<ProjectSnapshot>;
+export interface Project {
+    requireModule: (moduleName: string) => any;
+    dir: () => string;
+    has: (pkgName: string, modulesDir?: string) => Promise<void>;
+    hasNot: (pkgName: string, modulesDir?: string) => Promise<void>;
+    getStorePath: () => Promise<string>;
+    resolve: (pkgName: string, version?: string, relativePath?: string) => Promise<string>;
+    getPkgIndexFilePath: (pkgName: string, version?: string) => Promise<string>;
+    cafsHas: (pkgName: string, version?: string) => Promise<void>;
+    cafsHasNot: (pkgName: string, version?: string) => Promise<void>;
+    storeHas: (pkgName: string, version?: string) => Promise<string>;
+    storeHasNot: (pkgName: string, version?: string) => Promise<void>;
+    isExecutable: (pathToExe: string) => Promise<void>;
+    /**
+     * TODO: Remove the `Required<T>` cast.
+     *
+     * https://github.com/microsoft/TypeScript/pull/32695 might help with this.
+     */
+    readCurrentLockfile: () => Promise<Required<RawLockfile>>;
+    readModulesManifest: () => Promise<Modules | null>;
+    /**
+     * TODO: Remove the `Required<T>` cast.
+     *
+     * https://github.com/microsoft/TypeScript/pull/32695 might help with this.
+     */
+    readLockfile: (lockfileName?: string) => Promise<Required<RawLockfile>>;
+    writePackageJson: (pkgJson: object) => Promise<void>;
+}
+export declare function assertProject(projectPath: string, encodedRegistryName?: string): Project;

package/lib/index.js

@@ -0,0 +1,126 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertProject = exports.isExecutable = void 0;
+const path_1 = __importDefault(require("path"));
+const assert_store_1 = require("@pnpm/assert-store");
+const constants_1 = require("@pnpm/constants");
+const modules_yaml_1 = require("@pnpm/modules-yaml");
+const registry_mock_1 = require("@pnpm/registry-mock");
+const read_yaml_file_1 = __importDefault(require("read-yaml-file"));
+const path_exists_1 = __importDefault(require("path-exists"));
+const write_pkg_1 = __importDefault(require("write-pkg"));
+const isExecutable_1 = __importDefault(require("./isExecutable"));
+exports.isExecutable = isExecutable_1.default;
+function assertProject(projectPath, encodedRegistryName) {
+    const ern = encodedRegistryName ?? `localhost+${registry_mock_1.REGISTRY_MOCK_PORT}`;
+    const modules = path_1.default.join(projectPath, 'node_modules');
+    let cachedStore;
+    async function getStoreInstance() {
+        if (!cachedStore) {
+            const modulesYaml = await (0, modules_yaml_1.readModulesManifest)(modules);
+            if (modulesYaml == null) {
+                throw new Error(`Cannot find module store. No .modules.yaml found at "${modules}"`);
+            }
+            const storePath = modulesYaml.storeDir;
+            cachedStore = {
+                storePath,
+                ...(0, assert_store_1.assertStore)(storePath, ern),
+            };
+        }
+        return cachedStore;
+    }
+    async function getVirtualStoreDir() {
+        const modulesYaml = await (0, modules_yaml_1.readModulesManifest)(modules);
+        if (modulesYaml == null) {
+            return path_1.default.join(modules, '.pnpm');
+        }
+        return modulesYaml.virtualStoreDir;
+    }
+    // eslint-disable-next-line
+    const ok = (value) => expect(value).toBeTruthy();
+    // eslint-disable-next-line
+    const notOk = (value) => expect(value).toBeFalsy();
+    return {
+        dir: () => projectPath,
+        requireModule(pkgName) {
+            // eslint-disable-next-line
+            return require(path_1.default.join(modules, pkgName));
+        },
+        async has(pkgName, _modulesDir) {
+            const md = _modulesDir ? path_1.default.join(projectPath, _modulesDir) : modules;
+            ok(await (0, path_exists_1.default)(path_1.default.join(md, pkgName)));
+        },
+        async hasNot(pkgName, _modulesDir) {
+            const md = _modulesDir ? path_1.default.join(projectPath, _modulesDir) : modules;
+            notOk(await (0, path_exists_1.default)(path_1.default.join(md, pkgName)));
+        },
+        async getStorePath() {
+            const store = await getStoreInstance();
+            return store.storePath;
+        },
+        async resolve(pkgName, version, relativePath) {
+            const store = await getStoreInstance();
+            return store.resolve(pkgName, version, relativePath);
+        },
+        async getPkgIndexFilePath(pkgName, version) {
+            const store = await getStoreInstance();
+            return store.getPkgIndexFilePath(pkgName, version);
+        },
+        async cafsHas(pkgName, version) {
+            const store = await getStoreInstance();
+            return store.cafsHas(pkgName, version);
+        },
+        async cafsHasNot(pkgName, version) {
+            const store = await getStoreInstance();
+            return store.cafsHasNot(pkgName, version);
+        },
+        async storeHas(pkgName, version) {
+            const store = await getStoreInstance();
+            return store.resolve(pkgName, version);
+        },
+        async storeHasNot(pkgName, version) {
+            try {
+                const store = await getStoreInstance();
+                return store.storeHasNot(pkgName, version);
+            }
+            catch (err) { // eslint-disable-line
+                if (err.message.startsWith('Cannot find module store')) {
+                    return;
+                }
+                throw err;
+            }
+        },
+        async isExecutable(pathToExe) {
+            return (0, isExecutable_1.default)(ok, path_1.default.join(modules, pathToExe));
+        },
+        async readCurrentLockfile() {
+            try {
+                return await (0, read_yaml_file_1.default)(path_1.default.join(await getVirtualStoreDir(), 'lock.yaml'));
+            }
+            catch (err) { // eslint-disable-line
+                if (err.code === 'ENOENT')
+                    return null;
+                throw err;
+            }
+        },
+        readModulesManifest: async () => (0, modules_yaml_1.readModulesManifest)(modules),
+        async readLockfile(lockfileName = constants_1.WANTED_LOCKFILE) {
+            try {
+                return await (0, read_yaml_file_1.default)(path_1.default.join(projectPath, lockfileName));
+            }
+            catch (err) { // eslint-disable-line
+                if (err.code === 'ENOENT')
+                    return null;
+                throw err;
+            }
+        },
+        async writePackageJson(pkgJson) {
+            return (0, write_pkg_1.default)(projectPath, pkgJson); // eslint-disable-line
+        },
+    };
+}
+exports.assertProject = assertProject;
+//# 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,gDAAuB;AACvB,qDAAgD;AAChD,+CAAiD;AAEjD,qDAAsE;AACtE,uDAAwD;AACxD,oEAAyC;AACzC,8DAAgC;AAChC,0DAAgC;AAChC,kEAAyC;AAEhC,uBAFF,sBAAY,CAEE;AAkCrB,SAAgB,aAAa,CAAE,WAAmB,EAAE,mBAA4B;IAC9E,MAAM,GAAG,GAAG,mBAAmB,IAAI,aAAa,kCAAkB,EAAE,CAAA;IACpE,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAA;IAEtD,IAAI,WAQH,CAAA;IACD,KAAK,UAAU,gBAAgB;QAC7B,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,WAAW,GAAG,MAAM,IAAA,kCAAmB,EAAC,OAAO,CAAC,CAAA;YACtD,IAAI,WAAW,IAAI,IAAI,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,wDAAwD,OAAO,GAAG,CAAC,CAAA;aACpF;YACD,MAAM,SAAS,GAAG,WAAW,CAAC,QAAQ,CAAA;YACtC,WAAW,GAAG;gBACZ,SAAS;gBACT,GAAG,IAAA,0BAAW,EAAC,SAAS,EAAE,GAAG,CAAC;aAC/B,CAAA;SACF;QACD,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,KAAK,UAAU,kBAAkB;QAC/B,MAAM,WAAW,GAAG,MAAM,IAAA,kCAAmB,EAAC,OAAO,CAAC,CAAA;QACtD,IAAI,WAAW,IAAI,IAAI,EAAE;YACvB,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;SACnC;QACD,OAAO,WAAW,CAAC,eAAe,CAAA;IACpC,CAAC;IAED,2BAA2B;IAC3B,MAAM,EAAE,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAA;IACrD,2BAA2B;IAC3B,MAAM,KAAK,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,CAAA;IACvD,OAAO;QACL,GAAG,EAAE,GAAG,EAAE,CAAC,WAAW;QACtB,aAAa,CAAE,OAAe;YAC5B,2BAA2B;YAC3B,OAAO,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;QAC7C,CAAC;QACD,KAAK,CAAC,GAAG,CAAE,OAAe,EAAE,WAAoB;YAC9C,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;YACtE,EAAE,CAAC,MAAM,IAAA,qBAAM,EAAC,cAAI,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC1C,CAAC;QACD,KAAK,CAAC,MAAM,CAAE,OAAe,EAAE,WAAoB;YACjD,MAAM,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;YACtE,KAAK,CAAC,MAAM,IAAA,qBAAM,EAAC,cAAI,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;QAC7C,CAAC;QACD,KAAK,CAAC,YAAY;YAChB,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,SAAS,CAAA;QACxB,CAAC;QACD,KAAK,CAAC,OAAO,CAAE,OAAe,EAAE,OAAgB,EAAE,YAAqB;YACrE,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,CAAC,CAAA;QACtD,CAAC;QACD,KAAK,CAAC,mBAAmB,CAAE,OAAe,EAAE,OAAgB;YAC1D,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACpD,CAAC;QACD,KAAK,CAAC,OAAO,CAAE,OAAe,EAAE,OAAgB;YAC9C,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACxC,CAAC;QACD,KAAK,CAAC,UAAU,CAAE,OAAe,EAAE,OAAgB;YACjD,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QAC3C,CAAC;QACD,KAAK,CAAC,QAAQ,CAAE,OAAe,EAAE,OAAgB;YAC/C,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;YACtC,OAAO,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACxC,CAAC;QACD,KAAK,CAAC,WAAW,CAAE,OAAe,EAAE,OAAgB;YAClD,IAAI;gBACF,MAAM,KAAK,GAAG,MAAM,gBAAgB,EAAE,CAAA;gBACtC,OAAO,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;aAC3C;YAAC,OAAO,GAAQ,EAAE,EAAE,sBAAsB;gBACzC,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,0BAA0B,CAAC,EAAE;oBACtD,OAAM;iBACP;gBACD,MAAM,GAAG,CAAA;aACV;QACH,CAAC;QACD,KAAK,CAAC,YAAY,CAAE,SAAiB;YACnC,OAAO,IAAA,sBAAY,EAAC,EAAE,EAAE,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;QACxD,CAAC;QACD,KAAK,CAAC,mBAAmB;YACvB,IAAI;gBACF,OAAO,MAAM,IAAA,wBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,EAAE,WAAW,CAAC,CAAC,CAAA;aAC9E;YAAC,OAAO,GAAQ,EAAE,EAAE,sBAAsB;gBACzC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;oBAAE,OAAO,IAAK,CAAA;gBACvC,MAAM,GAAG,CAAA;aACV;QACH,CAAC;QACD,mBAAmB,EAAE,KAAK,IAAI,EAAE,CAAC,IAAA,kCAAmB,EAAC,OAAO,CAAC;QAC7D,KAAK,CAAC,YAAY,CAAE,eAAuB,2BAAe;YACxD,IAAI;gBACF,OAAO,MAAM,IAAA,wBAAY,EAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,CAAA;aAChE;YAAC,OAAO,GAAQ,EAAE,EAAE,sBAAsB;gBACzC,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ;oBAAE,OAAO,IAAK,CAAA;gBACvC,MAAM,GAAG,CAAA;aACV;QACH,CAAC;QACD,KAAK,CAAC,gBAAgB,CAAE,OAAe;YACrC,OAAO,IAAA,mBAAQ,EAAC,WAAW,EAAE,OAAc,CAAC,CAAA,CAAC,sBAAsB;QACrE,CAAC;KACF,CAAA;AACH,CAAC;AAhHD,sCAgHC"}

package/lib/isExecutable.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (ok: (value: any, comment: string) => void, filePath: string) => Promise<void>;
+export default _default;

package/lib/isExecutable.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = require("fs");
+const util_1 = require("util");
+const is_windows_1 = __importDefault(require("is-windows"));
+const isexe_1 = __importDefault(require("isexe"));
+const IS_WINDOWS = (0, is_windows_1.default)();
+const isexe = (0, util_1.promisify)(isexe_1.default);
+// eslint-disable-next-line
+exports.default = async (ok, filePath) => {
+    if (IS_WINDOWS) {
+        ok(await isexe(`${filePath}.cmd`), `${filePath}.cmd is executable`);
+        return;
+    }
+    const stat = await fs_1.promises.stat(filePath);
+    ok((stat.mode & 0o111) === 0o111, `${filePath} is executable`);
+    ok(stat.isFile(), `${filePath} refers to a file`);
+};
+//# sourceMappingURL=isExecutable.js.map

package/lib/isExecutable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isExecutable.js","sourceRoot":"","sources":["../src/isExecutable.ts"],"names":[],"mappings":";;;;;AAAA,2BAAmC;AACnC,+BAAgC;AAChC,4DAAkC;AAClC,kDAA2B;AAE3B,MAAM,UAAU,GAAG,IAAA,oBAAS,GAAE,CAAA;AAC9B,MAAM,KAAK,GAAG,IAAA,gBAAS,EAAC,eAAO,CAAC,CAAA;AAEhC,2BAA2B;AAC3B,kBAAe,KAAK,EAAE,EAAyC,EAAE,QAAgB,EAAE,EAAE;IACnF,IAAI,UAAU,EAAE;QACd,EAAE,CAAC,MAAM,KAAK,CAAC,GAAG,QAAQ,MAAM,CAAC,EAAE,GAAG,QAAQ,oBAAoB,CAAC,CAAA;QACnE,OAAM;KACP;IAED,MAAM,IAAI,GAAG,MAAM,aAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IACpC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,KAAK,EAAE,GAAG,QAAQ,gBAAgB,CAAC,CAAA;IAC9D,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,GAAG,QAAQ,mBAAmB,CAAC,CAAA;AACnD,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@pnpm/assert-project",
+  "description": "Utils for testing projects that use pnpm",
+  "version": "0.0.0-20230605-20230605142810",
+  "author": {
+    "name": "Zoltan Kochan",
+    "email": "z@kochan.io",
+    "url": "https://www.kochan.io/"
+  },
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/"
+  ],
+  "devDependencies": {
+    "@types/is-windows": "^1.0.0",
+    "@types/isexe": "2.0.1",
+    "@types/node": "^14.18.48",
+    "@pnpm/assert-project": "0.0.0-20230605-20230605142810"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/master/privatePackages/assert-project#readme",
+  "keywords": [],
+  "license": "MIT",
+  "engines": {
+    "node": ">=10"
+  },
+  "repository": "https://github.com/pnpm/pnpm/blob/master/privatePackages/assert-project",
+  "dependencies": {
+    "@pnpm/registry-mock": "3.8.0",
+    "is-windows": "^1.0.2",
+    "isexe": "2.0.0",
+    "path-exists": "^4.0.0",
+    "read-yaml-file": "^2.1.0",
+    "write-pkg": "4.0.0",
+    "@pnpm/modules-yaml": "12.1.1",
+    "@pnpm/constants": "0.0.0-20230605-20230605142810",
+    "@pnpm/lockfile-types": "5.1.0",
+    "@pnpm/types": "9.1.0",
+    "@pnpm/assert-store": "1.0.61"
+  },
+  "scripts": {
+    "lint": "eslint src/**/*.ts test/**/*.ts",
+    "lint-test": "tslint -c tslint.json --project test",
+    "compile": "rimraf tsconfig.tsbuildinfo lib && tsc --build",
+    "pretest": "pnpm install -C test/fixture/project --force --no-shared-workspace-lockfile",
+    "test": "pnpm pretest && pnpm run compile && jest"
+  }
+}