fork-version 1.4.6

package/dist/index.d.ts

@@ -0,0 +1,290 @@
+import { z } from 'zod';
+import { ReleaseType } from 'semver';
+
+declare const ForkConfigSchema: z.ZodObject<{
+    /**
+     * The path where the changes should be calculated from.
+     * @default
+     * ```js
+     * process.cwd()
+     * ```
+     */
+    changePath: z.ZodString;
+    /**
+     * The name of the changelog file.
+     * @default "CHANGELOG.md"
+     */
+    changelog: z.ZodString;
+    /**
+     * Files to be updated.
+     * @default
+     * ```js
+     * ["bower.json", "manifest.json", "npm-shrinkwrap.json", "package-lock.json", "package.json"]
+     * ```
+     */
+    outFiles: z.ZodArray<z.ZodString, "many">;
+    /**
+     * The header to be used in 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 git tag that will be taken into account during the comparison.
+     *
+     * For instance if your version tag is prefixed by `version/` instead of `v` you would
+     * have to specify `tagPrefix: "version/"`.
+     * @default `v`
+     */
+    tagPrefix: z.ZodString;
+    /**
+     * Make a pre-release with optional label to specify a tag id.
+     * @example true, "alpha", "beta", "rc", etc.
+     * @default undefined
+     */
+    preReleaseTag: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
+    /**
+     * Commit all staged changes, not just files updated by fork-version.
+     * @default false
+     */
+    commitAll: z.ZodBoolean;
+    /**
+     * If true, no output will be written to disk or committed.
+     * @default false
+     */
+    dryRun: z.ZodBoolean;
+    /**
+     * If true and we cant find a version in an `outFiles`, we'll fallback and attempt
+     * to use the latest git tag for the current version.
+     * @default true
+     */
+    gitTagFallback: z.ZodBoolean;
+    /**
+     * Should we sign the git commit using GPG?
+     * @see {@link https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--Sltkeyidgt GPG Sign Commits}
+     * @default false
+     */
+    sign: z.ZodBoolean;
+    /**
+     * If true, no output will be written to stdout.
+     * @default false
+     */
+    silent: z.ZodBoolean;
+    /**
+     * If true, allow git to run git commit hooks.
+     * @default false
+     */
+    verify: z.ZodBoolean;
+    /**
+     * If set, we'll use this version number instead of trying to find it in an `outFiles`.
+     * @example "1.0.0"
+     * @default undefined
+     */
+    currentVersion: z.ZodOptional<z.ZodString>;
+    /**
+     * If set, we'll attempt to update the version number to this version.
+     * @example "2.0.0"
+     * @default undefined
+     */
+    nextVersion: z.ZodOptional<z.ZodString>;
+    /**
+     * Override the default conventional-changelog preset configuration.
+     */
+    changelogPresetConfig: z.ZodObject<{
+        /**
+         * An array of `type` objects representing the explicitly supported commit message types, and whether they should show up in generated `CHANGELOG`s.
+         */
+        types: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+            section: z.ZodOptional<z.ZodString>;
+            hidden: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }, {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }>, "many">>;
+        /**
+         * A URL representing a specific commit at a hash.
+         */
+        commitUrlFormat: z.ZodOptional<z.ZodString>;
+        /**
+         * A URL representing the comparison between two git SHAs.
+         */
+        compareUrlFormat: z.ZodOptional<z.ZodString>;
+        /**
+         * A URL representing the issue format (allowing a different URL format to be swapped in for Gitlab, Bitbucket, etc).
+         */
+        issueUrlFormat: z.ZodOptional<z.ZodString>;
+        /**
+         * A URL representing the a user's profile URL on GitHub, Gitlab, etc. This URL is used for substituting @bcoe with https://github.com/bcoe in commit messages.
+         */
+        userUrlFormat: z.ZodOptional<z.ZodString>;
+        /**
+         * A string to be used to format the auto-generated release commit message.
+         */
+        releaseCommitMessageFormat: z.ZodOptional<z.ZodString>;
+        /**
+         * An array of prefixes used to detect references to issues
+         */
+        issuePrefixes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        types?: {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }[] | undefined;
+        commitUrlFormat?: string | undefined;
+        compareUrlFormat?: string | undefined;
+        issueUrlFormat?: string | undefined;
+        userUrlFormat?: string | undefined;
+        releaseCommitMessageFormat?: string | undefined;
+        issuePrefixes?: string[] | undefined;
+    }, {
+        types?: {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }[] | undefined;
+        commitUrlFormat?: string | undefined;
+        compareUrlFormat?: string | undefined;
+        issueUrlFormat?: string | undefined;
+        userUrlFormat?: string | undefined;
+        releaseCommitMessageFormat?: string | undefined;
+        issuePrefixes?: string[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    changePath: string;
+    changelog: string;
+    outFiles: string[];
+    header: string;
+    tagPrefix: string;
+    commitAll: boolean;
+    dryRun: boolean;
+    gitTagFallback: boolean;
+    sign: boolean;
+    silent: boolean;
+    verify: boolean;
+    changelogPresetConfig: {
+        types?: {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }[] | undefined;
+        commitUrlFormat?: string | undefined;
+        compareUrlFormat?: string | undefined;
+        issueUrlFormat?: string | undefined;
+        userUrlFormat?: string | undefined;
+        releaseCommitMessageFormat?: string | undefined;
+        issuePrefixes?: string[] | undefined;
+    };
+    preReleaseTag?: string | boolean | undefined;
+    currentVersion?: string | undefined;
+    nextVersion?: string | undefined;
+}, {
+    changePath: string;
+    changelog: string;
+    outFiles: string[];
+    header: string;
+    tagPrefix: string;
+    commitAll: boolean;
+    dryRun: boolean;
+    gitTagFallback: boolean;
+    sign: boolean;
+    silent: boolean;
+    verify: boolean;
+    changelogPresetConfig: {
+        types?: {
+            type: string;
+            section?: string | undefined;
+            hidden?: boolean | undefined;
+        }[] | undefined;
+        commitUrlFormat?: string | undefined;
+        compareUrlFormat?: string | undefined;
+        issueUrlFormat?: string | undefined;
+        userUrlFormat?: string | undefined;
+        releaseCommitMessageFormat?: string | undefined;
+        issuePrefixes?: string[] | undefined;
+    };
+    preReleaseTag?: string | boolean | undefined;
+    currentVersion?: string | undefined;
+    nextVersion?: string | undefined;
+}>;
+type ForkConfig = z.infer<typeof ForkConfigSchema> & {
+    /**
+     * Log function, can be used to override the default `console.log` function
+     * to log to a file or another service.
+     * @default console.log
+     */
+    log: (...args: unknown[]) => void;
+    /**
+     * Error logger function, can be used to override the default `console.error`
+     * function to log to a file or another service.
+     * @default console.error
+     */
+    error: (...args: unknown[]) => void;
+    /**
+     * Debug logger function, by default this is a noop function, but can be replaced
+     * with a custom logger function or `console.info` to print output.
+     * @default  () => {}
+     */
+    debug: (...args: unknown[]) => void;
+};
+declare function defineConfig(config: Partial<ForkConfig>): Partial<ForkConfig>;
+
+type FileState = {
+    name: string;
+    path: string;
+    type: "package-file" | ({} & string);
+    version: string;
+    isPrivate: boolean;
+};
+type CurrentVersion = {
+    currentVersion: string;
+    files: FileState[];
+};
+type NextVersion = {
+    nextVersion: string;
+    level?: number;
+    preMajor?: boolean;
+    reason?: string;
+    releaseType?: ReleaseType;
+};
+type BumpVersion = CurrentVersion & NextVersion;
+declare function bumpVersion(options: ForkConfig): Promise<BumpVersion>;
+
+type CreateChangelog = {
+    path: string;
+    exists: boolean;
+};
+type UpdateChangelog = {
+    changelog: CreateChangelog;
+    oldContent: string;
+    newContent: string;
+};
+declare function updateChangelog(options: ForkConfig, bumpResult: BumpVersion): Promise<UpdateChangelog>;
+
+type CommitChanges = {
+    filesToCommit: string[];
+    gitAddOutput?: string;
+    gitCommitOutput?: string;
+};
+declare function commitChanges(options: ForkConfig, bumpResult: BumpVersion): Promise<CommitChanges>;
+
+type TagChanges = {
+    gitTagOutput: string;
+    currentBranchName: string;
+    hasPublicPackageFile: boolean;
+    pushMessage: string;
+    publishMessage: string;
+};
+declare function tagChanges(options: ForkConfig, bumpResult: BumpVersion): Promise<TagChanges>;
+
+export { BumpVersion, ForkConfig, bumpVersion, commitChanges, defineConfig, tagChanges, updateChangelog };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { bumpVersion, commitChanges, defineConfig, tagChanges, updateChangelog } from './chunk-STAHBMPI.js';
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,78 @@
+{
+	"name": "fork-version",
+	"version": "1.4.6",
+	"license": "ISC",
+	"description": "Replacement for standard version written with modern syntax",
+	"homepage": "https://github.com/eglavin/fork-version",
+	"bugs": {
+		"url": "https://github.com/eglavin/fork-version/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/eglavin/fork-version.git"
+	},
+	"author": {
+		"name": "Eanna Glavin",
+		"url": "https://eglavin.com"
+	},
+	"type": "module",
+	"main": "dist/index.cjs",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"import": "./dist/index.js",
+			"require": "./dist/index.cjs",
+			"types": "./dist/index.d.ts"
+		},
+		"./cli": {
+			"import": "./dist/cli.js",
+			"require": "./dist/cli.cjs",
+			"types": "./dist/cli.d.ts"
+		},
+		"./package.json": "./package.json"
+	},
+	"bin": {
+		"fork-version": "./dist/cli.js"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsup",
+		"dev": "tsup --watch",
+		"start": "node dist/cli.js",
+		"lint:style": "prettier --write \"src/**/*.ts\"",
+		"lint:code": "eslint --fix \"src/**/*.ts\""
+	},
+	"dependencies": {
+		"bundle-require": "4.0.1",
+		"conventional-changelog": "5.1.0",
+		"conventional-changelog-config-spec": "2.1.0",
+		"conventional-changelog-conventionalcommits": "7.0.2",
+		"conventional-recommended-bump": "9.0.0",
+		"detect-indent": "6.1.0",
+		"detect-newline": "3.1.0",
+		"esbuild": "0.19.3",
+		"git-semver-tags": "7.0.1",
+		"joycon": "3.1.1",
+		"semver": "7.5.4",
+		"zod": "3.22.2"
+	},
+	"devDependencies": {
+		"@types/conventional-changelog-config-spec": "2.1.3",
+		"@types/git-raw-commits": "2.0.2",
+		"@types/json-schema": "7.0.13",
+		"@types/node": "20.6.2",
+		"@types/semver": "7.5.2",
+		"@typescript-eslint/eslint-plugin": "6.7.2",
+		"@typescript-eslint/parser": "6.7.2",
+		"eslint": "8.49.0",
+		"eslint-config-prettier": "9.0.0",
+		"eslint-plugin-prettier": "5.0.0",
+		"globals": "13.21.0",
+		"prettier": "3.0.3",
+		"tsup": "7.2.0",
+		"typescript": "5.2.2"
+	}
+}