ump 3.3.0 → 3.5.0

package/README.md

@@ -21,12 +21,17 @@ For programmatic use (i.e. requiring it as a module in a node.js script), instal
   * `-m`, `--message`:      Message to be used for the commit and tag when `-r` or `-p` is set. Default: Release %s
   * `-r`, `--release`:      If set, runs `git add` and `git commit` for the bumped files and pushes a tagged release.
   * `-p`, `--publish`:      If set, automatically runs with the `--release` flag and then publishes the release to npm.
+  * `-a`, `--autostash`:    Default: `true`. Whether to use the `--autostash` flag when running `git pull`
+  * `-x`, `--skip-pull`:    If set, skips executing the initial git pull command during a release/publish task. USE WITH CAUTION.
+  * `-t`, `--tag-prefix`:   Optional prefix for the version in git tag. (e.g. With `--message "Release %s" --tag-prefix version`, The tag might look like "version 1.2.3" and its commit message "Release version 1.2.3")
   * `-d`, `--debug`:        If set, ump will run in debug mode, outputting a json file instead of doing something
   * `-h`, `--help`:         Shows help information on the command line
 
 ## Module Usage
 
-The only required option is `files`, which takes an array of files. All other options are the same as the command-line long-hand options: `message, release, publish, debug` (not `help`).
+The only required option is `files`, which takes an array of files. All other options are the same as the command-line *long-hand* options — `message, release, publish, debug` (not `help`).
+
+Note: Options can be written as either kebab case (`skip-pull`, `tag-prefix`) or camel case (`skipPull`, `tagPrefix`).
 
 ```js
 import ump from 'ump';

package/eslint.config.mjs

@@ -0,0 +1,9 @@
+import jsConfig from 'eslint-config-kswedberg/flat/js.mjs';
+import {nodeGlobals} from 'eslint-config-kswedberg/flat/globals.mjs';
+
+export default [
+  nodeGlobals,
+  ...jsConfig,
+  {files: ['**/*.js']},
+  {ignores: ['test/testarea/*.js']},
+];

package/lib/commands.js

@@ -27,6 +27,16 @@ const commands = {
   gitPull: function gitPull(opts) {
     // Need to pull before mucking with files, so we can stop it if git branch isn't clean.
     // Otherwise files will be bumped and committed but not pushed and things will get messed up.
+    // However, if the user is SURE this task can be skipped, the option is available
+
+    if (opts.skipPull) {
+      return {
+        log: '',
+        cmd: function() {
+          log.color('SKIPPED git pull', 'yellow');
+        },
+      };
+    }
     // **We can autostash on pull because we handle existence of uncommitted files later
     const pull = opts.autostash ? 'git pull --autostash' : 'git pull';
 
@@ -105,7 +115,7 @@ const commands = {
 
   gitRelease: function gitRelease(opts) {
     const files = utils.getFiles(opts.files.concat(opts.extras || []));
-    const newVersion = opts.newVersion;
+    const newVersion = `${opts.tagPrefix || ''}${opts.newVersion}`;
     let msg = opts.message.replace('%s', newVersion);
 
     msg = utils.escapeQuotes(msg);

package/lib/config.js

@@ -10,6 +10,7 @@ try {
 }
 
 const config = {
+  pkgName: pkg.name || '',
   defaults: {
     sourceFile: 'package.json',
     message: 'Release %s',
@@ -17,6 +18,8 @@ const config = {
     regexReplace: '(?:[0-9]+\\.){2}[0-9]+[0-9a-zA-Z\\-_\\+\\.]*',
     regexFlags: 'g',
     autostash: true,
+    skipPull: false,
+    tagPrefix: '',
   },
 
   messages: {
@@ -39,28 +42,22 @@ const config = {
     'prepatch',
   ],
 
-  confirm: [
-    {
-      message: 'Are you sure you want to continue?',
-      name: 'run',
-      type: 'confirm',
-    },
-  ],
+  confirmPrompt: {
+    message: 'Are you sure you want to continue?',
+    name: 'run',
+    type: 'confirm',
+  },
 
-  publishPrompts: [
-    {
-      name: 'access',
-      message: 'Is access public or restricted?',
-      type: 'list',
-      when: () => {
-        return (pkg.name || '').charAt(0) === '@';
-      },
-      choices: [
-        {name: 'public', default: true},
-        {name: 'restricted'},
-      ],
-    },
-  ],
+
+  publishPrompt: {
+    name: 'access',
+    message: 'Is access public or restricted?',
+    default: 'public',
+    choices: [
+      'public',
+      'restricted',
+    ],
+  },
 };
 
 Object.assign(config, {
@@ -89,17 +86,29 @@ Object.assign(config, {
       description: 'If set, automatically runs with the `--release` flag and then publishes the release to npm.',
       type: 'boolean',
     },
-    d: {
-      alias: 'debug',
-      description: 'If set, ump will run in debug mode, outputting a json file instead of doing something',
-      type: 'boolean',
-    },
     a: {
       alias: 'autostash',
       description: 'Whether to use the --autostash flag when running `git pull`',
       type: 'boolean',
       default: true,
     },
+    x: {
+      alias: 'skip-pull',
+      description: 'If set, skips executing the initial git pull command during a release/publish task. USE WITH CAUTION.',
+      type: 'boolean',
+      default: false,
+    },
+    t: {
+      alias: 'tag-prefix',
+      description: 'Optional prefix for the version in git tag. (e.g. With `--message "Release %s" --tag-prefix version-`, The tag might look like "version-1.2.3" and its commit message "Release version-1.2.3"',
+      type: 'string',
+      default: '',
+    },
+    d: {
+      alias: 'debug',
+      description: 'If set, ump will run in debug mode, outputting a json file instead of doing something',
+      type: 'boolean',
+    },
     extras: {
       description: 'Array of objects. ONLY AVAILABLE VIA .umprc OR when using ump() AS MODULE. Props: file, prefix (optional regex string), replaced (optional regex string), flags (optional). See https://github.com/kswedberg/ump/blob/master/README.md for more info.',
     },

package/lib/utils.js

@@ -3,7 +3,7 @@
 import path from 'path';
 import fs from 'fs';
 import util from 'util';
-import glob from 'glob';
+import {globSync} from 'glob';
 import chalk from 'chalk';
 import rc from 'rc';
 import semver from 'semver';
@@ -53,7 +53,7 @@ const utils = {
 
 
     files.forEach((item) => {
-      const fileGlob = glob.sync(item.file || item, {
+      const fileGlob = globSync(item.file || item, {
         dot: true,
       });
 
@@ -209,7 +209,8 @@ const utils = {
     opts.files = utils.getFiles(opts.files);
     opts.extraFiles = utils.getFiles(opts.extras || []);
     opts.sourceFile = opts.files[0];
-
+    opts.skipPull = opts.skipPull || opts['skip-pull'];
+    opts.tagPrefix = opts.tagPrefix || opts['tag-prefix'];
     // opts.publish always implies opts.release as well (git push && git push --tags)
     if (opts.publish) {
       opts.release = true;

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "ump",
   "title": "ump",
-  "version": "3.3.0",
+  "version": "3.5.0",
   "description": "Bump without the B",
   "scripts": {
     "test": "npm run test:clean && npm run test:pre && npm run test:run",
     "test:clean": "rm -rf ./test/testarea",
     "test:pre": "npm run lint && mkdir -p \"./test/testarea\"",
     "test:run": "node_modules/.bin/mocha --delay --reporter spec",
-    "lint": "eslint --config .eslintrc.cjs *.js bin lib test"
+    "lint": "eslint *.js bin lib test"
   },
   "repository": {
     "type": "git",
@@ -28,22 +28,23 @@
     "node": ">=14"
   },
   "dependencies": {
-    "chalk": "^5.1.2",
-    "fs-extra": "^10.1.0",
+    "@inquirer/confirm": "^5.0.0",
+    "@inquirer/select": "^4.0.0",
+    "chalk": "^5.3.0",
+    "fs-extra": "^11.2.0",
     "git-config": "^0.0.7",
-    "glob": "^8.0.3",
-    "inquirer": "^9.1.4",
+    "glob": "^11.0.0",
     "rc": "^1.2.8",
-    "semver": "^7.3.8",
-    "update-notifier": "^6.0.2",
-    "yargs": "^17.6.2"
+    "semver": "^7.6.3",
+    "update-notifier": "^7.3.1",
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.0",
-    "chai": "^4.3.7",
-    "eslint": "^8.27.0",
-    "eslint-config-kswedberg": "^5.1.2",
-    "mocha": "^9.1.3"
+    "@types/mocha": "^10.0.9",
+    "chai": "^5.1.1",
+    "eslint": "^9.13.0",
+    "eslint-config-kswedberg": "^7.1.0",
+    "mocha": "^10.7.3"
   },
   "license": "MIT"
 }

package/ump.js

@@ -1,6 +1,7 @@
 'use strict';
 
-import inquirer from 'inquirer';
+import select from '@inquirer/select';
+import confirm from '@inquirer/confirm';
 
 import {utils, peach} from './lib/utils.js';
 import {commands} from './lib/commands.js';
@@ -37,14 +38,18 @@ const ump = async function(options) {
     sequence.push(commands.extras(opts));
   }
 
+
   // opts.inquire is set to true automatically for CLI usage
-  if (opts.publish && opts.inquire) {
-    opts.publishFlags = await inquirer.prompt(config.publishPrompts);
+  if (opts.publish && opts.inquire && config.pkgName.startsWith('@')) {
+    opts.publishFlags = {};
+    opts.publishFlags[config.publishPrompt.name] = await select(config.publishPrompt);
   }
 
   if (opts.release) {
     // opts.dirty = commands.commitDirty(opts);
+
     // gitPull needs to happen first, so we don't update files when we can't complete things
+    // The skipPull option is available if we are SURE we don't need to pull
     sequence.unshift(commands.gitPull(opts));
     sequence.push(commands.gitRelease(opts));
   }
@@ -53,9 +58,9 @@ const ump = async function(options) {
 
   // opts.inquire is set to true automatically for CLI usage
   if (opts.inquire) {
-    const answer = await inquirer.prompt(config.confirm);
+    const run = await confirm(config.confirmPrompt);
 
-    if (!answer.run) {
+    if (!run) {
       console.log(sequence);
 
       return log.color('\nHalted execution. Not bumping files.', 'red');

package/.eslintrc.cjs

@@ -1,6 +0,0 @@
-module.exports = {
-  extends: 'kswedberg',
-  env: {
-    mocha: true,
-  },
-};