commitlint-config-spellbookx 0.11.0 → 0.12.0

package/dist/lib/find-git-root.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file find-git-root.ts
+ * Utility to locate the root directory of a git repository.
+ */
+/**
+ * Finds the git root directory by traversing upwards from startDir.
+ *
+ * @param startDir - Directory to start searching from (defaults to process.cwd()).
+ * @returns Path to git root directory, or null if not within a git repository.
+ * @example
+ * ```ts
+ * const root = findGitRoot();
+ * ```
+ */
+export declare function findGitRoot(startDir?: string): string | null;
+//# sourceMappingURL=find-git-root.d.ts.map

package/dist/lib/find-git-root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-git-root.d.ts","sourceRoot":"","sources":["../../src/lib/find-git-root.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,QAAQ,GAAE,MAAsB,GAAG,MAAM,GAAG,IAAI,CAY3E"}

package/dist/lib/find-git-root.js

@@ -0,0 +1,30 @@
+import { existsSync } from "node:fs";
+import path from "node:path";
+
+//#region src/lib/find-git-root.ts
+/**
+* @file find-git-root.ts
+* Utility to locate the root directory of a git repository.
+*/
+/**
+* Finds the git root directory by traversing upwards from startDir.
+*
+* @param startDir - Directory to start searching from (defaults to process.cwd()).
+* @returns Path to git root directory, or null if not within a git repository.
+* @example
+* ```ts
+* const root = findGitRoot();
+* ```
+*/
+function findGitRoot(startDir = process.cwd()) {
+	let current = path.resolve(startDir);
+	while (true) {
+		if (existsSync(path.join(current, ".git"))) return current;
+		const parent = path.dirname(current);
+		if (parent === current) return null;
+		current = parent;
+	}
+}
+
+//#endregion
+export { findGitRoot };

package/dist/lib/get-scope-description.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @file get-scope-description.ts
+ * Formats user-facing description strings for commit scopes.
+ */
+/**
+ * Returns a human-readable description for a given commit scope.
+ *
+ * @param scope - The scope identifier.
+ * @returns The description string for the scope.
+ * @example
+ * ```ts
+ * getScopeDescription('workspace');
+ * // 'workspace scope - root files such as config files, root package.json, etc'
+ * getScopeDescription('release');
+ * // 'Special scope for release commits'
+ * getScopeDescription('my-package');
+ * // 'my-package scope'
+ * ```
+ */
+export declare function getScopeDescription(scope: string): string;
+//# sourceMappingURL=get-scope-description.d.ts.map

package/dist/lib/get-scope-description.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-scope-description.d.ts","sourceRoot":"","sources":["../../src/lib/get-scope-description.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAYH;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAOzD"}

package/dist/lib/get-scope-description.js

@@ -0,0 +1,35 @@
+//#region src/lib/get-scope-description.ts
+/**
+* @file get-scope-description.ts
+* Formats user-facing description strings for commit scopes.
+*/
+/**
+* Scope identifier for workspace-level changes.
+*/
+const SCOPE_WORKSPACE = "workspace";
+/**
+* Scope identifier for release commits.
+*/
+const SCOPE_RELEASE = "release";
+/**
+* Returns a human-readable description for a given commit scope.
+*
+* @param scope - The scope identifier.
+* @returns The description string for the scope.
+* @example
+* ```ts
+* getScopeDescription('workspace');
+* // 'workspace scope - root files such as config files, root package.json, etc'
+* getScopeDescription('release');
+* // 'Special scope for release commits'
+* getScopeDescription('my-package');
+* // 'my-package scope'
+* ```
+*/
+function getScopeDescription(scope) {
+	if (scope === SCOPE_WORKSPACE) return "workspace scope - root files such as config files, root package.json, etc";
+	return scope === SCOPE_RELEASE ? "Special scope for release commits" : `${scope} scope`;
+}
+
+//#endregion
+export { getScopeDescription };

