@pnpm/workspace.workspace-manifest-writer 1001.0.3

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,13 @@
+# @pnpm/workspace.workspace-manifest-writer
+
+> Updates the workspace manifest file
+
+## Install
+
+```
+pnpm add @pnpm/workspace.workspace-manifest-writer
+```
+
+## LICENSE
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,19 @@
+import type { Catalogs } from '@pnpm/catalogs.types';
+import { type GLOBAL_CONFIG_YAML_FILENAME, WORKSPACE_MANIFEST_FILENAME } from '@pnpm/constants';
+import type { ResolvedCatalogEntry } from '@pnpm/lockfile.types';
+import type { Project } from '@pnpm/types';
+import { type WorkspaceManifest } from '@pnpm/workspace.workspace-manifest-reader';
+export type FileName = typeof GLOBAL_CONFIG_YAML_FILENAME | typeof WORKSPACE_MANIFEST_FILENAME;
+export declare function updateWorkspaceManifest(dir: string, opts: {
+    updatedFields?: Partial<WorkspaceManifest>;
+    updatedCatalogs?: Catalogs;
+    updatedOverrides?: Record<string, string>;
+    fileName?: FileName;
+    cleanupUnusedCatalogs?: boolean;
+    allProjects?: Project[];
+}): Promise<void>;
+export interface NewCatalogs {
+    [catalogName: string]: {
+        [dependencyName: string]: Pick<ResolvedCatalogEntry, 'specifier'>;
+    };
+}

package/lib/index.js

