@pnpm/fetching.directory-fetcher 1000.1.14

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2026 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,15 @@
+# @pnpm/directory-fetcher
+
+> Fetcher for local directory packages
+
+[![npm version](https://img.shields.io/npm/v/@pnpm/directory-fetcher.svg)](https://www.npmjs.com/package/@pnpm/directory-fetcher)
+
+## Installation
+
+```
+pnpm add @pnpm/directory-fetcher
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,21 @@
+import { type Stats } from 'node:fs';
+import type { DirectoryFetcher, DirectoryFetcherOptions } from '@pnpm/fetching.fetcher-base';
+import type { FilesMap } from '@pnpm/store.cafs-types';
+import type { DependencyManifest } from '@pnpm/types';
+export interface CreateDirectoryFetcherOptions {
+    includeOnlyPackageFiles?: boolean;
+    resolveSymlinks?: boolean;
+}
+export declare function createDirectoryFetcher(opts?: CreateDirectoryFetcherOptions): {
+    directory: DirectoryFetcher;
+};
+export type FetchFromDirOptions = Omit<DirectoryFetcherOptions, 'lockfileDir'> & CreateDirectoryFetcherOptions;
+export interface FetchResult {
+    local: true;
+    filesMap: FilesMap;
+    filesStats?: Record<string, Stats | null>;
+    packageImportMethod: 'hardlink';
+    manifest: DependencyManifest;
+    requiresBuild: boolean;
+}
+export declare function fetchFromDir(dir: string, opts: FetchFromDirOptions): Promise<FetchResult>;

package/lib/index.js

@@ -0,0 +1,120 @@
+import { promises as fs } from 'node:fs';
+import path from 'node:path';
+import util from 'node:util';
+import { pkgRequiresBuild } from '@pnpm/building.pkg-requires-build';
+import { packlist } from '@pnpm/fs.packlist';
+import { logger } from '@pnpm/logger';
+import { safeReadProjectManifestOnly } from '@pnpm/workspace.project-manifest-reader';
+const directoryFetcherLogger = logger('directory-fetcher');
+export function createDirectoryFetcher(opts) {
+    const readFileStat = opts?.resolveSymlinks === true ? realFileStat : fileStat;
+    const fetchFromDir = opts?.includeOnlyPackageFiles ? fetchPackageFilesFromDir : fetchAllFilesFromDir.bind(null, readFileStat);
+    const directoryFetcher = (cafs, resolution, opts) => {
+        const dir = path.join(opts.lockfileDir, resolution.directory);
+        return fetchFromDir(dir);
+    };
+    return {
+        directory: directoryFetcher,
+    };
+}
+export async function fetchFromDir(dir, opts) {
+    if (opts.includeOnlyPackageFiles) {
+        return fetchPackageFilesFromDir(dir);
+    }
+    const readFileStat = opts?.resolveSymlinks === true ? realFileStat : fileStat;
+    return fetchAllFilesFromDir(readFileStat, dir);
+}
+async function fetchAllFilesFromDir(readFileStat, dir) {
+    const { filesMap, filesStats } = await _fetchAllFilesFromDir(readFileStat, dir);
+    // In a regular pnpm workspace it will probably never happen that a dependency has no package.json file.
+    // Safe read was added to support the Bit workspace in which the components have no package.json files.
+    // Related PR in Bit: https://github.com/teambit/bit/pull/5251
+    const manifest = await safeReadProjectManifestOnly(dir) ?? undefined;
+    const requiresBuild = pkgRequiresBuild(manifest, filesMap);
+    return {
+        local: true,
+        filesMap,
+        filesStats,
+        packageImportMethod: 'hardlink',
+        manifest,
+        requiresBuild,
+    };
+}
+async function _fetchAllFilesFromDir(readFileStat, dir, relativeDir = '') {
+    const filesMap = new Map();
+    const filesStats = {};
+    const files = await fs.readdir(dir);
+    await Promise.all(files
+        .filter((file) => file !== 'node_modules')
+        .map(async (file) => {
+        const fileStatResult = await readFileStat(path.join(dir, file));
+        if (!fileStatResult)
+            return;
+        const { filePath, stat } = fileStatResult;
+        const relativeSubdir = `${relativeDir}${relativeDir ? '/' : ''}${file}`;
+        if (stat.isDirectory()) {
+            const subFetchResult = await _fetchAllFilesFromDir(readFileStat, filePath, relativeSubdir);
+            for (const [key, value] of subFetchResult.filesMap) {
+                filesMap.set(key, value);
+            }
+            Object.assign(filesStats, subFetchResult.filesStats);
+        }
+        else {
+            filesMap.set(relativeSubdir, filePath);
+            filesStats[relativeSubdir] = fileStatResult.stat;
+        }
+    }));
+    return { filesMap, filesStats };
+}
+async function realFileStat(filePath) {
+    let stat = await fs.lstat(filePath);
+    if (!stat.isSymbolicLink()) {
+        return { filePath, stat };
+    }
+    try {
+        filePath = await fs.realpath(filePath);
+        stat = await fs.stat(filePath);
+        return { filePath, stat };
+    }
+    catch (err) {
+        // Broken symlinks are skipped
+        if (util.types.isNativeError(err) && 'code' in err && err.code === 'ENOENT') {
+            directoryFetcherLogger.debug({ brokenSymlink: filePath });
+            return null;
+        }
+        throw err;
+    }
+}
+async function fileStat(filePath) {
+    try {
+        return {
+            filePath,
+            stat: await fs.stat(filePath),
+        };
+    }
+    catch (err) {
+        // Broken symlinks are skipped
+        if (util.types.isNativeError(err) && 'code' in err && err.code === 'ENOENT') {
+            directoryFetcherLogger.debug({ brokenSymlink: filePath });
+            return null;
+        }
+        throw err;
+    }
+}
+async function fetchPackageFilesFromDir(dir) {
+    const files = await packlist(dir);
+    const filesMap = new Map(files.map((file) => [file, path.join(dir, file)]));
+    // In a regular pnpm workspace it will probably never happen that a dependency has no package.json file.
+    // Safe read was added to support the Bit workspace in which the components have no package.json files.
+    // Related PR in Bit: https://github.com/teambit/bit/pull/5251
+    const manifest = await safeReadProjectManifestOnly(dir) ?? undefined;
+    const requiresBuild = pkgRequiresBuild(manifest, filesMap);
+    return {
+        local: true,
+        filesMap,
+        packageImportMethod: 'hardlink',
+        manifest,
+        requiresBuild,
+    };
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@pnpm/fetching.directory-fetcher",
+  "version": "1000.1.14",
+  "description": "A fetcher for local directory packages",
+  "keywords": [
+    "pnpm",
+    "pnpm11",
+    "fetcher"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/fetching/directory-fetcher",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/fetching/directory-fetcher#readme",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "dependencies": {
+    "@pnpm/building.pkg-requires-build": "1000.0.0-0",
+    "@pnpm/fetching.fetcher-base": "1001.0.2",
+    "@pnpm/fs.packlist": "1000.0.0",
+    "@pnpm/resolving.resolver-base": "1005.1.0",
+    "@pnpm/store.cafs-types": "1000.0.0",
+    "@pnpm/types": "1000.9.0",
+    "@pnpm/workspace.project-manifest-reader": "1001.1.4"
+  },
+  "peerDependencies": {
+    "@pnpm/logger": ">=1001.0.0 <1002.0.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "30.0.5",
+    "@pnpm/util.lex-comparator": "^3.0.2",
+    "@zkochan/rimraf": "^4.0.0",
+    "@pnpm/fetching.directory-fetcher": "1000.1.14",
+    "@pnpm/test-fixtures": "1000.0.0",
+    "@pnpm/logger": "1001.0.1"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "_test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules --disable-warning=ExperimentalWarning --disable-warning=DEP0169\" jest",
+    "test": "pnpm run compile && pnpm run _test",
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "compile": "tsgo --build && pnpm run lint --fix"
+  }
+}