@pnpm/workspace.workspace-manifest-reader 1000.2.5

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-reader
+
+> Reads a workspace manifest file
+
+## Install
+
+```
+pnpm add @pnpm/workspace.workspace-manifest-reader
+```
+
+## LICENSE
+
+MIT

package/lib/catalogs.d.ts

@@ -0,0 +1,18 @@
+export interface WorkspaceNamedCatalogs {
+    [catalogName: string]: WorkspaceCatalog;
+}
+export interface WorkspaceCatalog {
+    [dependencyName: string]: string;
+}
+export declare function assertValidWorkspaceManifestCatalog(manifest: {
+    packages?: readonly string[];
+    catalog?: unknown;
+}): asserts manifest is {
+    catalog?: WorkspaceCatalog;
+};
+export declare function assertValidWorkspaceManifestCatalogs(manifest: {
+    packages?: readonly string[];
+    catalogs?: unknown;
+}): asserts manifest is {
+    catalogs?: WorkspaceNamedCatalogs;
+};

package/lib/catalogs.js

@@ -0,0 +1,42 @@
+import { InvalidWorkspaceManifestError } from './errors/InvalidWorkspaceManifestError.js';
+export function assertValidWorkspaceManifestCatalog(manifest) {
+    if (manifest.catalog == null) {
+        return;
+    }
+    if (Array.isArray(manifest.catalog)) {
+        throw new InvalidWorkspaceManifestError('Expected catalog field to be an object, but found - array');
+    }
+    if (typeof manifest.catalog !== 'object') {
+        throw new InvalidWorkspaceManifestError(`Expected catalog field to be an object, but found - ${typeof manifest.catalog}`);
+    }
+    for (const [alias, specifier] of Object.entries(manifest.catalog)) {
+        if (typeof specifier !== 'string') {
+            throw new InvalidWorkspaceManifestError(`Invalid catalog entry for ${alias}. Expected string, but found: ${typeof specifier}`);
+        }
+    }
+}
+export function assertValidWorkspaceManifestCatalogs(manifest) {
+    if (manifest.catalogs == null) {
+        return;
+    }
+    if (Array.isArray(manifest.catalogs)) {
+        throw new InvalidWorkspaceManifestError('Expected catalogs field to be an object, but found - array');
+    }
+    if (typeof manifest.catalogs !== 'object') {
+        throw new InvalidWorkspaceManifestError(`Expected catalogs field to be an object, but found - ${typeof manifest.catalogs}`);
+    }
+    for (const [catalogName, catalog] of Object.entries(manifest.catalogs)) {
+        if (Array.isArray(catalog)) {
+            throw new InvalidWorkspaceManifestError(`Expected named catalog ${catalogName} to be an object, but found - array`);
+        }
+        if (typeof catalog !== 'object') {
+            throw new InvalidWorkspaceManifestError(`Expected named catalog ${catalogName} to be an object, but found - ${typeof catalog}`);
+        }
+        for (const [alias, specifier] of Object.entries(catalog)) {
+            if (typeof specifier !== 'string') {
+                throw new InvalidWorkspaceManifestError(`Catalog '${catalogName}' has invalid entry '${alias}'. Expected string specifier, but found: ${typeof specifier}`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=catalogs.js.map

package/lib/errors/InvalidWorkspaceManifestError.d.ts

@@ -0,0 +1,4 @@
+import { PnpmError } from '@pnpm/error';
+export declare class InvalidWorkspaceManifestError extends PnpmError {
+    constructor(message: string);
+}

package/lib/errors/InvalidWorkspaceManifestError.js

@@ -0,0 +1,7 @@
+import { PnpmError } from '@pnpm/error';
+export class InvalidWorkspaceManifestError extends PnpmError {
+    constructor(message) {
+        super('INVALID_WORKSPACE_CONFIGURATION', message);
+    }
+}
+//# sourceMappingURL=InvalidWorkspaceManifestError.js.map

package/lib/index.d.ts

@@ -0,0 +1,20 @@
+import { type GLOBAL_CONFIG_YAML_FILENAME, WORKSPACE_MANIFEST_FILENAME } from '@pnpm/constants';
+import type { PnpmSettings } from '@pnpm/types';
+import { type WorkspaceCatalog, type WorkspaceNamedCatalogs } from './catalogs.js';
+export type ConfigFileName = typeof GLOBAL_CONFIG_YAML_FILENAME | typeof WORKSPACE_MANIFEST_FILENAME;
+export interface WorkspaceManifest extends PnpmSettings {
+    packages: string[];
+    /**
+     * The default catalog. Package manifests may refer to dependencies in this
+     * definition through the `catalog:default` specifier or the `catalog:`
+     * shorthand.
+     */
+    catalog?: WorkspaceCatalog;
+    /**
+     * A dictionary of named catalogs. Package manifests may refer to dependencies
+     * in this definition through the `catalog:<name>` specifier.
+     */
+    catalogs?: WorkspaceNamedCatalogs;
+}
+export declare function readWorkspaceManifest(dir: string, cfgFileName?: ConfigFileName): Promise<WorkspaceManifest | undefined>;
+export declare function validateWorkspaceManifest(manifest: unknown): asserts manifest is WorkspaceManifest | undefined;

package/lib/index.js

@@ -0,0 +1,69 @@
+import path from 'node:path';
+import util from 'node:util';
+import { WORKSPACE_MANIFEST_FILENAME } from '@pnpm/constants';
+import { readYamlFile } from 'read-yaml-file';
+import { assertValidWorkspaceManifestCatalog, assertValidWorkspaceManifestCatalogs, } from './catalogs.js';
+import { InvalidWorkspaceManifestError } from './errors/InvalidWorkspaceManifestError.js';
+export async function readWorkspaceManifest(dir, cfgFileName = WORKSPACE_MANIFEST_FILENAME) {
+    const manifest = await readManifestRaw(dir, cfgFileName);
+    validateWorkspaceManifest(manifest);
+    return manifest;
+}
+async function readManifestRaw(dir, cfgFileName) {
+    try {
+        return await readYamlFile(path.join(dir, cfgFileName));
+    }
+    catch (err) {
+        // File not exists is the same as empty file (undefined)
+        if (util.types.isNativeError(err) && 'code' in err && err.code === 'ENOENT') {
+            return undefined;
+        }
+        // Any other error (missing perm, invalid yaml, etc.) fails the process
+        throw err;
+    }
+}
+export function validateWorkspaceManifest(manifest) {
+    if (manifest === undefined || manifest === null) {
+        // Empty or null manifest is ok
+        return;
+    }
+    if (typeof manifest !== 'object') {
+        throw new InvalidWorkspaceManifestError(`Expected object but found - ${typeof manifest}`);
+    }
+    if (Array.isArray(manifest)) {
+        throw new InvalidWorkspaceManifestError('Expected object but found - array');
+    }
+    if (Object.keys(manifest).length === 0) {
+        // manifest content `{}` is ok
+        return;
+    }
+    assertValidWorkspaceManifestPackages(manifest);
+    assertValidWorkspaceManifestCatalog(manifest);
+    assertValidWorkspaceManifestCatalogs(manifest);
+    checkWorkspaceManifestAssignability(manifest);
+}
+function assertValidWorkspaceManifestPackages(manifest) {
+    if (!manifest.packages) {
+        return;
+    }
+    if (!Array.isArray(manifest.packages)) {
+        throw new InvalidWorkspaceManifestError('packages field is not an array');
+    }
+    for (const pkg of manifest.packages) {
+        if (!pkg) {
+            throw new InvalidWorkspaceManifestError('Missing or empty package');
+        }
+        const type = typeof pkg;
+        if (type !== 'string') {
+            throw new InvalidWorkspaceManifestError(`Invalid package type - ${type}`);
+        }
+    }
+}
+/**
+ * Empty function to ensure TypeScript has narrowed the manifest object to
+ * something assignable to the {@see WorkspaceManifest} interface. This helps
+ * make sure the validation logic in this file is correct as it's refactored in
+ * the future.
+ */
+function checkWorkspaceManifestAssignability(_manifest) { }
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@pnpm/workspace.workspace-manifest-reader",
+  "version": "1000.2.5",
+  "description": "Reads a workspace manifest file",
+  "keywords": [
+    "pnpm",
+    "pnpm11"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/workspace/workspace-manifest-reader",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/workspace/workspace-manifest-reader#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": {
+    "read-yaml-file": "^3.0.0",
+    "@pnpm/constants": "1001.3.1",
+    "@pnpm/error": "1000.0.5",
+    "@pnpm/types": "1000.9.0"
+  },
+  "devDependencies": {
+    "@pnpm/workspace.workspace-manifest-reader": "1000.2.5"
+  },
+  "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",
+    "compile": "tsgo --build && pnpm run lint --fix"
+  }
+}