fork-version 2.0.1 → 2.0.2

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkGQO6W4DN_cjs = require('./chunk-GQO6W4DN.cjs');
+var chunkRJRVHSEG_cjs = require('./chunk-RJRVHSEG.cjs');
 
 // src/config/define-config.ts
 function defineConfig(config) {
@@ -9,59 +9,59 @@ function defineConfig(config) {
 
 Object.defineProperty(exports, "CommitParser", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.CommitParser; }
+  get: function () { return chunkRJRVHSEG_cjs.CommitParser; }
 });
 Object.defineProperty(exports, "FileManager", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.FileManager; }
+  get: function () { return chunkRJRVHSEG_cjs.FileManager; }
 });
 Object.defineProperty(exports, "ForkConfigSchema", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.ForkConfigSchema; }
+  get: function () { return chunkRJRVHSEG_cjs.ForkConfigSchema; }
 });
 Object.defineProperty(exports, "Git", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.Git; }
+  get: function () { return chunkRJRVHSEG_cjs.Git; }
 });
 Object.defineProperty(exports, "Logger", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.Logger; }
+  get: function () { return chunkRJRVHSEG_cjs.Logger; }
 });
 Object.defineProperty(exports, "commitChanges", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.commitChanges; }
+  get: function () { return chunkRJRVHSEG_cjs.commitChanges; }
 });
 Object.defineProperty(exports, "createParserOptions", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.createParserOptions; }
+  get: function () { return chunkRJRVHSEG_cjs.createParserOptions; }
 });
 Object.defineProperty(exports, "filterRevertedCommits", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.filterRevertedCommits; }
+  get: function () { return chunkRJRVHSEG_cjs.filterRevertedCommits; }
 });
 Object.defineProperty(exports, "getCommitsSinceTag", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.getCommitsSinceTag; }
+  get: function () { return chunkRJRVHSEG_cjs.getCommitsSinceTag; }
 });
 Object.defineProperty(exports, "getCurrentVersion", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.getCurrentVersion; }
+  get: function () { return chunkRJRVHSEG_cjs.getCurrentVersion; }
 });
 Object.defineProperty(exports, "getNextVersion", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.getNextVersion; }
+  get: function () { return chunkRJRVHSEG_cjs.getNextVersion; }
 });
 Object.defineProperty(exports, "getUserConfig", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.getUserConfig; }
+  get: function () { return chunkRJRVHSEG_cjs.getUserConfig; }
 });
 Object.defineProperty(exports, "tagChanges", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.tagChanges; }
+  get: function () { return chunkRJRVHSEG_cjs.tagChanges; }
 });
 Object.defineProperty(exports, "updateChangelog", {
   enumerable: true,
-  get: function () { return chunkGQO6W4DN_cjs.updateChangelog; }
+  get: function () { return chunkRJRVHSEG_cjs.updateChangelog; }
 });
 exports.defineConfig = defineConfig;
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/config/define-config.ts"],"names":[],"mappings":";;;;;AAKO,SAAS,aAAa,MAAwB,EAAA;AACpD,EAAO,OAAA,MAAA;AACR","file":"index.cjs","sourcesContent":["import type { Config } from \"./types\";\n\n/**\n * [Fork-Version - Config Properties](https://github.com/eglavin/fork-version/blob/main/README.md#config-properties)\n */\nexport function defineConfig(config: Config): Config {\n\treturn config;\n}\n"]}
+{"version":3,"sources":["../src/config/define-config.ts"],"names":[],"mappings":";;;;;AAKO,SAAS,aAAa,MAAA,EAAwB;AACpD,EAAA,OAAO,MAAA;AACR","file":"index.cjs","sourcesContent":["import type { Config } from \"./types\";\n\n/**\n * [Fork-Version - Config Properties](https://github.com/eglavin/fork-version/blob/main/README.md#config-properties)\n */\nexport function defineConfig(config: Config): Config {\n\treturn config;\n}\n"]}

package/dist/index.d.cts

