bumpp 7.1.1 → 7.2.0

package/dist/cli/index.mjs

@@ -1,28 +1,32 @@
 import {
   ProgressEvent,
-  __toModule,
+  __toESM,
+  init_esm_shims,
   isReleaseType,
   require_log_symbols,
   versionBump
-} from "../chunk-OYIBSTEN.mjs";
+} from "../chunk-2TP63A7S.mjs";
 
 // src/cli/index.ts
-var import_log_symbols = __toModule(require_log_symbols());
+init_esm_shims();
+var import_log_symbols = __toESM(require_log_symbols());
 
 // package.json
 var name = "bumpp";
-var version = "7.1.1";
+var version = "7.2.0";
 var description = "Automatically (or with prompts) bump your version number, commit changes, tag, and push to Git";
 
 // src/cli/exit-code.ts
-var ExitCode;
-(function(ExitCode2) {
+init_esm_shims();
+var ExitCode = /* @__PURE__ */ ((ExitCode2) => {
   ExitCode2[ExitCode2["Success"] = 0] = "Success";
   ExitCode2[ExitCode2["FatalError"] = 1] = "FatalError";
   ExitCode2[ExitCode2["InvalidArgument"] = 9] = "InvalidArgument";
-})(ExitCode || (ExitCode = {}));
+  return ExitCode2;
+})(ExitCode || {});
 
 // src/cli/help.ts