package/dist/lib/get-scopes.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file get-scopes.ts
+ * Discovers and gathers workspace package scopes in a monorepo or standard repository.
+ */
+/**
+ * Retrieves a list of package scope names from monorepo configuration files (npm, pnpm, lerna).
+ *
+ * @param cwd - Working directory to start git root discovery from (defaults to process.cwd()).
+ * @returns An array of package scope names found in the repository.
+ * @example
+ * ```ts
+ * const scopes = getScopes();
+ * ```
+ */
+export declare function getScopes(cwd?: string): string[];
+//# sourceMappingURL=get-scopes.d.ts.map

package/dist/lib/get-scopes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-scopes.d.ts","sourceRoot":"","sources":["../../src/lib/get-scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;;;;;;;;GASG;AACH,wBAAgB,SAAS,CAAC,GAAG,GAAE,MAAsB,GAAG,MAAM,EAAE,CAiE/D"}

package/dist/lib/get-scopes.js

@@ -0,0 +1,4 @@
+import { t as getScopes } from "../get-scopes-D9bIfVqN.js";
+import "../get-workspaces-raw-path-Cg196xaD.js";
+
+export { getScopes };

package/dist/lib/get-workspaces-raw-path.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @file get-workspaces-raw-path.ts
+ * Parser for extracting workspace path globs from JSON and YAML configuration files.
+ */
+/**
+ * Reads workspace paths from configuration files (JSON or YAML).
+ *
+ * @param configPath - The path to the config file (e.g., package.json, pnpm-workspace.yaml).
+ * @param parser - The parser type to use for reading the file ('json' or 'yaml').
+ * @param property - The property name in the config containing workspace paths (defaults to 'workspaces').
+ * @returns Array of raw workspace path patterns.
+ * @example
+ * ```ts
+ * getWorkspacesRawPath('package.json', 'json', 'workspaces');
+ * getWorkspacesRawPath('pnpm-workspace.yaml', 'yaml', 'packages');
+ * ```
+ */
+export declare function getWorkspacesRawPath(configPath: string, parser: 'json' | 'yaml', property?: string): string[];
+//# sourceMappingURL=get-workspaces-raw-path.d.ts.map

package/dist/lib/get-workspaces-raw-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-workspaces-raw-path.d.ts","sourceRoot":"","sources":["../../src/lib/get-workspaces-raw-path.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH;;;;;;;;;;;;GAYG;AACH,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,GAAG,MAAM,EACvB,QAAQ,GAAE,MAAqB,GAC9B,MAAM,EAAE,CA0BV"}

package/dist/lib/get-workspaces-raw-path.js

@@ -0,0 +1,3 @@
+import { t as getWorkspacesRawPath } from "../get-workspaces-raw-path-Cg196xaD.js";
+
+export { getWorkspacesRawPath };

package/dist/lib/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @file index.ts
+ * Barrel export for atomic utility functions in commitlint-config-spellbookx.
+ */
+export { findGitRoot } from './find-git-root.js';
+export { getScopeDescription } from './get-scope-description.js';
+export { getScopes } from './get-scopes.js';
+export { getWorkspacesRawPath } from './get-workspaces-raw-path.js';
+export { packageJson } from './package-json.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/lib/index.js

@@ -0,0 +1,7 @@
+import { t as getScopes } from "../get-scopes-D9bIfVqN.js";
+import { getScopeDescription } from "./get-scope-description.js";
+import { findGitRoot } from "./find-git-root.js";
+import { t as getWorkspacesRawPath } from "../get-workspaces-raw-path-Cg196xaD.js";
+import packageJson from "./package-json.js";
+
+export { findGitRoot, getScopeDescription, getScopes, getWorkspacesRawPath, packageJson };

package/dist/lib/package-json.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @file package-json.ts
+ * Reads package metadata for commitlint-config-spellbookx.
+ */
+/**
+ * Parsed `package.json` metadata for `commitlint-config-spellbookx`.
+ */
+export declare const packageJson: {
+    name: string;
+    version: string;
+    peerDependencies: Record<string, string>;
+};
+export default packageJson;
+//# sourceMappingURL=package-json.d.ts.map

package/dist/lib/package-json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-json.d.ts","sourceRoot":"","sources":["../../src/lib/package-json.ts"],"names":[],"mappings":"AAAA;;;GAGG;AASH;;GAEG;AACH,eAAO,MAAM,WAAW,EAAoD;IAC1E,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/lib/package-json.js

