@pnpm/workspace.workspace-manifest-reader 1100.0.9 → 1100.1.0

package/CHANGELOG.md

@@ -0,0 +1,305 @@
+# @pnpm/workspace.read-manifest
+
+## 1100.1.0
+
+### Minor Changes
+
+- Added `versioning.epics` to `pnpm-workspace.yaml`. An epic ties a group of member packages to a lead package, constraining every member's major version to a band derived from the lead's major: while the lead is on major `M`, members live in `M*100 … M*100+99`. Members move independently inside the band (patch, minor, and a `major` intent that stays in-band); a bump that would carry a member past the band ceiling is rejected until the lead advances its own major. When a release plan takes the lead to a new stable major, every member re-bases to the band floor in the same plan. Membership is matched with pnpm's package selectors — name globs, `./`-prefixed directory globs, and `!`-prefixed negations.
+
+- Added native workspace release management [#12952](https://github.com/pnpm/pnpm/issues/12952): the new `pnpm change` command records change intents as changesets-compatible `.changeset/*.md` files (`pnpm change status` shows the pending release plan), and the bare `pnpm version -r` consumes them — bumping versions across the workspace with dependent propagation through `workspace:` ranges, fixed groups, a `maxBump` cap, `--filter` narrowing, and `--dry-run` — writing changelogs, and recording consumed intents in a committed ledger that keeps cherry-picks and merge-backs between release branches safe. Packages can be moved onto per-package release lanes with the new `pnpm lane <name> --filter <pkg>` command and back with `pnpm lane main --filter <pkg>` (`pnpm lane` shows the membership), releasing `X.Y.Z-lane.N` prereleases from the same runs that release stable versions of the packages on the main lane. Configuration lives under the new `versioning` key of `pnpm-workspace.yaml` (`fixed`, `ignore`, `maxBump`, `lanes`, `changelog`). When two workspace projects publish the same name, intent files, `versioning.lanes`, and `versioning.fixed`/`ignore` may reference a project by its workspace-relative directory path (e.g. `"./pnpm/npm/pnpm"`) — the one additive extension to the changesets format, applied automatically by `pnpm change`.
+
+  Release changelogs default to `registry` storage (`versioning.changelog.storage`): no `CHANGELOG.md` is committed. Each release's section is composed at publish time and packed into the published tarball on top of the previously published version's changelog, and the consumed change intents are garbage-collected by a later `pnpm version -r` only once the registry confirms the version is published with its section. Set `versioning.changelog.storage: repository` to keep committed `CHANGELOG.md` files instead.
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/types@1101.4.0
+
+## 1100.0.9
+
+### Patch Changes
+
+- Updated dependencies [852d537]
+  - @pnpm/error@1100.0.1
+
+## 1100.0.8
+
+### Patch Changes
+
+- Updated dependencies [681b593]
+  - @pnpm/types@1101.3.2
+
+## 1100.0.7
+
+### Patch Changes
+
+- Updated dependencies [bf1b731]
+  - @pnpm/types@1101.3.1
+
+## 1100.0.6
+
+### Patch Changes
+
+- Updated dependencies [a017bf3]
+  - @pnpm/types@1101.3.0
+
+## 1100.0.5
+
+### Patch Changes
+
+- Updated dependencies [35d2355]
+  - @pnpm/types@1101.2.0
+
+## 1100.0.4
+
+### Patch Changes
+
+- Updated dependencies [64afc92]
+  - @pnpm/types@1101.1.1
+
+## 1100.0.3
+
+### Patch Changes
+
+- Updated dependencies [b61e268]
+  - @pnpm/types@1101.1.0
+
+## 1100.0.2
+
+### Patch Changes
+
+- f543b77: Reject `null` named catalogs in workspace manifests with `InvalidWorkspaceManifestError` instead of crashing with a raw `TypeError`.
+
+## 1100.0.1
+
+### Patch Changes
+
+- Updated dependencies [ff28085]
+  - @pnpm/types@1101.0.0
+
+## 1001.0.0
+
+### Major Changes
+
+- 491a84f: This package is now pure ESM.
+- 7d2fd48: Node.js v18, 19, 20, and 21 support discontinued.
+
+### Minor Changes
+
+- 075aa99: Add support for a global YAML config file named `config.yaml`.
+
+  Now configurations are divided into 2 categories:
+
+  - Registry and auth settings which can be stored in INI files such as global `rc` and local `.npmrc`.
+  - pnpm-specific settings which can only be loaded from YAML files such as global `config.yaml` and local `pnpm-workspace.yaml`.
+
+- 2b14c74: The `validateWorkspaceManifest` function is now exported and can be used to validate whether a workspace manifest object's schema is correct.
+
+### Patch Changes
+
+- Updated dependencies [c55c614]
+- Updated dependencies [76718b3]
+- Updated dependencies [a8f016c]
+- Updated dependencies [cc1b8e3]
+- Updated dependencies [491a84f]
+- Updated dependencies [075aa99]
+- Updated dependencies [7d2fd48]
+- Updated dependencies [efb48dc]
+- Updated dependencies [50fbeca]
+- Updated dependencies [cb367b9]
+- Updated dependencies [7b1c189]
+- Updated dependencies [8ffb1a7]
+- Updated dependencies [05fb1ae]
+- Updated dependencies [71de2b3]
+- Updated dependencies [10bc391]
+- Updated dependencies [831f574]
+- Updated dependencies [2df8b71]
+- Updated dependencies [15549a9]
+- Updated dependencies [cc7c0d2]
+- Updated dependencies [efb48dc]
+  - @pnpm/constants@1002.0.0
+  - @pnpm/types@1001.0.0
+  - @pnpm/error@1001.0.0
+
+## 1000.2.5
+
+### Patch Changes
+
+- Updated dependencies [7c1382f]
+- Updated dependencies [dee39ec]
+  - @pnpm/types@1000.9.0
+
+## 1000.2.4
+
+### Patch Changes
+
+- Updated dependencies [6365bc4]
+  - @pnpm/constants@1001.3.1
+  - @pnpm/error@1000.0.5
+
+## 1000.2.3
+
+### Patch Changes
+
+- Updated dependencies [e792927]
+  - @pnpm/types@1000.8.0
+
+## 1000.2.2
+
+### Patch Changes
+
+- Updated dependencies [d1edf73]
+- Updated dependencies [86b33e9]
+  - @pnpm/constants@1001.3.0
+  - @pnpm/error@1000.0.4
+
+## 1000.2.1
+
+### Patch Changes
+
+- Updated dependencies [1a07b8f]
+- Updated dependencies [1a07b8f]
+  - @pnpm/types@1000.7.0
+  - @pnpm/constants@1001.2.0
+  - @pnpm/error@1000.0.3
+
+## 1000.2.0
+
+### Minor Changes
+
+- c8341cc: Added two new CLI options (`--save-catalog` and `--save-catalog-name=<name>`) to `pnpm add` to save new dependencies as catalog entries. `catalog:` or `catalog:<name>` will be added to `package.json` and the package specifier will be added to the `catalogs` or `catalog[<name>]` object in `pnpm-workspace.yaml` [#9425](https://github.com/pnpm/pnpm/issues/9425).
+
+## 1000.1.5
+
+### Patch Changes
+
+- Updated dependencies [5ec7255]
+  - @pnpm/types@1000.6.0
+
+## 1000.1.4
+
+### Patch Changes
+
+- Updated dependencies [5b73df1]
+  - @pnpm/types@1000.5.0
+
+## 1000.1.3
+
+### Patch Changes
+
+- Updated dependencies [750ae7d]
+  - @pnpm/types@1000.4.0
+
+## 1000.1.2
+
+### Patch Changes
+
+- Updated dependencies [5f7be64]
+- Updated dependencies [5f7be64]
+  - @pnpm/types@1000.3.0
+
+## 1000.1.1
+
+### Patch Changes
+
+- Updated dependencies [a5e4965]
+  - @pnpm/types@1000.2.1
+
+## 1000.1.0
+
+### Minor Changes
+
+- 8fcc221: Extend WorkspaceManifest with PnpmSettings.
+- 8fcc221: The `packages` field in `pnpm-workspace.yaml` became optional.
+
+### Patch Changes
+
+- Updated dependencies [8fcc221]
+  - @pnpm/types@1000.2.0
+
+## 1000.0.2
+
+### Patch Changes
+
+- Updated dependencies [9a44e6c]
+  - @pnpm/constants@1001.1.0
+  - @pnpm/error@1000.0.2
+
+## 1000.0.1
+
+### Patch Changes
+
+- Updated dependencies [d2e83b0]
+- Updated dependencies [a76da0c]
+  - @pnpm/constants@1001.0.0
+  - @pnpm/error@1000.0.1
+
+## 2.2.2
+
+### Patch Changes
+
+- Updated dependencies [19d5b51]
+- Updated dependencies [8108680]
+- Updated dependencies [c4f5231]
+  - @pnpm/constants@10.0.0
+  - @pnpm/error@6.0.3
+
+## 2.2.1
+
+### Patch Changes
+
+- Updated dependencies [83681da]
+  - @pnpm/constants@9.0.0
+  - @pnpm/error@6.0.2
+
+## 2.2.0
+
+### Minor Changes
+
+- 9c63679: The `readWorkspaceManifest` function now parses and validates [pnpm catalogs](https://github.com/pnpm/rfcs/pull/1) configs if present.
+
+## 2.1.0
+
+### Minor Changes
+
+- 5d1ed94: The type definition for the `packages` field of the `WorkspaceManifest` is now non-null. The `readWorkspaceManifest` function expects this field to be present and throws an error otherwise.
+
+## 2.0.1
+
+### Patch Changes
+
+- Updated dependencies [a7aef51]
+  - @pnpm/error@6.0.1
+
+## 2.0.0
+
+### Major Changes
+
+- 43cdd87: Node.js v16 support dropped. Use at least Node.js v18.12.
+
+### Patch Changes
+
+- Updated dependencies [3ded840]
+- Updated dependencies [c692f80]
+- Updated dependencies [43cdd87]
+- Updated dependencies [d381a60]
+  - @pnpm/error@6.0.0
+  - @pnpm/constants@8.0.0
+
+## 1.0.2
+
+### Patch Changes
+
+- e8926e920: Minor refactors to improve the type safety of the workspace manifest validation logic in the `readWorkspaceManifest` function.
+
+## 1.0.1
+
+### Patch Changes
+
+- e2a0c7272: Don't fail on an empty `pnpm-workspace.yaml` file [#7307](https://github.com/pnpm/pnpm/issues/7307).
+
+## 1.0.0
+
+### Major Changes
+
+- 3f7e65e10: Initial release.

package/lib/index.js

@@ -4,6 +4,7 @@ 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';
+import { assertValidWorkspaceManifestVersioning } from './versioning.js';
 export async function readWorkspaceManifest(dir, cfgFileName = WORKSPACE_MANIFEST_FILENAME) {
     const manifest = await readManifestRaw(dir, cfgFileName);
     validateWorkspaceManifest(manifest);
@@ -40,6 +41,7 @@ export function validateWorkspaceManifest(manifest) {
     assertValidWorkspaceManifestPackages(manifest);
     assertValidWorkspaceManifestCatalog(manifest);
     assertValidWorkspaceManifestCatalogs(manifest);
+    assertValidWorkspaceManifestVersioning(manifest);
     checkWorkspaceManifestAssignability(manifest);
 }
 function assertValidWorkspaceManifestPackages(manifest) {

package/lib/versioning.d.ts

@@ -0,0 +1,7 @@
+import type { VersioningSettings } from '@pnpm/types';
+export declare function assertValidWorkspaceManifestVersioning(manifest: {
+    packages?: readonly string[];
+    versioning?: unknown;
+}): asserts manifest is {
+    versioning?: VersioningSettings;
+};

package/lib/versioning.js

@@ -0,0 +1,73 @@
+import { InvalidWorkspaceManifestError } from './errors/InvalidWorkspaceManifestError.js';
+const BUMP_TYPES = ['patch', 'minor', 'major'];
+const CHANGELOG_STORAGE_MODES = ['registry', 'repository'];
+export function assertValidWorkspaceManifestVersioning(manifest) {
+    if (manifest.versioning == null) {
+        return;
+    }
+    const versioning = assertPlainObject(manifest.versioning, 'versioning');
+    if (versioning.fixed != null) {
+        if (!Array.isArray(versioning.fixed)) {
+            throw new InvalidWorkspaceManifestError(`Expected versioning.fixed to be an array of arrays, but found - ${typeof versioning.fixed}`);
+        }
+        for (const group of versioning.fixed) {
+            if (!Array.isArray(group) || group.some((name) => typeof name !== 'string' || name === '')) {
+                throw new InvalidWorkspaceManifestError('Expected every versioning.fixed group to be an array of package names');
+            }
+        }
+    }
+    if (versioning.epics != null) {
+        if (!Array.isArray(versioning.epics)) {
+            throw new InvalidWorkspaceManifestError(`Expected versioning.epics to be an array, but found - ${typeof versioning.epics}`);
+        }
+        for (const epic of versioning.epics) {
+            const entry = assertPlainObject(epic, 'versioning.epics entry');
+            if (typeof entry.lead !== 'string' || entry.lead === '') {
+                throw new InvalidWorkspaceManifestError('Expected every versioning.epics entry to have a non-empty "lead" package reference');
+            }
+            if (!Array.isArray(entry.packages) || entry.packages.length === 0 || entry.packages.some((selector) => typeof selector !== 'string' || selector === '')) {
+                throw new InvalidWorkspaceManifestError(`Expected versioning.epics entry for "${entry.lead}" to have a non-empty "packages" array of selector strings`);
+            }
+        }
+    }
+    if (versioning.ignore != null) {
+        if (!Array.isArray(versioning.ignore) || versioning.ignore.some((name) => typeof name !== 'string' || name === '')) {
+            throw new InvalidWorkspaceManifestError('Expected versioning.ignore to be an array of package names');
+        }
+    }
+    if (versioning.maxBump != null) {
+        if (!BUMP_TYPES.includes(versioning.maxBump)) {
+            throw new InvalidWorkspaceManifestError(`Expected versioning.maxBump to be one of ${BUMP_TYPES.join(', ')}, but found - ${String(versioning.maxBump)}`);
+        }
+    }
+    if (versioning.lanes != null) {
+        const lanes = assertPlainObject(versioning.lanes, 'versioning.lanes');
+        for (const [pkgName, lane] of Object.entries(lanes)) {
+            if (typeof lane !== 'string' || lane === '') {
+                throw new InvalidWorkspaceManifestError(`Expected versioning.lanes entry for ${pkgName} to be a non-empty lane name`);
+            }
+            if (lane.toLowerCase() === 'main') {
+                throw new InvalidWorkspaceManifestError(`Invalid versioning.lanes entry for ${pkgName}: "main" is the reserved default lane. Remove the entry instead.`);
+            }
+        }
+    }
+    if (versioning.changelog != null) {
+        const changelog = assertPlainObject(versioning.changelog, 'versioning.changelog');
+        if (changelog.format != null && typeof changelog.format !== 'string') {
+            throw new InvalidWorkspaceManifestError(`Expected versioning.changelog.format to be a string, but found - ${typeof changelog.format}`);
+        }
+        if (changelog.storage != null && !CHANGELOG_STORAGE_MODES.includes(changelog.storage)) {
+            throw new InvalidWorkspaceManifestError(`Expected versioning.changelog.storage to be one of ${CHANGELOG_STORAGE_MODES.join(', ')}, but found - ${String(changelog.storage)}`);
+        }
+    }
+}
+function assertPlainObject(value, fieldName) {
+    if (Array.isArray(value)) {
+        throw new InvalidWorkspaceManifestError(`Expected ${fieldName} field to be an object, but found - array`);
+    }
+    if (typeof value !== 'object' || value === null) {
+        throw new InvalidWorkspaceManifestError(`Expected ${fieldName} field to be an object, but found - ${value === null ? 'null' : typeof value}`);
+    }
+    return value;
+}
+//# sourceMappingURL=versioning.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/workspace.workspace-manifest-reader",
-  "version": "1100.0.9",
+  "version": "1100.1.0",
   "description": "Reads a workspace manifest file",
   "keywords": [
     "pnpm",
@@ -27,14 +27,14 @@
     "!*.map"
   ],
   "dependencies": {
-    "read-yaml-file": "^3.0.0",
+    "@pnpm/constants": "1100.0.0",
     "@pnpm/error": "1100.0.1",
-    "@pnpm/types": "1101.3.2",
-    "@pnpm/constants": "1100.0.0"
+    "@pnpm/types": "1101.4.0",
+    "read-yaml-file": "^3.0.0"
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/workspace.workspace-manifest-reader": "1100.0.9"
+    "@pnpm/workspace.workspace-manifest-reader": "1100.1.0"
   },
   "engines": {
     "node": ">=22.13"