@@ -65,325 +65,46 @@ interface ParserOptions {
 declare function createParserOptions(userOptions?: Partial<ParserOptions>): ParserOptions;
 
 declare const ForkConfigSchema: z.ZodObject<{
-    /**
-     * If set, Fork-Version will print the current version and exit.
-     * @default false
-     */
     inspectVersion: z.ZodBoolean;
-    /**
-     * List of the files to be updated.
-     * @default
-     * ```js
-     * ["bower.json", "deno.json", "deno.jsonc", "jsr.json", "jsr.jsonc", "manifest.json", "npm-shrinkwrap.json", "package-lock.json", "package.json"]
-     * ```
-     */
-    files: z.ZodArray<z.ZodString, "many">;
-    /**
-     * Glob pattern to match files to be updated.
-     *
-     * Internally we're using [glob](https://github.com/isaacs/node-glob) to match files.
-     *
-     * Read more about the pattern syntax [here](https://github.com/isaacs/node-glob/tree/v10.3.12?tab=readme-ov-file#glob-primer).
-     *
-     * @default undefined
-     * @example "*.json"
-     */
+    files: z.ZodArray<z.ZodString>;
     glob: z.ZodOptional<z.ZodString>;
-    /**
-     * The path Fork-Version will run from.
-     * @default
-     * ```js
-     * process.cwd()
-     * ```
-     */
     path: z.ZodString;
-    /**
-     * Name of the changelog file.
-     * @default "CHANGELOG.md"
-     */
     changelog: z.ZodString;
-    /**
-     * The header text for the changelog.
-     * @default
-     * ```markdown
-     * # Changelog
-     *
-     * All notable changes to this project will be documented in this file. See [fork-version](https://github.com/eglavin/fork-version) for commit guidelines.
-     * ```
-     */
     header: z.ZodString;
-    /**
-     * Specify a prefix for the created tag.
-     *
-     * For instance if your version tag is prefixed by "version/" instead of "v" you have to specify
-     * `tagPrefix: "version/"`.
-     *
-     * `tagPrefix` can also be used for a monorepo environment where you might want to deploy
-     * multiple package from the same repository. In this case you can specify a prefix for
-     * each package:
-     *
-     * | Example Value            | Tag Created                   |
-     * |:-------------------------|:------------------------------|
-     * | ""                       | `1.2.3`                       |
-     * | "version/"               | `version/1.2.3`               |
-     * | "@eglavin/fork-version-" | `@eglavin/fork-version-1.2.3` |
-     *
-     * @example "", "version/", "@eglavin/fork-version-"
-     * @default "v"
-     */
     tagPrefix: z.ZodString;
-    /**
-     * Make a pre-release with optional label if given value is a string.
-     *
-     * | Example Value | Produced Version |
-     * |:--------------|:-----------------|
-     * | true          | `1.2.3-0`        |
-     * | "alpha"       | `1.2.3-alpha-0`  |
-     * | "beta"        | `1.2.3-beta-0`   |
-     *
-     * @example true, "alpha", "beta", "rc"
-     * @default undefined
-     */
     preRelease: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
-    /**
-     * If set, Fork-Version will use this version instead of trying to determine one.
-     * @example "1.0.0"
-     * @default undefined
-     */
     currentVersion: z.ZodOptional<z.ZodString>;
-    /**
-     * If set, Fork-Version will attempt to update to this version, instead of incrementing using "conventional-commit".
-     * @example "2.0.0"
-     * @default undefined
-     */
     nextVersion: z.ZodOptional<z.ZodString>;
-    /**
-     * Release as increments the version by the specified level. Overrides the default behaviour of "conventional-commit".
-     * @example "major", "minor", "patch"
-     * @default undefined
-     */
-    releaseAs: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"major">, z.ZodLiteral<"minor">, z.ZodLiteral<"patch">]>>;
-    /**
-     * Don't throw an error if multiple versions are found in the given files.
-     * @default true
-     */
+    releaseAs: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"major">, z.ZodLiteral<"minor">, z.ZodLiteral<"patch">]>>;
     allowMultipleVersions: z.ZodBoolean;
-    /**
-     * Commit all changes, not just files updated by Fork-Version.
-     * @default false
-     */
     commitAll: z.ZodBoolean;
-    /**
-     * By default the conventional-changelog spec will only add commit types of `feat` and `fix` to the generated changelog.
-     * If this flag is set, all [default commit types](https://github.com/conventional-changelog/conventional-changelog-config-spec/blob/238093090c14bd7d5151eb5316e635623ce633f9/versions/2.2.0/schema.json#L18)
-     * will be added to the changelog.
-     * @default false
-     */
     changelogAll: z.ZodBoolean;
-    /**
-     * Output debug information.
-     * @default false
-     */
     debug: z.ZodBoolean;
-    /**
-     * No output will be written to disk or committed.
-     * @default false
-     */
     dryRun: z.ZodBoolean;
-    /**
-     * Run without logging to the terminal.
-     * @default false
-     */
     silent: z.ZodBoolean;
-    /**
-     * If unable to find a version in the given files, fallback and attempt to use the latest git tag.
-     * @default true
-     */
     gitTagFallback: z.ZodBoolean;
-    /**
-     * If true, git will sign the commit with the systems GPG key.
-     * @see {@link https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--Sltkeyidgt Git - GPG Sign Commits}
-     * @default false
-     */
     sign: z.ZodBoolean;
-    /**
-     * If true, git will run user defined git hooks before committing.
-     * @see {@link https://git-scm.com/docs/githooks Git - Git Hooks}
-     * @default false
-     */
     verify: z.ZodBoolean;
-    /**
-     * Skip the bump step.
-     * @default false
-     */
     skipBump: z.ZodBoolean;
-    /**
-     * Skip the changelog step.
-     * @default false
-     */
     skipChangelog: z.ZodBoolean;
