@pnpm/fetching.git-fetcher 1003.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-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/git-fetcher
+
+> Fetcher for git-hosted packages
+
+[![npm version](https://img.shields.io/npm/v/@pnpm/git-fetcher.svg)](https://www.npmjs.com/package/@pnpm/git-fetcher)
+
+## Installation
+
+```
+pnpm add @pnpm/git-fetcher
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+import type { GitFetcher } from '@pnpm/fetching.fetcher-base';
+import type { StoreIndex } from '@pnpm/store.index';
+export interface CreateGitFetcherOptions {
+    gitShallowHosts?: string[];
+    rawConfig: Record<string, unknown>;
+    storeIndex: StoreIndex;
+    unsafePerm?: boolean;
+    ignoreScripts?: boolean;
+}
+export declare function createGitFetcher(createOpts: CreateGitFetcherOptions): {
+    git: GitFetcher;
+};

package/lib/index.js

@@ -0,0 +1,88 @@
+import assert from 'node:assert';
+import path from 'node:path';
+import { URL } from 'node:url';
+import util from 'node:util';
+import { PnpmError } from '@pnpm/error';
+import { preparePackage } from '@pnpm/exec.prepare-package';
+import { packlist } from '@pnpm/fs.packlist';
+import { globalWarn } from '@pnpm/logger';
+import { addFilesFromDir } from '@pnpm/worker';
+import { rimraf } from '@zkochan/rimraf';
+import { safeExeca as execa } from 'execa';
+export function createGitFetcher(createOpts) {
+    const allowedHosts = new Set(createOpts?.gitShallowHosts ?? []);
+    const ignoreScripts = createOpts.ignoreScripts ?? false;
+    const gitFetcher = async (cafs, resolution, opts) => {
+        const tempLocation = await cafs.tempDir();
+        if (allowedHosts.size > 0 && shouldUseShallow(resolution.repo, allowedHosts)) {
+            await execGit(['init'], { cwd: tempLocation });
+            await execGit(['remote', 'add', 'origin', resolution.repo], { cwd: tempLocation });
+            await execGit(['fetch', '--depth', '1', 'origin', resolution.commit], { cwd: tempLocation });
+        }
+        else {
+            await execGit(['clone', resolution.repo, tempLocation]);
+        }
+        await execGit(['checkout', resolution.commit], { cwd: tempLocation });
+        const receivedCommit = await execGit(['rev-parse', 'HEAD'], { cwd: tempLocation });
+        if (receivedCommit.trim() !== resolution.commit) {
+            throw new PnpmError('GIT_CHECKOUT_FAILED', `received commit ${receivedCommit.trim()} does not match expected value ${resolution.commit}`);
+        }
+        let pkgDir;
+        try {
+            const prepareResult = await preparePackage({
+                allowBuild: opts.allowBuild,
+                ignoreScripts: createOpts.ignoreScripts,
+                rawConfig: createOpts.rawConfig,
+                unsafePerm: createOpts.unsafePerm,
+            }, tempLocation, resolution.path ?? '');
+            pkgDir = prepareResult.pkgDir;
+            if (ignoreScripts && prepareResult.shouldBeBuilt) {
+                globalWarn(`The git-hosted package fetched from "${resolution.repo}" has to be built but the build scripts were ignored.`);
+            }
+        }
+        catch (err) {
+            assert(util.types.isNativeError(err));
+            err.message = `Failed to prepare git-hosted package fetched from "${resolution.repo}": ${err.message}`;
+            throw err;
+        }
+        // removing /.git to make directory integrity calculation faster
+        await rimraf(path.join(tempLocation, '.git'));
+        const files = await packlist(pkgDir);
+        // Important! We cannot remove the temp location at this stage.
+        // Even though we have the index of the package,
+        // the linking of files to the store is in progress.
+        return addFilesFromDir({
+            storeDir: cafs.storeDir,
+            storeIndex: createOpts.storeIndex,
+            dir: pkgDir,
+            files,
+            filesIndexFile: opts.filesIndexFile,
+            readManifest: opts.readManifest,
+            pkg: opts.pkg,
+        });
+    };
+    return {
+        git: gitFetcher,
+    };
+}
+function shouldUseShallow(repoUrl, allowedHosts) {
+    try {
+        const { host } = new URL(repoUrl);
+        if (allowedHosts.has(host)) {
+            return true;
+        }
+    }
+    catch {
+        // URL might be malformed
+    }
+    return false;
+}
+function prefixGitArgs() {
+    return process.platform === 'win32' ? ['-c', 'core.longpaths=true'] : [];
+}
+async function execGit(args, opts) {
+    const fullArgs = prefixGitArgs().concat(args || []);
+    const { stdout } = await execa('git', fullArgs, opts);
+    return stdout;
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@pnpm/fetching.git-fetcher",
+  "version": "1003.0.0",
+  "description": "A fetcher for git-hosted packages",
+  "keywords": [
+    "pnpm",
+    "pnpm11",
+    "fetcher"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/fetching/git-fetcher",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/fetching/git-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": {
+    "@zkochan/rimraf": "^4.0.0",
+    "execa": "npm:safe-execa@0.3.0",
+    "@pnpm/error": "1000.0.5",
+    "@pnpm/exec.prepare-package": "1000.0.26",
+    "@pnpm/store.index": "1000.0.0-0",
+    "@pnpm/fetching.fetcher-base": "1001.0.2",
+    "@pnpm/fs.packlist": "1000.0.0"
+  },
+  "peerDependencies": {
+    "@pnpm/logger": ">=1001.0.0 <1002.0.0",
+    "@pnpm/worker": "^1000.3.0"
+  },
+  "devDependencies": {
+    "@jest/globals": "30.0.5",
+    "@pnpm/util.lex-comparator": "^3.0.2",
+    "tempy": "3.0.0",
+    "@pnpm/fetching.git-fetcher": "1003.0.0",
+    "@pnpm/logger": "1001.0.1",
+    "@pnpm/store.cafs": "1000.0.19",
+    "@pnpm/store.create-cafs-store": "1000.0.20",
+    "@pnpm/types": "1000.9.0"
+  },
+  "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"
+  }
+}