+init_esm_shims();
 var usageText = `
 Usage: bumpp [release] [options] [files...]
 
@@ -99,6 +103,7 @@ ${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) {
@@ -157,7 +162,7 @@ function parseArgs(argv) {
 function errorHandler(error) {
   console.error(error.message);
   console.error(usageText);
-  return process.exit(ExitCode.InvalidArgument);
+  return process.exit(9 /* InvalidArgument */);
 }
 
 // src/cli/index.ts
@@ -168,10 +173,10 @@ async function main(args) {
     let { help, version: version2, quiet, options } = parseArgs(args);
     if (help) {
       console.log(helpText);
-      process.exit(ExitCode.Success);
+      process.exit(0 /* Success */);
     } else if (version2) {
       console.log(version);
-      process.exit(ExitCode.Success);
+      process.exit(0 /* Success */);
     } else {
       if (!quiet) {
         options.progress = progress;
@@ -184,22 +189,22 @@ async function main(args) {
 }
 function progress({ event, script, updatedFiles, skippedFiles, newVersion }) {
   switch (event) {
-    case ProgressEvent.FileUpdated:
+    case "file updated" /* FileUpdated */:
       console.log(import_log_symbols.success, `Updated ${updatedFiles.pop()} to ${newVersion}`);
       break;
-    case ProgressEvent.FileSkipped:
+    case "file skipped" /* FileSkipped */:
       console.log(import_log_symbols.info, `${skippedFiles.pop()} did not need to be updated`);
       break;
-    case ProgressEvent.GitCommit:
+    case "git commit" /* GitCommit */:
       console.log(import_log_symbols.success, "Git commit");
       break;
-    case ProgressEvent.GitTag:
+    case "git tag" /* GitTag */:
       console.log(import_log_symbols.success, "Git tag");
       break;
-    case ProgressEvent.GitPush:
+    case "git push" /* GitPush */:
       console.log(import_log_symbols.success, "Git push");
       break;
-    case ProgressEvent.NpmScript:
+    case "npm script" /* NpmScript */:
       console.log(import_log_symbols.success, `Npm run ${script}`);
       break;
   }
@@ -210,7 +215,7 @@ function errorHandler2(error) {
     message = error.stack || message;
   }
   console.error(message);
-  process.exit(ExitCode.FatalError);
+  process.exit(1 /* FatalError */);
 }
 export {
   main

package/dist/index.d.ts

@@ -1,8 +1,223 @@
+import { ReleaseType } from 'semver';
+export { ReleaseType } from 'semver';
+
+/**
+ * Information about the work that was performed by the `versionBump()` function.
+ */
+interface VersionBumpResults {
+    /**
+     * The release type that was used, or `undefined` if an explicit version number was used.
+     */
+    release?: ReleaseType;
+    /**
+     * The previous version number in package.json.
+     */
+    oldVersion: string;
+    /**
+     * The new version number.
+     */
+    newVersion: string;
+    /**
+     * The commit message that was used for the git commit, or `false` if no git commit was created.
+     *
+     * NOTE: This will never be an empty string.  It will always contain at least the new version number.
+     */
+    commit: string | false;
+    /**
+     * The tag name that was used for the git tag, or `false` if no git tag was created.
+     *
+     * NOTE: This will never be an empty string.  It will always contain at least the new version number.
+     */
+    tag: string | false;
+    /**
+     * The files that were actually modified.
+     */
+    updatedFiles: string[];
+    /**
+     * The files that were not updated because they did not contain the old version number.
+     */
+    skippedFiles: string[];
+}
+
+/**
+ * Progress events that indicate the progress of the `versionBump()` function.
+ */
+declare const enum ProgressEvent {
+    FileUpdated = "file updated",
+    FileSkipped = "file skipped",
+    GitCommit = "git commit",
+    GitTag = "git tag",
+    GitPush = "git push",
+    NpmScript = "npm script"
+}
 /**
- * The main entry point of the CLI
+ * The NPM version scripts
  *
- * @param args - The command-line arguments (e.g. ["major", "--preid=alpha", "-ctpa"])
+ * @see https://docs.npmjs.com/cli/version.html
+ */
+declare const enum NpmScript {
+    PreVersion = "preversion",
+    Version = "version",
+    PostVersion = "postversion"
+}
+/**
+ * Information about the progress of the `versionBump()` function.
+ */
+interface VersionBumpProgress extends VersionBumpResults {
+    event: ProgressEvent;
+    script?: NpmScript;
+}
+
+/**
+ * Options for the `versionBump()` function.
+ */
+interface VersionBumpOptions {
+    /**
+     * The release version or type. Can be one of the following:
+     *
+     * - The new version number (e.g. "1.23.456")
+     * - A release type (e.g. "major", "minor", "patch", "prerelease", etc.)
+     * - "prompt" to prompt the user for the version number
+     *
+     * Defaults to "prompt".
+     */
+    release?: string;
+    /**
+     * The prerelease type (e.g. "alpha", "beta", "next").
+     *
+     * Defaults to "beta".
+     */
+    preid?: string;
+    /**
+     * Indicates whether to create a git commit. Can be set to a custom commit message string
+     * or `true` to use "release v".  Any `%s` placeholders in the message string will be replaced
+     * with the new version number.  If the message string does _not_ contain any `%s` placeholders,
+     * then the new version number will be appended to the message.
+     *
+     * Defaults to `false`.
+     */
+    commit?: boolean | string;
+    /**
+     * Indicates whether to tag the git commit. Can be set to a custom tag string
+     * or `true` to use "v".  Any `%s` placeholders in the tag string will be replaced
+     * with the new version number.  If the tag string does _not_ contain any `%s` placeholders,
+     * then the new version number will be appended to the tag.
+     *
+     * Defaults to `false`.
+     */
+    tag?: boolean | string;
+    /**
+     * Indicates whether to push the git commit and tag.
+     *
+     * Defaults to `false`.
+     */
+    push?: boolean;
+    /**
+     * Indicates whether the git commit should include ALL files (`git commit --all`)
+     * rather than just the files that were modified by `versionBump()`.
+     *
+     * Defaults to `false`.
+     */
+    all?: boolean;
+    /**
+     * Indicates whether to bypass git commit hooks (`git commit --no-verify`).
+     *
+     * Defaults to `false`.
+     */
+    noVerify?: boolean;
+    /**
+     * The files to be updated. For certain known files ("package.json", "bower.json", etc.)
+     * `versionBump()` will explicitly update the file's version number.  For other files
+     * (ReadMe files, config files, source code, etc.) it will simply do a global replacement
+     * of the old version number with the new version number.
+     *
+     * Defaults to ["package.json", "package-lock.json"]
+     */
+    files?: string[];
+    /**
+     * The working directory, which is used as the basis for locating all files.
+     *
+     * Defaults to `process.cwd()`
+     */
+    cwd?: string;
+    /**
+     * Options for the command-line interface. Can be one of the following:
+     *
+     * - `true` - To default to `process.stdin` and `process.stdout`.
+     * - `false` - To disable all CLI output. Cannot be used when `release` is "prompt".
+     * - An object that will be passed to `readline.createInterface()`.
+     *
+     * Defaults to `true`.
+     */
+    interface?: boolean | InterfaceOptions;
+    /**
+     * Indicates whether to ignore version scripts.
+     *
+     * Defaults to `false`.
+     */
+    ignoreScripts?: boolean;
+    /**
+     * A callback that is provides information about the progress of the `versionBump()` function.
+     */
+    progress?(progress: VersionBumpProgress): void;
+    /**
+     * Excute additional command after bumping and before commiting
+     */
+    execute?: string;
+}
+/**
+ * Options for the command-line interface.
+ */
+interface InterfaceOptions {
+    /**
+     * The stream that will be used to read user input.  Can be one of the following:
+     *
+     * - `true` - To default to `process.stdin`
+     * - `false` - To disable all CLI input
+     * - Any readable stream
+     *
+     * Defaults to `true`.
+     */
+    input?: NodeJS.ReadableStream | NodeJS.ReadStream | boolean;
+    /**
+     * The stream that will be used to write output, such as prompts and progress.
+     * Can be one of the following:
+     *
+     * - `true` - To default to `process.stdout`
+     * - `false` - To disable all CLI output
+     * - Any writable stream
+     *
+     * Defaults to `true`.
+     */
+    output?: NodeJS.WritableStream | NodeJS.WriteStream | boolean;
+    /**
+     * Any other properties will be passed directly to `readline.createInterface()`.
+     * See the `ReadLineOptions` interface for possible options.
+     */
+    [key: string]: unknown;
+}
+
+/**
+ * Prompts the user for a version number and updates package.json and package-lock.json.
+ *
+ * @returns - The new version number
+ */
+declare function versionBump(): Promise<VersionBumpResults>;
+/**
+ * Bumps the version number in package.json, package-lock.json.
+ *
+ * @param release
+ * The release version or type. Can be one of the following:
+ *
+ * - The new version number (e.g. "1.23.456")
+ * - A release type (e.g. "major", "minor", "patch", "prerelease", etc.)
+ * - "prompt" to prompt the user for the version number
+ */
+declare function versionBump(release: string): Promise<VersionBumpResults>;
+/**
+ * Bumps the version number in one or more files, prompting the user if necessary.
+ * Optionally also commits, tags, and pushes to git.
  */
-declare function main(args: string[]): Promise<void>;
+declare function versionBump(options: VersionBumpOptions): Promise<VersionBumpResults>;
 
-export { main };
+export { InterfaceOptions, NpmScript, ProgressEvent, VersionBumpOptions, VersionBumpProgress, VersionBumpResults, versionBump as default, versionBump };