-    /**
-     * Skip the commit step.
-     * @default false
-     */
     skipCommit: z.ZodBoolean;
-    /**
-     * Skip the tag step.
-     * @default false
-     */
     skipTag: z.ZodBoolean;
-    /**
-     * Override the default "conventional-changelog-conventionalcommits" preset configuration.
-     */
     changelogPresetConfig: z.ZodObject<{
         types: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            /**
-             * The type of commit message.
-             * @example "feat", "fix", "chore", etc..
-             */
             type: z.ZodString;
-            /**
-             * The scope of the commit message.
-             */
             scope: z.ZodOptional<z.ZodString>;
-            /**
-             * The section of the `CHANGELOG` the commit should show up in.
-             */
             section: z.ZodOptional<z.ZodString>;
-            /**
-             * Should show in the generated changelog message?
-             */
             hidden: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }, {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }>, "many">>;
+        }, z.core.$strip>>>;
         commitUrlFormat: z.ZodOptional<z.ZodString>;
         compareUrlFormat: z.ZodOptional<z.ZodString>;
         issueUrlFormat: z.ZodOptional<z.ZodString>;
         userUrlFormat: z.ZodOptional<z.ZodString>;
         releaseCommitMessageFormat: z.ZodOptional<z.ZodString>;
-        issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        commitUrlFormat?: string | undefined;
-        compareUrlFormat?: string | undefined;
-        issueUrlFormat?: string | undefined;
-        userUrlFormat?: string | undefined;
-        releaseCommitMessageFormat?: string | undefined;
-        types?: {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }[] | undefined;
-        issuePrefixes?: string[] | undefined;
-    }, {
-        commitUrlFormat?: string | undefined;
-        compareUrlFormat?: string | undefined;
-        issueUrlFormat?: string | undefined;
-        userUrlFormat?: string | undefined;
-        releaseCommitMessageFormat?: string | undefined;
-        types?: {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }[] | undefined;
-        issuePrefixes?: string[] | undefined;
-    }>;
-    /**
-     * Add a suffix to the release commit message.
-     * @example "[skip ci]"
-     */
+        issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
     releaseMessageSuffix: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    inspectVersion: boolean;
-    files: string[];
-    path: string;
-    changelog: string;
-    header: string;
-    tagPrefix: string;
-    allowMultipleVersions: boolean;
-    commitAll: boolean;
-    changelogAll: boolean;
-    debug: boolean;
-    dryRun: boolean;
-    silent: boolean;
-    gitTagFallback: boolean;
-    sign: boolean;
-    verify: boolean;
-    skipBump: boolean;
-    skipChangelog: boolean;
-    skipCommit: boolean;
-    skipTag: boolean;
-    changelogPresetConfig: {
-        commitUrlFormat?: string | undefined;
-        compareUrlFormat?: string | undefined;
-        issueUrlFormat?: string | undefined;
-        userUrlFormat?: string | undefined;
-        releaseCommitMessageFormat?: string | undefined;
-        types?: {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }[] | undefined;
-        issuePrefixes?: string[] | undefined;
-    };
-    glob?: string | undefined;
-    preRelease?: string | boolean | undefined;
-    currentVersion?: string | undefined;
-    nextVersion?: string | undefined;
-    releaseAs?: "major" | "minor" | "patch" | undefined;
-    releaseMessageSuffix?: string | undefined;
-}, {
-    inspectVersion: boolean;
-    files: string[];
-    path: string;
-    changelog: string;
-    header: string;
-    tagPrefix: string;
-    allowMultipleVersions: boolean;
-    commitAll: boolean;
-    changelogAll: boolean;
-    debug: boolean;
-    dryRun: boolean;
-    silent: boolean;
-    gitTagFallback: boolean;
-    sign: boolean;
-    verify: boolean;
-    skipBump: boolean;
-    skipChangelog: boolean;
-    skipCommit: boolean;
-    skipTag: boolean;
-    changelogPresetConfig: {
-        commitUrlFormat?: string | undefined;
-        compareUrlFormat?: string | undefined;
-        issueUrlFormat?: string | undefined;
-        userUrlFormat?: string | undefined;
-        releaseCommitMessageFormat?: string | undefined;
-        types?: {
-            type: string;
-            scope?: string | undefined;
-            section?: string | undefined;
-            hidden?: boolean | undefined;
-        }[] | undefined;
-        issuePrefixes?: string[] | undefined;
-    };
-    glob?: string | undefined;
-    preRelease?: string | boolean | undefined;
-    currentVersion?: string | undefined;
-    nextVersion?: string | undefined;
-    releaseAs?: "major" | "minor" | "patch" | undefined;
-    releaseMessageSuffix?: string | undefined;
-}>;
+}, z.core.$strip>;
 
 type ForkConfig = z.infer<typeof ForkConfigSchema>;
 type Config = Partial<ForkConfig>;