@@ -0,0 +1,16 @@
+import { readFileSync } from "node:fs";
+import { URL, fileURLToPath } from "node:url";
+
+//#region src/lib/package-json.ts
+/**
+* @file package-json.ts
+* Reads package metadata for commitlint-config-spellbookx.
+*/
+const packagePath = fileURLToPath(new URL("../../package.json", import.meta.url));
+/**
+* Parsed `package.json` metadata for `commitlint-config-spellbookx`.
+*/
+const packageJson = JSON.parse(readFileSync(packagePath, "utf8"));
+
+//#endregion
+export { packageJson as default, packageJson };

package/dist/prompt.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @file prompt.ts
+ * Commitizen prompt questions and settings for interactive commits with cz-git.
+ */
+import type { UserConfig } from '@commitlint/types';
+/**
+ * Commitizen and cz-git interactive prompt configuration.
+ */
+export declare const prompt: UserConfig['prompt'];
+//# sourceMappingURL=prompt.d.ts.map

package/dist/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../src/prompt.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAIpD;;GAEG;AACH,eAAO,MAAM,MAAM,EAAE,UAAU,CAAC,QAAQ,CAsFvC,CAAC"}

package/dist/prompt.js

@@ -0,0 +1,99 @@
+import "./get-scopes-D9bIfVqN.js";
+import "./get-workspaces-raw-path-Cg196xaD.js";
+import { scopesEnum } from "./scopes.js";
+
+//#region src/prompt.ts
+/**
+* Commitizen and cz-git interactive prompt configuration.
+*/
+const prompt = {
+	settings: {
+		enableMultipleScopes: true,
+		scopeEnumSeparator: ","
+	},
+	messages: {
+		skip: ":skip",
+		max: "upper %d chars",
+		min: "%d chars at least",
+		emptyWarning: "can not be empty",
+		upperLimitWarning: "over limit",
+		lowerLimitWarning: "below limit"
+	},
+	questions: {
+		type: {
+			description: "Select the type of change that you're committing:",
+			enum: {
+				feat: {
+					description: "A new feature",
+					title: "Features",
+					emoji: "✨"
+				},
+				fix: {
+					description: "A bug fix",
+					title: "Bug Fixes",
+					emoji: "🐛"
+				},
+				docs: {
+					description: "Documentation only changes",
+					title: "Documentation",
+					emoji: "📚"
+				},
+				style: {
+					description: "Changes that do not affect meaning of the code",
+					title: "Styles",
+					emoji: "💎"
+				},
+				refactor: {
+					description: "Code refactoring",
+					title: "Code Refactoring",
+					emoji: "📦"
+				},
+				perf: {
+					description: "Performance improvements",
+					title: "Performance Improvements",
+					emoji: "🚀"
+				},
+				test: {
+					description: "Adding or fixing tests",
+					title: "Tests",
+					emoji: "🚨"
+				},
+				build: {
+					description: "Changes that affect build system",
+					title: "Builds",
+					emoji: "🛠"
+				},
+				ci: {
+					description: "Changes to CI config",
+					title: "Continuous Integrations",
+					emoji: "⚙️"
+				},
+				chore: {
+					description: "Other changes",
+					title: "Chores",
+					emoji: "♻️"
+				},
+				revert: {
+					description: "Reverts a previous commit",
+					title: "Reverts",
+					emoji: "🗑"
+				}
+			}
+		},
+		scope: {
+			description: "Select the scope(s) of the change (use arrow keys or space to select multiple)",
+			enum: scopesEnum
+		},
+		subject: { description: "Write a short, imperative tense description of the change" },
+		body: { description: "Provide a longer description of the change" },
+		isBreaking: { description: "Are there any breaking changes?" },
+		breakingBody: { description: "Describe the breaking changes with body" },
+		breaking: { description: "Describe the breaking changes" },
+		isIssueAffected: { description: "Does this change affect any open issues?" },
+		issuesBody: { description: "If issues are closed, enter longer description" },
+		issues: { description: "Add issue references (e.g., \"fix #123\")" }
+	}
+};
+
+//#endregion
+export { prompt };

