@pnpm/installing.modules-yaml 1000.3.6

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,45 @@
+# @pnpm/modules-yaml
+
+> Reads/writes \`node_modules/.modules.yaml\`
+
+<!--@shields('npm')-->
+[![npm version](https://img.shields.io/npm/v/@pnpm/modules-yaml.svg)](https://www.npmjs.com/package/@pnpm/modules-yaml)
+<!--/@-->
+
+## Installation
+
+```sh
+pnpm add @pnpm/modules-yaml
+```
+
+## Usage
+
+```ts
+import {write, read} from '@pnpm/modules-yaml'
+
+await write('node_modules', {
+  hoistedAliases: {},
+  layoutVersion: 1,
+  packageManager: 'pnpm@1.0.0',
+  pendingBuilds: [],
+  shamefullyFlatten: false,
+  skipped: [],
+  storeDir: '/home/user/.pnpm-store',
+})
+
+const modulesYaml = await read(`node_modules`)
+```
+
+## API
+
+### `read(pathToDir): Promise<ModulesObject>`
+
+Reads `.modules.yaml` from the specified directory.
+
+### `write(pathToDir, ModulesObject): Promise<void>`
+
+Writes a `.modules.yaml` file to the specified directory.
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,37 @@
+import type { DependenciesField, DepPath, HoistedDependencies, IgnoredBuilds, Registries } from '@pnpm/types';
+export type IncludedDependencies = {
+    [dependenciesField in DependenciesField]: boolean;
+};
+interface ModulesRaw {
+    hoistedAliases?: {
+        [depPath: DepPath]: string[];
+    };
+    hoistedDependencies: HoistedDependencies;
+    hoistPattern?: string[];
+    included: IncludedDependencies;
+    layoutVersion: number;
+    nodeLinker?: 'hoisted' | 'isolated' | 'pnp';
+    packageManager: string;
+    pendingBuilds: string[];
+    ignoredBuilds?: DepPath[];
+    prunedAt: string;
+    registries?: Registries;
+    shamefullyHoist?: boolean;
+    publicHoistPattern?: string[];
+    skipped: string[];
+    storeDir: string;
+    virtualStoreDir: string;
+    virtualStoreDirMaxLength: number;
+    injectedDeps?: Record<string, string[]>;
+    hoistedLocations?: Record<string, string[]>;
+    allowBuilds?: Record<string, boolean | string>;
+}
+export type Modules = Omit<ModulesRaw, 'ignoredBuilds'> & {
+    ignoredBuilds?: IgnoredBuilds;
+};
+export declare function readModulesManifest(modulesDir: string): Promise<Modules | null>;
+export interface StrictModules extends Modules {
+    registries: Registries;
+}
+export declare function writeModulesManifest(modulesDir: string, modules: StrictModules): Promise<void>;
+export {};

package/lib/index.js

@@ -0,0 +1,90 @@
+import path from 'node:path';
+import fs from '@pnpm/fs.graceful-fs';
+import isWindows from 'is-windows';
+import { map as mapValues } from 'ramda';
+import { readYamlFile } from 'read-yaml-file';
+// The dot prefix is needed because otherwise `npm shrinkwrap`
+// thinks that it is an extraneous package.
+const MODULES_FILENAME = '.modules.yaml';
+export async function readModulesManifest(modulesDir) {
+    const modulesYamlPath = path.join(modulesDir, MODULES_FILENAME);
+    let modulesRaw;
+    try {
+        modulesRaw = await readYamlFile(modulesYamlPath);
+        if (!modulesRaw)
+            return modulesRaw;
+    }
+    catch (err) { // eslint-disable-line
+        if (err.code !== 'ENOENT') {
+            throw err;
+        }
+        return null;
+    }
+    const modules = {
+        ...modulesRaw,
+        ignoredBuilds: modulesRaw.ignoredBuilds ? new Set(modulesRaw.ignoredBuilds) : undefined,
+    };
+    if (!modules.virtualStoreDir) {
+        modules.virtualStoreDir = path.join(modulesDir, '.pnpm');
+    }
+    else if (!path.isAbsolute(modules.virtualStoreDir)) {
+        modules.virtualStoreDir = path.join(modulesDir, modules.virtualStoreDir);
+    }
+    switch (modules.shamefullyHoist) {
+        case true:
+            if (modules.publicHoistPattern == null) {
+                modules.publicHoistPattern = ['*'];
+            }
+            if ((modules.hoistedAliases != null) && !modules.hoistedDependencies) {
+                modules.hoistedDependencies = mapValues((aliases) => Object.fromEntries(aliases.map((alias) => [alias, 'public'])), modules.hoistedAliases);
+            }
+            break;
+        case false:
+            if (modules.publicHoistPattern == null) {
+                modules.publicHoistPattern = [];
+            }
+            if ((modules.hoistedAliases != null) && !modules.hoistedDependencies) {
+                modules.hoistedDependencies = {};
+                for (const depPath of Object.keys(modules.hoistedAliases)) {
+                    modules.hoistedDependencies[depPath] = {};
+                    for (const alias of modules.hoistedAliases[depPath]) {
+                        modules.hoistedDependencies[depPath][alias] = 'private';
+                    }
+                }
+            }
+            break;
+    }
+    if (!modules.prunedAt) {
+        modules.prunedAt = new Date().toUTCString();
+    }
+    if (!modules.virtualStoreDirMaxLength) {
+        modules.virtualStoreDirMaxLength = 120;
+    }
+    return modules;
+}
+export async function writeModulesManifest(modulesDir, modules) {
+    const modulesYamlPath = path.join(modulesDir, MODULES_FILENAME);
+    const saveModules = { ...modules, ignoredBuilds: modules.ignoredBuilds ? Array.from(modules.ignoredBuilds) : undefined };
+    if (saveModules.skipped)
+        saveModules.skipped.sort();
+    if (saveModules.hoistPattern == null || saveModules.hoistPattern === '') {
+        // Because the YAML writer fails on undefined fields
+        delete saveModules.hoistPattern;
+    }
+    if (saveModules.publicHoistPattern == null) {
+        delete saveModules.publicHoistPattern;
+    }
+    if ((saveModules.hoistedAliases == null) || (saveModules.hoistPattern == null) && (saveModules.publicHoistPattern == null)) {
+        delete saveModules.hoistedAliases;
+    }
+    // We should store the absolute virtual store directory path on Windows
+    // because junctions are used on Windows. Junctions will break even if
+    // the relative path to the virtual store remains the same after moving
+    // a project.
+    if (!isWindows()) {
+        saveModules.virtualStoreDir = path.relative(modulesDir, saveModules.virtualStoreDir);
+    }
+    await fs.mkdir(modulesDir, { recursive: true });
+    await fs.writeFile(modulesYamlPath, JSON.stringify(saveModules, null, 2));
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@pnpm/installing.modules-yaml",
+  "version": "1000.3.6",
+  "description": "Reads/writes `node_modules/.modules.yaml`",
+  "keywords": [
+    "pnpm",
+    "pnpm11",
+    "modules.yaml"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/installing/modules-yaml",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/installing/modules-yaml#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": {
+    "is-windows": "^1.0.2",
+    "ramda": "npm:@pnpm/ramda@0.28.1",
+    "read-yaml-file": "^3.0.0",
+    "@pnpm/types": "1000.9.0",
+    "@pnpm/fs.graceful-fs": "1000.0.1"
+  },
+  "devDependencies": {
+    "@types/is-windows": "^1.0.2",
+    "@types/ramda": "0.29.12",
+    "tempy": "3.0.0",
+    "@pnpm/installing.modules-yaml": "1000.3.6"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "_test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules --disable-warning=ExperimentalWarning --disable-warning=DEP0169\" jest",
+    "test": "pnpm run compile && pnpm run _test",
+    "fix": "tslint -c tslint.json src/**/*.ts test/**/*.ts --fix",
+    "compile": "tsgo --build && pnpm run lint --fix"
+  }
+}