@@ -0,0 +1,174 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import util from 'node:util';
+import { WORKSPACE_MANIFEST_FILENAME } from '@pnpm/constants';
+import { sortKeysByPriority } from '@pnpm/object.key-sorting';
+import { validateWorkspaceManifest } from '@pnpm/workspace.workspace-manifest-reader';
+import { patchDocument } from '@pnpm/yaml.document-sync';
+import { equals } from 'ramda';
+import writeFileAtomic from 'write-file-atomic';
+import yaml from 'yaml';
+const DEFAULT_FILENAME = WORKSPACE_MANIFEST_FILENAME;
+async function writeManifestFile(dir, fileName, manifest) {
+    const manifestStr = manifest.toString({
+        lineWidth: 0, // This is setting line width to never wrap
+        singleQuote: true, // Prefer single quotes over double quotes
+    });
+    await fs.promises.mkdir(dir, { recursive: true });
+    await writeFileAtomic(path.join(dir, fileName), manifestStr);
+}
+async function readManifestRaw(file) {
+    try {
+        return (await fs.promises.readFile(file)).toString();
+    }
+    catch (err) {
+        if (util.types.isNativeError(err) && 'code' in err && err.code === 'ENOENT') {
+            return undefined;
+        }
+        throw err;
+    }
+}
+export async function updateWorkspaceManifest(dir, opts) {
+    const fileName = opts.fileName ?? DEFAULT_FILENAME;
+    const workspaceManifestStr = await readManifestRaw(path.join(dir, fileName));
+    const document = workspaceManifestStr != null
+        ? yaml.parseDocument(workspaceManifestStr)
+        : new yaml.Document();
+    let manifest = document.toJSON();
+    validateWorkspaceManifest(manifest);
+    manifest ??= {};
+    let shouldBeUpdated = opts.updatedCatalogs != null && addCatalogs(manifest, opts.updatedCatalogs);
+    if (opts.cleanupUnusedCatalogs) {
+        shouldBeUpdated = removePackagesFromWorkspaceCatalog(manifest, opts.allProjects ?? []) || shouldBeUpdated;
+    }
+    const updatedFields = { ...opts.updatedFields };
+    for (const [key, value] of Object.entries(updatedFields)) {
+        if (!equals(manifest[key], value)) {
+            shouldBeUpdated = true;
+            if (value == null) {
+                delete manifest[key];
+            }
+            else {
+                manifest[key] = value;
+            }
+        }
+    }
+    if (opts.updatedOverrides) {
+        manifest.overrides ??= {};
+        for (const [key, value] of Object.entries(opts.updatedOverrides)) {
+            if (!equals(manifest.overrides[key], value)) {
+                shouldBeUpdated = true;
+                manifest.overrides[key] = value;
+            }
+        }
+    }
+    if (!shouldBeUpdated) {
+        return;
+    }
+    if (Object.keys(manifest).length === 0) {
+        await fs.promises.rm(path.join(dir, fileName));
+        return;
+    }
+    manifest = sortKeysByPriority({
+        priority: { packages: 0 },
+        deep: true,
+    }, manifest);
+    patchDocument(document, manifest);
+    await writeManifestFile(dir, fileName, document);
+}
+function addCatalogs(manifest, newCatalogs) {
+    let shouldBeUpdated = false;
+    for (const catalogName in newCatalogs) {
+        let targetCatalog = catalogName === 'default'
+            ? manifest.catalog ?? manifest.catalogs?.default
+            : manifest.catalogs?.[catalogName];
+        const targetCatalogWasNil = targetCatalog == null;
+        for (const [dependencyName, specifier] of Object.entries(newCatalogs[catalogName] ?? {})) {
+            if (specifier == null) {
+                continue;
+            }
+            targetCatalog ??= {};
+            if (targetCatalog[dependencyName] !== specifier) {
+                targetCatalog[dependencyName] = specifier;
+                shouldBeUpdated = true;
+            }
+        }
+        if (targetCatalog == null)
+            continue;
+        if (targetCatalogWasNil) {
+            if (catalogName === 'default') {
+                manifest.catalog = targetCatalog;
+            }
+            else {
+                manifest.catalogs ??= {};
+                manifest.catalogs[catalogName] = targetCatalog;
+            }
+        }
+    }
+    return shouldBeUpdated;
+}
+function removePackagesFromWorkspaceCatalog(manifest, packagesJson) {
+    let shouldBeUpdated = false;
+    if (packagesJson.length === 0 || (manifest.catalog == null && manifest.catalogs == null)) {
+        return shouldBeUpdated;
+    }
+    const packageReferences = {};
+    for (const pkg of packagesJson) {
+        const pkgManifest = pkg.manifest;
+        const dependencyTypes = [
+            pkgManifest.dependencies,
+            pkgManifest.devDependencies,
+            pkgManifest.optionalDependencies,
+            pkgManifest.peerDependencies,
+        ];
+        for (const deps of dependencyTypes) {
+            if (!deps)
+                continue;
+            for (const [pkgName, version] of Object.entries(deps)) {
+                if (!packageReferences[pkgName]) {
+                    packageReferences[pkgName] = new Set();
+                }
+                packageReferences[pkgName].add(version);
+            }
+        }
+    }
+    if (manifest.catalog) {
+        const packagesToRemove = Object.keys(manifest.catalog).filter(pkg => !packageReferences[pkg]?.has('catalog:'));
+        for (const pkg of packagesToRemove) {
+            delete manifest.catalog[pkg];
+            shouldBeUpdated = true;
+        }
+        if (Object.keys(manifest.catalog).length === 0) {
+            delete manifest.catalog;
+            shouldBeUpdated = true;
+        }
+    }
+    if (manifest.catalogs) {
+        const catalogsToRemove = [];
+        for (const [catalogName, catalog] of Object.entries(manifest.catalogs)) {
+            if (!catalog)
+                continue;
+            const packagesToRemove = Object.keys(catalog).filter(pkg => {
+                const references = packageReferences[pkg];
+                return !references?.has(`catalog:${catalogName}`) && !references?.has('catalog:');
+            });
+            for (const pkg of packagesToRemove) {
+                delete catalog[pkg];
+                shouldBeUpdated = true;
+            }
+            if (Object.keys(catalog).length === 0) {
+                catalogsToRemove.push(catalogName);
+                shouldBeUpdated = true;
+            }
+        }
+        for (const catalogName of catalogsToRemove) {
+            delete manifest.catalogs[catalogName];
+        }
+        if (Object.keys(manifest.catalogs).length === 0) {
+            delete manifest.catalogs;
+            shouldBeUpdated = true;
+        }
+    }
+    return shouldBeUpdated;
+}
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@pnpm/workspace.workspace-manifest-writer",
+  "version": "1001.0.3",
+  "description": "Updates the workspace manifest file",
+  "keywords": [
+    "pnpm",
+    "pnpm11"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/workspace/workspace-manifest-writer",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/workspace/workspace-manifest-writer#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": {
+    "ramda": "npm:@pnpm/ramda@0.28.1",
+    "write-file-atomic": "^7.0.0",
+    "yaml": "^2.8.1",
+    "@pnpm/catalogs.types": "1000.0.0",
+    "@pnpm/constants": "1001.3.1",
+    "@pnpm/lockfile.types": "1002.0.2",
+    "@pnpm/object.key-sorting": "1000.0.1",
+    "@pnpm/workspace.workspace-manifest-reader": "1000.2.5",
+    "@pnpm/yaml.document-sync": "1000.0.0-0",
+    "@pnpm/types": "1000.9.0"
+  },
+  "devDependencies": {
+    "@types/ramda": "0.29.12",
+    "@types/write-file-atomic": "^4.0.3",
+    "read-yaml-file": "^3.0.0",
+    "write-yaml-file": "^6.0.0",
+    "@pnpm/prepare": "1000.0.4",
+    "@pnpm/prepare-temp-dir": "1000.0.0",
+    "@pnpm/workspace.workspace-manifest-writer": "1001.0.3",
+    "@pnpm/workspace.projects-reader": "1000.0.43"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "test": "pnpm run compile && pnpm run _test",
+    "compile": "tsgo --build && pnpm run lint --fix",
+    "_test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules --disable-warning=ExperimentalWarning --disable-warning=DEP0169\" jest"
+  }
+}