@budsbox/constraints 2.1.3 → 3.0.1

package/dist/cjs/dependencies/peer.d.ts

@@ -7,25 +7,6 @@ export interface PeerDependenciesConstraintOptions {
      * Indicates whether private workspaces can have peer dependencies.
      */
     readonly allowPrivates?: boolean;
-    /**
-     * Specifies an optional list of glob patterns used to automatically
-     * identify and import peer dependencies.
-     *
-     * The property defines a set of patterns (e.g., 'package-name', 'module-name')
-     * that determine which peer dependencies should be automatically imported
-     * and managed by the dependency constraints. These patterns make it easier
-     * to include relevant peer dependencies without manual configuration.
-     *
-     * @example
-     * // Example usage in configuration options:
-     * const options: PeerDependenciesConstraintOptions = {
-     *   autoImportFrom: ['eslint-plugin-*', 'packages/*']
-     * };
-     *
-     * // Patterns like 'eslint-plugin-*' can match all peer dependencies
-     * // starting with 'eslint-plugin-' (e.g., `eslint-plugin-react`).
-     * @see {@link micromatch} for supported glob syntax.
-     */
     /**
      * Glob patterns of direct dependencies whose `peerDependencies` should be
      * propagated to the dependant workspace.

package/dist/cjs/dependencies/root.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.constraintRootDependencies = void 0;
 const guards_1 = require("@budsbox/lib-es/guards");
 const utils_1 = require("../utils");
+const guards_2 = require("@budsbox/lib-es/guards");
 /**
  * A constraint function that enforces the consistency of dependencies among Yarn workspaces.
  * It ensures that if a dependency exists with multiple version ranges across different workspaces,
@@ -16,6 +17,11 @@ const utils_1 = require("../utils");
  */
 const constraintRootDependencies = ({ Yarn }) => {
     const root = (0, utils_1.getRootWs)(Yarn);
+    for (const ws of Yarn.workspaces()) {
+        if (ws !== root && (0, guards_2.isNotNil)(ws.ident)) {
+            root.set(['dependencies', ws.ident], 'workspace:^');
+        }
+    }
     const dependencyRecords = Yarn.workspaces()
         .filter((ws) => ws !== root)
         .reduce((acc, workspace) => Yarn.dependencies({ workspace }).reduce((depAcc, { ident, range }) => ([

package/dist/cjs/esm.d.ts

@@ -1,4 +1,24 @@
 import type { Constraint } from './utils.js';
+/**
+ * A constraint function that ensures all workspaces have a proper `./package.json` export.
+ *
+ * This function iterates through all workspaces in the Yarn project and sets the
+ * `exports['./package.json']` field to `./package.json` in each workspace's manifest.
+ * This ensures that the `package.json` file can be resolved as a subpath export.
+ *
+ * @param options - The constraint options containing the Yarn instance.
+ */
 export declare const constraintExports: Constraint;
+/**
+ * A constraint function that automatically generates `imports` based on `exports` in each workspace.
+ *
+ * For each workspace that defines `exports`, this function mirrors those exports in the `imports` field
+ * by replacing the `./` prefix with `#`. It skips the root export (`.`).
+ *
+ * This allows using the same paths for internal imports and external consumers while using the `#` prefix
+ * for better clarity and alignment with ESM standards.
+ *
+ * @param options - The constraint options containing the Yarn instance.
+ */
 export declare const constraintImports: Constraint;
 //# sourceMappingURL=esm.d.ts.map

package/dist/cjs/esm.js

@@ -1,12 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constraintImports = exports.constraintExports = void 0;
+/**
+ * A constraint function that ensures all workspaces have a proper `./package.json` export.
+ *
+ * This function iterates through all workspaces in the Yarn project and sets the
+ * `exports['./package.json']` field to `./package.json` in each workspace's manifest.
+ * This ensures that the `package.json` file can be resolved as a subpath export.
+ *
+ * @param options - The constraint options containing the Yarn instance.
+ */
 const constraintExports = ({ Yarn }) => {
     for (const workspace of Yarn.workspaces()) {
         workspace.set(['exports', './package.json'], './package.json');
     }
 };
 exports.constraintExports = constraintExports;
+/**
+ * A constraint function that automatically generates `imports` based on `exports` in each workspace.
+ *
+ * For each workspace that defines `exports`, this function mirrors those exports in the `imports` field
+ * by replacing the `./` prefix with `#`. It skips the root export (`.`).
+ *
+ * This allows using the same paths for internal imports and external consumers while using the `#` prefix
+ * for better clarity and alignment with ESM standards.
+ *
+ * @param options - The constraint options containing the Yarn instance.
+ */
 const constraintImports = ({ Yarn }) => {
     for (const workspace of Yarn.workspaces()) {
         const { exports } = workspace.manifest;

package/dist/cjs/index.d.ts

@@ -1,4 +1,15 @@
 import type { Constraint, ConstraintOptions } from './utils.js';
+/**
+ * Runs a sequence of constraint functions in order.
+ *
+ * This utility function takes a set of constraint options and a list of constraint functions,
+ * then executes each constraint one after another. This is useful for organizing multiple
+ * constraints into a single execution pipeline.
+ *
+ * @param options - The common constraint options (containing the Yarn instance) to be passed to each constraint.
+ * @param constraints - A rest parameter containing the constraint functions to execute.
+ * @returns A promise that resolves when all constraints in the sequence have finished executing.
+ */
 export declare function runConstraintsSequence(options: ConstraintOptions, ...constraints: readonly Constraint[]): Promise<void>;
 export { constraintPackageName, createManifestFieldsConstraint, } from './base.js';
 export { constraintExports, constraintImports } from './esm.js';

package/dist/cjs/index.js

@@ -2,6 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createWorkspaceDependenciesConstraint = exports.createPeerDependenciesConstraint = exports.constraintRootDependencies = exports.constraintImports = exports.constraintExports = exports.createManifestFieldsConstraint = exports.constraintPackageName = void 0;
 exports.runConstraintsSequence = runConstraintsSequence;
+/**
+ * Runs a sequence of constraint functions in order.
+ *
+ * This utility function takes a set of constraint options and a list of constraint functions,
+ * then executes each constraint one after another. This is useful for organizing multiple
+ * constraints into a single execution pipeline.
+ *
+ * @param options - The common constraint options (containing the Yarn instance) to be passed to each constraint.
+ * @param constraints - A rest parameter containing the constraint functions to execute.
+ * @returns A promise that resolves when all constraints in the sequence have finished executing.
+ */
 async function runConstraintsSequence(options, ...constraints) {
     for (const constraint of constraints) {
         await constraint(options);

package/dist/cjs/utils.d.ts

@@ -24,9 +24,9 @@ export type Constraint = (options: ConstraintOptions) => Awaitable<void>;
  * - If `Options` is an empty object, the factory function can be called with or without the `options` parameter.
  * - Otherwise, the `options` parameter is required when calling the factory function.
  *
- * @typeParam Options - The type of the option parameter used to configure the `Constraint`.
  * @param options - An optional or required configuration object, depending on whether `Options` is an empty object or not.
  * @returns A `Constraint` object configured based on the provided options.
+ * @typeParam Options - The type of the option parameter used to configure the `Constraint`.
  */
 export type ConstraintFactory<Options extends object> = object extends Options ? (options?: Options) => Constraint : (options: Options) => Constraint;
 /**
@@ -43,6 +43,8 @@ export declare function getRootWs(yarn: YarnNS.Constraints.Yarn): YarnNS.Constra
  *
  * @param workspace - The workspace whose manifest is to be retrieved.
  * @returns The manifest of the provided workspace as an object of type T.
+ * @throws {@link Error} if the workspace manifest is null.
+ * @typeParam T - The type of the manifest object, defaults to PackageJson.
  */
 export declare function getManifest<T extends object = PackageJson>(workspace: YarnNS.Constraints.Workspace): T;
 /**
@@ -54,7 +56,7 @@ export declare function getManifest<T extends object = PackageJson>(workspace: Y
  * @returns The dependency range considering the root workspace dependency if present,
  * otherwise the original dependency range.
  */
-export declare const getRangeConsideringRoot: (yarn: YarnNS.Constraints.Yarn, dependency: Readonly<Pick<YarnNS.Constraints.Dependency, "range" | "ident">>) => string;
+export declare const getRangeConsideringRoot: (yarn: YarnNS.Constraints.Yarn, dependency: Readonly<Pick<YarnNS.Constraints.Dependency, "ident" | "range">>) => string;
 /**
  * Updates the version range of a dependency if it differs from the current range.
  *

package/dist/cjs/utils.js

@@ -24,6 +24,8 @@ function getRootWs(yarn) {
  *
  * @param workspace - The workspace whose manifest is to be retrieved.
  * @returns The manifest of the provided workspace as an object of type T.
+ * @throws {@link Error} if the workspace manifest is null.
+ * @typeParam T - The type of the manifest object, defaults to PackageJson.
  */
 function getManifest(workspace) {
     if (workspace.manifest == null) {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@budsbox/constraints",
-  "version": "2.1.3",
-  "homepage": "https://gitlab.com/budsbox/fe/seed",
+  "version": "3.0.1",
+  "homepage": "https://github.com/budsbox/seed",
   "bugs": {
-    "url": "https://gitlab.com/budsbox/fe/seed/-/issues"
+    "url": "https://github.com/budsbox/seed/issues"
   },
-  "repository": "gitlab:budsbox/fe/seed",
+  "repository": "git@github.com:budsbox/seed.git",
   "license": "MIT",
   "author": "Konstantin Kutsyllo <trikadin@pm.me>",
   "type": "commonjs",
@@ -19,8 +19,8 @@
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/cjs/index.d.ts"
+      "types": "./dist/cjs/index.d.ts",
+      "require": "./dist/cjs/index.js"
     }
   },
   "files": [
@@ -33,37 +33,37 @@
     "setup": "[ -f dist/dist.tsbuildinfo ] || run p:lib:setup"
   },
   "dependencies": {
-    "@budsbox/lib-es": "^2.0.0",
-    "@types/micromatch": "^4.0.9",
+    "@budsbox/lib-es": "^3.0.0",
+    "@types/micromatch": "^4.0.10",
     "@yarnpkg/types": "^4.0.1",
     "micromatch": "^4.0.8",
-    "semver": "^7.7.2",
+    "semver": "^7.7.3",
     "semver-intersect": "^1.5.0",
-    "type-fest": "^4.32.0"
+    "type-fest": "^5.3.1"
   },
   "devDependencies": {
-    "@budsbox/eslint": "^1.1.0",
-    "@budsbox/eslint_presets-node-lib": "^1.0.2",
-    "@budsbox/eslint_presets-tools": "^1.0.2",
-    "@budsbox/lib-types": "^1.0.0",
-    "@budsbox/tsconfigs": "^4.1.0",
-    "@budsbox/types": "^2.0.0",
-    "@eslint/js": "^9.26.0",
+    "@budsbox/eslint": "^1.3.0",
+    "@budsbox/eslint_presets-node-lib": "^1.0.5",
+    "@budsbox/eslint_presets-tools": "^1.0.5",
+    "@budsbox/lib-types": "^1.4.0",
+    "@budsbox/tsconfigs": "^4.4.0",
+    "@budsbox/types": "^3.0.0",
+    "@eslint/js": "^9.39.1",
     "@types/eslint": "^9.6.1",
-    "@types/node": "^22.15.2",
-    "@types/semver": "^7",
-    "@typescript-eslint/parser": "^8.32.1",
-    "eslint": "^9.26.0",
-    "eslint-config-prettier": "^10.1.5",
-    "eslint-import-resolver-typescript": "^4.3.4",
-    "eslint-plugin-jsdoc": "^50.6.17",
+    "@types/node": "^22.19.1",
+    "@types/semver": "^7.7.1",
+    "@typescript-eslint/parser": "^8.48.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-jsdoc": "^61.5.0",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
-    "eslint-plugin-react-refresh": "^0.4.20",
-    "globals": "^16.1.0",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
     "tslib": "^2.8.1",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.32.1"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.48.1"
   },
   "packageManager": "yarn@4.9.2"
 }