bumpp 7.2.0 → 8.2.0

package/dist/cli/index.mjs

@@ -5,16 +5,14 @@ import {
   isReleaseType,
   require_log_symbols,
   versionBump
-} from "../chunk-2TP63A7S.mjs";
+} from "../chunk-DW6HTJ47.mjs";
 
 // src/cli/index.ts
 init_esm_shims();
 var import_log_symbols = __toESM(require_log_symbols());
 
 // package.json
-var name = "bumpp";
-var version = "7.2.0";
-var description = "Automatically (or with prompts) bump your version number, commit changes, tag, and push to Git";
+var version = "8.2.0";
 
 // src/cli/exit-code.ts
 init_esm_shims();
@@ -25,104 +23,17 @@ var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
   return ExitCode2;
 })(ExitCode || {});
 
-// src/cli/help.ts
-init_esm_shims();
-var usageText = `
-Usage: bumpp [release] [options] [files...]
-
-release:
-  The release version or type.  Can be one of the following:
-   - A semver version number (ex: 1.23.456)
-   - prompt: Prompt for the version number (this is the default)
-   - major: Increase major version
-   - minor: Increase minor version
-   - patch: Increase patch version
-   - premajor: Increase major version, pre-release
-   - preminor: Increase preminor version, pre-release
-   - prepatch: Increase prepatch version, pre-release
-   - prerelease: Increase prerelease version
-
-options:
-  --preid <name>            The identifier for prerelease versions.
-                            Defaults to "beta".
-
-  -c, --commit [message]    Commit changed files to Git.
-                            Defaults to "release vX.X.X".
-
-  -t, --tag [tag]           Tag the commit in Git.
-                            The Default tag is "vX.X.X"
-
-  -p, --push                Push the Git commit.
-
-  -a, --all                 Commit/tag/push ALL pending files,
-                            not just the ones that were bumped.
-                            (same as "git commit -a")
-
-  --no-verify               Bypass Git commit hooks
-                            (same as "git commit --no-verify")
-
-  -v, --version             Show the version number
-
-  -x, --execute             Excute additional command after bumping and before commiting
-
-  -q, --quiet               Suppress unnecessary output
-
-  -h, --help                Show usage information
-
-  --ignore-scripts          Bypass version scripts
-
-files...
-  One or more files and/or globs to bump (ex: README.md *.txt docs/**/*).
-  Defaults to package.json and package-lock.json.
-
-Examples:
-
-  bumpp patch
-
-    Bumps the patch version number in package.json and package-lock.json.
-    Nothing is committed to git.
-
-  bumpp major --commit
-
-    Bumps the major version number in package.json and package-lock.json.
-    Commits package.json and package-lock.json to git, but does not tag the commit.
-
-  bumpp -tpa README.md
-
-    Prompts for the new version number and updates package.json, package-lock.json, and README.md.
-    Commits ALL modified files to git, tags the commit, and pushes the commit.
-
-  bumpp 4.27.9934 --tag "Version " bower.json docs/**/*.md
-
-    Sets the version number to 4.27.9934 in package.json, package-lock.json, bower.json,
-    and all markdown files in the "docs" directory.  Commits the updated files to git,
-    and tags the commit as "Version 4.27.9934".
-`;
-var helpText = `
-${name} v${version} - ${description}
-${usageText}`;
-
 // src/cli/parse-args.ts
 init_esm_shims();
-import commandLineArgs from "command-line-args";
 import { valid as isValidVersion } from "semver";
