@codluv/versionguard 0.4.0 → 0.5.0

package/dist/init-wizard.d.ts

@@ -10,13 +10,22 @@
  * @since 0.3.0
  */
 export interface InitOptions {
+    /** Working directory path. */
     cwd: string;
+    /** Versioning type (semver or calver). */
     type?: 'semver' | 'calver';
+    /** CalVer format string. */
     format?: string;
+    /** Manifest source type. */
     manifest?: string;
+    /** Whether to install git hooks. */
     hooks?: boolean;
+    /** Whether to enable changelog validation. */
     changelog?: boolean;
+    /** Accept defaults without prompting. */
     yes?: boolean;
+    /** Overwrite existing config. */
+    force?: boolean;
 }
 /**
  * Runs the interactive setup wizard.
@@ -28,6 +37,11 @@ export interface InitOptions {
  * @param cwd - Project directory to initialize.
  * @returns The path to the created config file, or `null` if cancelled.
  *
+ * @example
+ * ```ts
+ * const configPath = await runWizard(process.cwd());
+ * ```
+ *
  * @public
  * @since 0.3.0
  */
@@ -42,6 +56,11 @@ export declare function runWizard(cwd: string): Promise<string | null>;
  * @param options - Headless initialization options.
  * @returns The path to the created config file.
  *
+ * @example
+ * ```ts
+ * const configPath = runHeadless({ cwd: process.cwd(), type: 'calver', format: 'YYYY.M.MICRO' });
+ * ```
+ *
  * @public
  * @since 0.3.0
  */

package/dist/init-wizard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"init-wizard.d.ts","sourceRoot":"","sources":["../src/init-wizard.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAWH;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA+EnE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAexD"}
+{"version":3,"file":"init-wizard.d.ts","sourceRoot":"","sources":["../src/init-wizard.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAWH;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC3B,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,8CAA8C;IAC9C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,yCAAyC;IACzC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,iCAAiC;IACjC,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA+EnE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAiBxD"}

package/dist/project-root.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Project root detection and boundary validation.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Result of project root detection.
+ *
+ * @public
+ * @since 0.4.0
+ */
+export interface ProjectRootResult {
+    /** Whether a project root was found. */
+    found: boolean;
+    /** The resolved project root directory, or the original cwd if not found. */
+    root: string;
+    /** Which marker file was found. */
+    marker?: string;
+    /** Whether the directory has a VersionGuard config. */
+    hasConfig: boolean;
+    /** Whether the directory is inside a git repository. */
+    hasGit: boolean;
+    /** Whether a version manifest file exists. */
+    hasManifest: boolean;
+}
+/**
+ * Walks up from `startDir` to find the nearest project root.
+ *
+ * @remarks
+ * Checks for VersionGuard config files first, then `.git`, then manifest files.
+ * Stops at the filesystem root if nothing is found.
+ *
+ * @param startDir - Directory to start searching from.
+ * @returns Detection result with the project root path and what was found.
+ *
+ * @example
+ * ```ts
+ * import { findProjectRoot } from 'versionguard';
+ *
+ * const result = findProjectRoot(process.cwd());
+ * if (!result.found) {
+ *   console.log('Not in a project directory');
+ * }
+ * ```
+ *
+ * @public
+ * @since 0.4.0
+ */
+export declare function findProjectRoot(startDir: string): ProjectRootResult;
+/**
+ * Formats a helpful error message when a command can't find a project.
+ *
+ * @remarks
+ * The message includes actionable hints such as running `versionguard init` or
+ * changing to a project root directory. Useful for CLI commands that require a
+ * VersionGuard-enabled project.
+ *
+ * @param cwd - The directory that was checked.
+ * @param command - The command that was attempted.
+ * @returns A formatted, helpful error message.
+ *
+ * @example
+ * ```ts
+ * import { formatNotProjectError } from 'versionguard';
+ *
+ * const msg = formatNotProjectError('/tmp/empty', 'validate');
+ * console.error(msg);
+ * ```
+ *
+ * @public
+ * @since 0.4.0
+ */
+export declare function formatNotProjectError(cwd: string, command: string): string;
+//# sourceMappingURL=project-root.d.ts.map

package/dist/project-root.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-root.d.ts","sourceRoot":"","sources":["../src/project-root.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAwBH;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,wCAAwC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,SAAS,EAAE,OAAO,CAAC;IACnB,wDAAwD;IACxD,MAAM,EAAE,OAAO,CAAC;IAChB,8CAA8C;IAC9C,WAAW,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAkCnE;AA2BD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAe1E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codluv/versionguard",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Strict versioning enforcement for SemVer and CalVer with git hooks, changelog validation, and file sync from package.json",
   "type": "module",
   "main": "./dist/index.js",
@@ -76,7 +76,7 @@
     "@changesets/changelog-github": "^0.6.0",
     "@changesets/cli": "^2.30.0",
     "@eslint/js": "^9.37.0",
-    "@forge-ts/cli": "0.19.4",
+    "@forge-ts/cli": "^0.21.1",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "^24.6.0",
     "@vitest/coverage-v8": "^4.0.7",