package/dist/rules.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @file rules.ts
+ * Commitlint rule definitions for enforcing conventional commits.
+ */
+import type { QualifiedRules } from '@commitlint/types';
+/**
+ * Standard commitlint rules configuration.
+ */
+export declare const rules: QualifiedRules;
+//# sourceMappingURL=rules.d.ts.map

package/dist/rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../src/rules.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAKxD;;GAEG;AACH,eAAO,MAAM,KAAK,EAAE,cAQnB,CAAC"}

package/dist/rules.js

@@ -0,0 +1,45 @@
+import "./get-scopes-D9bIfVqN.js";
+import "./get-workspaces-raw-path-Cg196xaD.js";
+import { scopesArray } from "./scopes.js";
+import { COMMIT_TYPES } from "./constants/commit-types.js";
+
+//#region src/rules.ts
+/**
+* Standard commitlint rules configuration.
+*/
+const rules = {
+	"type-enum": [
+		2,
+		"always",
+		[...COMMIT_TYPES]
+	],
+	"scope-enum": [
+		2,
+		"always",
+		scopesArray
+	],
+	"subject-empty": [2, "never"],
+	"subject-full-stop": [
+		2,
+		"never",
+		"."
+	],
+	"header-max-length": [
+		2,
+		"always",
+		72
+	],
+	"body-max-line-length": [
+		2,
+		"always",
+		100
+	],
+	"footer-max-line-length": [
+		2,
+		"always",
+		100
+	]
+};
+
+//#endregion
+export { rules };

package/dist/scopes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @file scopes.ts
+ * Scopes constants and scope enumeration generator for commitlint and commitizen.
+ */
+/**
+ * Scope identifier for repository-wide or workspace-level changes.
+ */
+export declare const SCOPE_WORKSPACE = "workspace";
+/**
+ * Scope identifier for release and versioning commits.
+ */
+export declare const SCOPE_RELEASE = "release";
+/**
+ * Array of all valid commit scopes, including workspace, release, and discovered monorepo packages.
+ */
+export declare const scopesArray: string[];
+/**
+ * Record of scopes mapped to their human-readable descriptions for Commitizen interactive prompt.
+ */
+export declare const scopesEnum: Record<string, {
+    description: string;
+}>;
+//# sourceMappingURL=scopes.d.ts.map

package/dist/scopes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.d.ts","sourceRoot":"","sources":["../src/scopes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;GAEG;AACH,eAAO,MAAM,eAAe,cAAc,CAAC;AAE3C;;GAEG;AACH,eAAO,MAAM,aAAa,YAAY,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,MAAM,EAI/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAM,CAAC"}

package/dist/scopes.js