-function parseArgs(argv) {
+import cac from "cac";
+function parseArgs() {
   try {
-    let args = commandLineArgs([
-      { name: "preid", type: String },
-      { name: "commit", alias: "c", type: String },
-      { name: "tag", alias: "t", type: String },
-      { name: "push", alias: "p", type: Boolean },
-      { name: "all", alias: "a", type: Boolean },
-      { name: "no-verify", type: Boolean },
-      { name: "quiet", alias: "q", type: Boolean },
-      { name: "version", alias: "v", type: Boolean },
-      { name: "help", alias: "h", type: Boolean },
-      { name: "ignore-scripts", type: Boolean },
-      { name: "execute", alias: "x", type: String },
-      { name: "files", type: String, multiple: true, defaultOption: true }
-    ], { argv });
-    let parsedArgs = {
+    const cli = cac("bumpp");
+    cli.version(version).usage("[...files]").option("--preid <preid>", "ID for prerelease").option("--all", "Include all files").option("-c, --commit [msg]", "Commit message", { default: true }).option("-t, --tag [tag]", "Tag name", { default: true }).option("-p, --push", "Push to remote", { default: true }).option("-y, --yes", "Skip confirmation").option("--no-verify", "Skip git verification").option("--ignore-scripts", "Ignore scripts", { default: false }).option("-q, --quiet", "Quiet mode").option("-v, --version <version>", "Tagert version").option("-x, --execute <command>", "Commands to execute after version bumps").help();
+    const result = cli.parse();
+    const args = result.options;
+    const parsedArgs = {
       help: args.help,
       version: args.version,
       quiet: args.quiet,
@@ -132,23 +43,15 @@ function parseArgs(argv) {
         tag: args.tag,
         push: args.push,
         all: args.all,
-        noVerify: args["no-verify"],
-        files: args.files,
-        ignoreScripts: args["ignore-scripts"],
+        confirm: !args.yes,
+        noVerify: !args.verify,
+        files: args["--"],
+        ignoreScripts: args.ignoreScripts,
         execute: args.execute
       }
     };
-    if (args.preid === null) {
-      throw new Error('The --preid option requires a value, such as "alpha", "beta", etc.');
-    }
-    if (args.commit === null) {
-      parsedArgs.options.commit = true;
-    }
-    if (args.tag === null) {
-      parsedArgs.options.tag = true;
-    }
     if (parsedArgs.options.files && parsedArgs.options.files.length > 0) {
-      let firstArg = parsedArgs.options.files[0];
+      const firstArg = parsedArgs.options.files[0];
       if (firstArg === "prompt" || isReleaseType(firstArg) || isValidVersion(firstArg)) {
         parsedArgs.options.release = firstArg;
         parsedArgs.options.files.shift();
@@ -161,26 +64,23 @@ function parseArgs(argv) {
 }
 function errorHandler(error) {
   console.error(error.message);
-  console.error(usageText);
   return process.exit(9 /* InvalidArgument */);
 }
 
 // src/cli/index.ts
-async function main(args) {
+async function main() {
   try {
     process.on("uncaughtException", errorHandler2);
     process.on("unhandledRejection", errorHandler2);
-    let { help, version: version2, quiet, options } = parseArgs(args);
+    const { help, version: version2, quiet, options } = parseArgs();
     if (help) {
-      console.log(helpText);
       process.exit(0 /* Success */);
     } else if (version2) {
       console.log(version);
       process.exit(0 /* Success */);
     } else {
-      if (!quiet) {
+      if (!quiet)
         options.progress = progress;
-      }
       await versionBump(options);
     }
   } catch (error) {
@@ -211,9 +111,8 @@ function progress({ event, script, updatedFiles, skippedFiles, newVersion }) {
 }
 function errorHandler2(error) {
   let message = error.message || String(error);
-  if (process.env.DEBUG || process.env.NODE_ENV === "development") {
+  if (process.env.DEBUG || process.env.NODE_ENV === "development")
     message = error.stack || message;
-  }
   console.error(message);
   process.exit(1 /* FatalError */);
 }

package/dist/index.d.ts

@@ -119,6 +119,12 @@ interface VersionBumpOptions {
      * Defaults to `false`.
      */
     all?: boolean;
+    /**
+     * Prompt for confirmation
+     *
+     * @default false
+     */
+    confirm?: boolean;
     /**
      * Indicates whether to bypass git commit hooks (`git commit --no-verify`).
      *
@@ -197,6 +203,105 @@ interface InterfaceOptions {
     [key: string]: unknown;
 }
 
+interface Interface {
+    input?: NodeJS.ReadableStream | NodeJS.ReadStream | false;
+    output?: NodeJS.WritableStream | NodeJS.WriteStream | false;
+    [key: string]: unknown;
+}
+/**
+ * A specific version release.
+ */
+interface VersionRelease {
+    type: 'version';
+    version: string;
+}
+/**
+ * Prompt the user for the release number.
+ */
+interface PromptRelease {
+    type: 'prompt';
+    preid: string;
+}
+/**
+ * A bump release, relative to the current version number.
+ */
+interface BumpRelease {
+    type: ReleaseType;
+    preid: string;
+}
+/**
+ * One of the possible Release types.
+ */
+declare type Release = VersionRelease | PromptRelease | BumpRelease;
+/**
+ * Normalized and sanitized options
+ */
+interface NormalizedOptions {
+    release: Release;
+    commit?: {
+        message: string;
+        noVerify: boolean;
+        all: boolean;
+    };
+    tag?: {
+        name: string;
+    };
+    push: boolean;
+    files: string[];
+    cwd: string;
+    interface: Interface;
+    ignoreScripts: boolean;
+    execute?: string;
+}
+
+interface OperationState {
+    release: ReleaseType | undefined;
+    oldVersionSource: string;
+    oldVersion: string;
+    newVersion: string;
+    commitMessage: string;
+    tagName: string;
+    updatedFiles: string[];
+    skippedFiles: string[];
+}
+interface UpdateOperationState extends Partial<OperationState> {
+    event?: ProgressEvent;
+    script?: NpmScript;
+}
+/**
+ * All of the inputs, outputs, and state of a single `versionBump()` call.
+ */
+declare class Operation {
+    /**
+     * The options for this operation.
+     */
+    options: NormalizedOptions;
+    /**
+     * The current state of the operation.
+     */
+    readonly state: Readonly<OperationState>;
+    /**
+     * The results of the operation.
+     */
+    get results(): VersionBumpResults;
+    /**
+     * The callback that's used to report the progress of the operation.
+     */
+    private readonly _progress?;
+    /**
+     * Private constructor.  Use the `Operation.start()` static method instead.
+     */
+    private constructor();
+    /**
+     * Starts a new `versionBump()` operation.
+     */
+    static start(input: VersionBumpOptions): Promise<Operation>;
+    /**
+     * Updates the operation state and results, and reports the updated progress to the user.
+     */
+    update({ event, script, ...newState }: UpdateOperationState): this;
+}
+
 /**
  * Prompts the user for a version number and updates package.json and package-lock.json.
  *
@@ -219,5 +324,9 @@ declare function versionBump(release: string): Promise<VersionBumpResults>;
  * Optionally also commits, tags, and pushes to git.
  */
 declare function versionBump(options: VersionBumpOptions): Promise<VersionBumpResults>;
+/**
+ * Bumps the version number in one or more files, prompting users if necessary.
+ */
+declare function versionBumpInfo(arg?: VersionBumpOptions | string): Promise<Operation>;
 
-export { InterfaceOptions, NpmScript, ProgressEvent, VersionBumpOptions, VersionBumpProgress, VersionBumpResults, versionBump as default, versionBump };
+export { InterfaceOptions, NpmScript, ProgressEvent, VersionBumpOptions, VersionBumpProgress, VersionBumpResults, versionBump as default, versionBump, versionBumpInfo };