commitlint-config-spellbookx 1.1.2 → 1.3.0

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

@@ -1,16 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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

@@ -1,30 +0,0 @@
-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

@@ -1,21 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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

@@ -1,35 +0,0 @@
-//#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

@@ -1,16 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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

@@ -1,4 +0,0 @@
-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

@@ -1,19 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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

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

package/dist/scopes.d.ts

@@ -1,23 +0,0 @@
-/**
- * @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

@@ -1 +0,0 @@
-{"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

@@ -1,38 +0,0 @@
-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/src/constants/commit-types.ts

@@ -1,26 +0,0 @@
-/**
- * @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];

package/src/lib/find-git-root.ts

@@ -1,31 +0,0 @@
-/**
- * @file find-git-root.ts
- * Utility to locate the root directory of a git repository.
- */
-
-import { existsSync } from 'node:fs';
-import path from 'node:path';
-
-/**
- * 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 function findGitRoot(startDir: string = process.cwd()): string | null {
-  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;
-  }
-}

package/src/lib/get-scope-description.ts

@@ -1,38 +0,0 @@
-/**
- * @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'
- * ```
- */
-export function getScopeDescription(scope: string): string {
-  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`;
-}

package/src/lib/get-scopes.ts

@@ -1,89 +0,0 @@
-/**
- * @file get-scopes.ts
- * Discovers and gathers workspace package scopes in a monorepo or standard repository.
- */
-
-import { existsSync, readFileSync } from 'node:fs';
-import path from 'node:path';
-
-import fg from 'fast-glob';
-
-import { findGitRoot } from './find-git-root.js';
-import { getWorkspacesRawPath } from './get-workspaces-raw-path.js';
-
-/**
- * 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 function getScopes(cwd: string = process.cwd()): string[] {
-  const root = findGitRoot(cwd);
-
-  if (!root) {
-    throw new Error('[FATAL] Not a repository.');
-  }
-
-  const rawWorkspaces: string[] = [];
-
-  const packageJsonPath = path.join(root, 'package.json');
-  rawWorkspaces.push(
-    ...getWorkspacesRawPath(packageJsonPath, 'json', 'workspaces')
-  );
-
-  const pnpmWorkspaceYamlPath = path.join(root, 'pnpm-workspace.yaml');
-  rawWorkspaces.push(
-    ...getWorkspacesRawPath(pnpmWorkspaceYamlPath, 'yaml', 'packages')
-  );
-
-  const pnpmWorkspaceYmlPath = path.join(root, 'pnpm-workspace.yml');
-  rawWorkspaces.push(
-    ...getWorkspacesRawPath(pnpmWorkspaceYmlPath, 'yaml', 'packages')
-  );
-
-  const lernaJsonPath = path.join(root, 'lerna.json');
-  rawWorkspaces.push(
-    ...getWorkspacesRawPath(lernaJsonPath, 'json', 'packages')
-  );
-
-  const workspaces = new Set<string>();
-
-  const rootPackageJsonPath = path.join(root, 'package.json');
-  if (existsSync(rootPackageJsonPath) && !rawWorkspaces.includes('.')) {
-    rawWorkspaces.push('.');
-  }
-
-  for (const pattern of rawWorkspaces) {
-    const entries = fg.sync(pattern, {
-      cwd: root,
-      onlyDirectories: true,
-      absolute: true,
-    });
-
-    for (const dirPath of entries) {
-      const packageJsonPath = path.join(dirPath, 'package.json');
-
-      if (existsSync(packageJsonPath)) {
-        try {
-          const package_ = JSON.parse(
-            readFileSync(packageJsonPath, 'utf8')
-          ) as {
-            name?: string;
-          };
-
-          if (package_.name) {
-            workspaces.add(package_.name);
-          }
-        } catch {
-          // ignore invalid package.json files
-        }
-      }
-    }
-  }
-
-  return [...workspaces];
-}

package/src/lib/get-workspaces-raw-path.ts

@@ -1,53 +0,0 @@
-/**
- * @file get-workspaces-raw-path.ts
- * Parser for extracting workspace path globs from JSON and YAML configuration files.
- */
-
-import { existsSync, readFileSync } from 'node:fs';
-
-import { load } from 'js-yaml';
-
-/**
- * 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 function getWorkspacesRawPath(
-  configPath: string,
-  parser: 'json' | 'yaml',
-  property: string = 'workspaces'
-): string[] {
-  const rawWorkspacesPaths: string[] = [];
-
-  if (existsSync(configPath)) {
-    const asString = readFileSync(configPath, 'utf8');
-
-    let parsed: Record<string, unknown>;
-
-    if (parser === 'json') {
-      parsed = JSON.parse(asString);
-    } else if (parser === 'yaml') {
-      parsed = load(asString) as Record<string, unknown>;
-    } else {
-      throw new Error(`Unsupported parser type: ${parser}`);
-    }
-
-    const workspaces = parsed[property];
-
-    if (Array.isArray(workspaces)) {
-      for (const project of workspaces) {
-        rawWorkspacesPaths.push(project);
-      }
-    }
-  }
-
-  return rawWorkspacesPaths;
-}

package/src/scopes.ts

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