@@ -0,0 +1,38 @@
+import { t as getScopes } from "./get-scopes-D9bIfVqN.js";
+import { getScopeDescription } from "./lib/get-scope-description.js";
+import "./get-workspaces-raw-path-Cg196xaD.js";
+
+//#region src/scopes.ts
+/**
+* @file scopes.ts
+* Scopes constants and scope enumeration generator for commitlint and commitizen.
+*/
+/**
+* Scope identifier for repository-wide or workspace-level changes.
+*/
+const SCOPE_WORKSPACE = "workspace";
+/**
+* Scope identifier for release and versioning commits.
+*/
+const SCOPE_RELEASE = "release";
+/**
+* Array of all valid commit scopes, including workspace, release, and discovered monorepo packages.
+*/
+const scopesArray = [
+	SCOPE_WORKSPACE,
+	SCOPE_RELEASE,
+	...getScopes()
+];
+/**
+* Record of scopes mapped to their human-readable descriptions for Commitizen interactive prompt.
+*/
+const scopesEnum = {};
+for (const scope of scopesArray) Object.defineProperty(scopesEnum, scope, {
+	value: { description: getScopeDescription(scope) },
+	enumerable: true,
+	writable: true,
+	configurable: true
+});
+
+//#endregion
+export { SCOPE_RELEASE, SCOPE_WORKSPACE, scopesArray, scopesEnum };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commitlint-config-spellbookx",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "private": false,
   "description": "A shareable Commitlint configuration for enforcing conventional commits.",
   "keywords": [
@@ -29,32 +29,66 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./rules": {
+      "types": "./dist/rules.d.ts",
+      "import": "./dist/rules.js",
+      "default": "./dist/rules.js"
+    },
+    "./prompt": {
+      "types": "./dist/prompt.d.ts",
+      "import": "./dist/prompt.js",
+      "default": "./dist/prompt.js"
+    },
+    "./scopes": {
+      "types": "./dist/scopes.d.ts",
+      "import": "./dist/scopes.js",
+      "default": "./dist/scopes.js"
+    },
+    "./constants": {
+      "types": "./dist/constants/commit-types.d.ts",
+      "import": "./dist/constants/commit-types.js",
+      "default": "./dist/constants/commit-types.js"
+    },
+    "./lib": {
+      "types": "./dist/lib/index.d.ts",
+      "import": "./dist/lib/index.js",
+      "default": "./dist/lib/index.js"
+    },
+    "./lib/*": {
+      "types": "./dist/lib/*.d.ts",
+      "import": "./dist/lib/*.js",
+      "default": "./dist/lib/*.js"
     }
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@commitlint/cli": "^20.4.2",
-    "@commitlint/config-conventional": "^20.4.2",
-    "commitizen": "^4.3.1",
-    "conventional-changelog-conventionalcommits": "^9.1.0",
-    "cz-git": "^1.12.0",
+    "@commitlint/cli": "^21.2.4",
+    "@commitlint/config-conventional": "^21.2.4",
+    "commitizen": "^4.3.2",
+    "conventional-changelog-conventionalcommits": "^10.4.1",
+    "cz-git": "^1.14.0",
     "fast-glob": "^3.3.3",
     "js-yaml": "^4.1.1"
   },
   "devDependencies": {
-    "@commitlint/types": "^20.4.0",
+    "@commitlint/lint": "^21.2.4",
+    "@commitlint/load": "^21.2.4",
+    "@commitlint/types": "^21.2.3",
     "@dcdavidev/tsconfig": "^0.1.0",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^25.3.0",
     "rolldown": "1.0.0-rc.5",
-    "typescript": "5.9.3"
+    "typescript": "5.9.3",
+    "vitest": "^5.0.5"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "rolldown -c && tsc"
+    "build": "rolldown -c && tsc",
+    "test": "vitest run"
   }
 }

package/rolldown.config.ts

@@ -2,7 +2,19 @@ import { defineConfig } from 'rolldown';
 
 export default defineConfig([
   {
-    input: 'src/index.ts',
+    input: {
+      index: 'src/index.ts',
+      rules: 'src/rules.ts',
+      prompt: 'src/prompt.ts',
+      scopes: 'src/scopes.ts',
+      'constants/commit-types': 'src/constants/commit-types.ts',
+      'lib/index': 'src/lib/index.ts',
+      'lib/package-json': 'src/lib/package-json.ts',
+      'lib/find-git-root': 'src/lib/find-git-root.ts',
+      'lib/get-scope-description': 'src/lib/get-scope-description.ts',
+      'lib/get-scopes': 'src/lib/get-scopes.ts',
+      'lib/get-workspaces-raw-path': 'src/lib/get-workspaces-raw-path.ts',
+    },
     output: {
       format: 'esm',
       dir: 'dist',

package/src/constants/commit-types.ts

@@ -0,0 +1,26 @@
+/**
+ * @file commit-types.ts
+ * Standard Conventional Commit types supported by Spellbookx.
+ */
+
+/**
+ * List of allowed commit types based on the Conventional Commits specification.
+ */
+export const COMMIT_TYPES = [
+  'feat',
+  'fix',
+  'docs',
+  'style',
+  'refactor',
+  'perf',
+  'test',
+  'chore',
+  'ci',
+  'build',
+  'revert',
+] as const;
+
+/**
+ * Valid Conventional Commit type string.
+ */
+export type CommitType = (typeof COMMIT_TYPES)[number];