ump 2.1.7 → 3.1.0

package/.eslintrc.cjs

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

package/README.md

@@ -29,7 +29,7 @@ For programmatic use (i.e. requiring it as a module in a node.js script), instal
 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`).
 
 ```js
-const ump = require('ump');
+import ump from 'ump';
 
 ump({
   files: [

package/bin/ump.js

@@ -1,12 +1,12 @@
 #!/usr/bin/env node
 
-require('../lib/notifier');
-// const parser = require('nomnom');
-const ump = require('../ump');
-
-const yargs = require('yargs/yargs')(process.argv.slice(2));
-const options = require('../lib/config').cliOptions;
+import('../lib/notifier.js');
+import yarg from 'yargs';
+import ump from '../ump.js';
+import {config} from '../lib/config.js';
 
+const options = config.cliOptions;
+const yargs = yarg(process.argv.slice(2));
 const argv = yargs
 .usage('Usage: $0 <releaseType> [files]... [options]')
 .usage(`

package/lib/commands.js

@@ -1,14 +1,15 @@
 'use strict';
 
-const path = require('path');
-const Promises = require('bluebird');
-const fs = require('fs-extra');
-const {promisify} = require('util');
-const childProcess = require('child_process');
+import path from 'path';
+import Promises from 'bluebird';
+import fs from 'fs-extra';
+import {promisify} from 'util';
+import childProcess from 'child_process';
+import {utils} from './utils.js';
+import {config} from './config.js';
+import {log} from './log.js';
+
 const exec = promisify(childProcess.exec);
-const utils = require('./utils');
-const config = require('./config');
-const log = require('./log');
 
 const getFlags = (obj) => {
   return Object.entries(obj || {})
@@ -65,12 +66,13 @@ const commands = {
           return console.log(`Skipping version updates to  ${files.join(', ')}`);
         }
 
-        return files.forEach((file) => {
-          const data = utils.readJSON(file);
+        return Promise.all(files.map(async(file) => {
+          const data = await utils.readJSON(file);
 
           data.version = newVersion;
           utils.writeJSON(file, data);
-        });
+        }));
+
       },
     };
   },
@@ -126,7 +128,7 @@ const commands = {
         let lines = [];
 
         try {
-          await fs.readFile(path.resolve('./', '.git/config'));
+          await utils.checkGitConfig(path.resolve('./', '.git'));
         } catch (err) {
           utils.error(err);
         }
@@ -174,4 +176,4 @@ const commands = {
   },
 };
 
-module.exports = commands;
+export {commands};

package/lib/config.js

@@ -1,12 +1,15 @@
-const path = require('path');
+import path from 'path';
+import fs from 'fs-extra';
+
 let pkg = {};
 
 try {
-  pkg = require(path.join(process.cwd(), 'package.json'));
+  pkg = fs.readJsonSync(path.join(process.cwd(), 'package.json'));
 } catch (err) {
   pkg = {name: ''};
 }
-let config = {
+
+const config = {
   defaults: {
     sourceFile: 'package.json',
     message: 'Release %s',
@@ -25,6 +28,7 @@ let config = {
     noRepo: 'You cannot "release" this version. You are not in a git repository.',
     noSource: 'The specified source file does not exist.',
   },
+
   releaseTypes: [
     'major',
     'minor',
@@ -33,14 +37,15 @@ let config = {
     'preminor',
     'prepatch',
   ],
-  confirm: [
 
+  confirm: [
     {
       message: 'Are you sure you want to continue?',
       name: 'run',
       type: 'confirm',
     },
   ],
+
   publishPrompts: [
     {
       name: 'access',
@@ -57,7 +62,7 @@ let config = {
   ],
 };
 
-config = Object.assign(config, {
+Object.assign(config, {
   cliOptions: {
     // releaseType: {
     //   position: 0,
@@ -94,4 +99,4 @@ config = Object.assign(config, {
   },
 });
 
-module.exports = config;
+export {config};

package/lib/log.js

@@ -1,12 +1,9 @@
-const chalk = require('chalk');
+import chalk from 'chalk';
 
 const log = {
   color: function(str, color) {
-    let txt = str;
+    const txt = color ? chalk[color](str) : str;
 
-    if (color) {
-      txt = chalk[color](txt);
-    }
     console.log(txt);
   },
   bump: function(opts) {
@@ -28,4 +25,4 @@ const log = {
   },
 };
 
-module.exports = log;
+export {log};

package/lib/notifier.js

@@ -1,6 +1,11 @@
+import fs from 'fs-extra';
+import path from 'path';
+import {utils} from './utils.js';
+import updateNotifier from 'update-notifier';
 
-const updateNotifier = require('update-notifier');
-const pkg = require('../package.json');
+// @ts-ignore
+const dirname = utils.getDirName(import.meta.url);
+const pkg = fs.readJsonSync(path.resolve(dirname, '..', 'package.json'));
 
 updateNotifier({
   packageName: pkg.name,

package/lib/utils.js

@@ -1,18 +1,28 @@
 'use strict';
 
-const path = require('path');
-const Promises = require('bluebird');
-const fs = require('fs-extra');
-const exec = Promises.promisify(require('child_process').exec);
-const glob = require('glob');
-const chalk = require('chalk');
-const rc = require('rc');
-const semver = require('semver');
-const config = require('./config');
-const log = require('./log');
+import path from 'path';
+import childProcess from 'child_process';
+import Promises from 'bluebird';
+import fs from 'fs';
+import util from 'util';
+import glob from 'glob';
+import chalk from 'chalk';
+import rc from 'rc';
+import semver from 'semver';
+import {config} from './config.js';
+import {log} from './log.js';
+
+const readFile = util.promisify(fs.readFile);
+const writeFile = util.promisify(fs.writeFile);
+const stat = util.promisify(fs.stat);
 
 const utils = {
-  escapeQuotes: function(str) {
+  getDirName(url) {
+    const moduleURL = new URL(url);
+
+    return moduleURL.pathname.replace(/\/[^/]+$/, '');
+  },
+  escapeQuotes(str) {
     if (typeof str === 'string') {
       return str.replace(/(["$`\\])/g, '\\$1');
     }
@@ -20,8 +30,26 @@ const utils = {
     return str;
 
   },
+  async checkGitConfig(gitPath) {
+    const gitDirOrFile = await stat(gitPath);
+
+    if (gitDirOrFile.isDirectory()) {
+      await readFile(`${gitPath}/config`);
+
+      return;
+    }
+
+    // If we're in a submodule, the .git path will be a file that contains a 'gitdir: …' entry
+    const contents = await readFile(gitPath, 'utf8');
+    const content = contents.split(/\n/)[0];
+    const gitdir = content.replace(/^\s*gitdir:\s*(.+)$/, '$1');
 
-  getFiles: function(items) {
+    const gitConfig = path.resolve(`${gitdir}/config`);
+
+    await readFile(gitConfig);
+  },
+
+  getFiles(items) {
     const files = items ? [].concat(items) : ['package.json'];
     const list = [];
 
@@ -41,14 +69,22 @@ const utils = {
     return unique;
   },
 
-  readJSON: function(file) {
+  async readJSON(file) {
+    const filePath = path.resolve(process.cwd(), file);
+
     try {
-      return require(path.resolve('./', file));
+      const str = await readFile(filePath, 'utf8');
+      const json = JSON.parse(str);
+
+      return json;
     } catch (err) {
-      return {};
+      console.log(err);
+
+      return {error: true};
     }
   },
-  writeJSON: function writeJSON(file, input) {
+
+  writeJSON(file, input) {
     let json = input;
 
     if (typeof json === 'object') {
@@ -58,7 +94,7 @@ const utils = {
     fs.writeFileSync(file, json);
   },
 
-  getBumpError: function getBumpError(opts) {
+  getBumpError(opts) {
     let err = null;
 
     if (typeof opts.releaseType === 'undefined') {
@@ -78,11 +114,9 @@ const utils = {
     return err;
   },
 
-  bumpError: function bumpError(opts) {
-    let isErr = utils.getBumpError(opts);
-    let def = '_default';
-    let label = 'version';
-    let value = opts.version;
+  bumpError(opts) {
+    const isErr = utils.getBumpError(opts);
+    const def = '_default';
 
     // Special case for no releaseType (user just types "ump")
     if (isErr === 'noRelease') {
@@ -99,15 +133,15 @@ const utils = {
     return isErr;
   },
 
-  error: function error(err) {
+  error(err) {
     throw err;
   },
 
-  debug: function debug(obj) {
-    let debugOutput = JSON.stringify(obj, null, 2);
-    let file = '.ump.debug.json';
+  debug(obj) {
+    const debugOutput = JSON.stringify(obj, null, 2);
+    const file = '.ump.debug.json';
 
-    return fs.writeFile(file, debugOutput)
+    return writeFile(file, debugOutput)
     .then(() => {
       log.color(`\n**DEBUG ONLY! Writing the following to ${file}:**`, 'cyan');
       console.log(debugOutput);
@@ -117,7 +151,7 @@ const utils = {
   extend: function extend(...args) {
     let arg, prop;
     let al = args.length;
-    let firstArg = al === 1 ? {} : args.shift();
+    const firstArg = al === 1 ? {} : args.shift();
 
     while (--al > -1) {
       arg = args[al];
@@ -134,11 +168,11 @@ const utils = {
     return firstArg;
   },
 
-  repoDirty: function repoDirty(stdout, files) {
-    let lines = stdout.trim().split('\n')
+  repoDirty: function(stdout, files) {
+    const lines = stdout
+    .trim().split('\n')
     .filter((line) => {
-      let file = line.replace(/.{1,2}\s+/, '');
-
+      const file = line.replace(/.{1,2}\s+/, '');
 
       return line.trim() && !file.match(/^\?\? /) && files.indexOf(file) === -1;
     })
@@ -149,17 +183,17 @@ const utils = {
     return lines;
   },
 
-  resetVersion: function resetVersion(opts) {
+  resetVersion: function(opts) {
     log.color('Did not execute commands. Resetting version.', 'red');
-    opts.files.forEach((file) => {
-      let json = utils.readJSON(file);
+    Promise.all(opts.files.map(async(file) => {
+      const json = await utils.readJSON(file);
 
       json.version = opts.version;
       utils.writeJSON(file, json);
-    });
+    }));
   },
 
-  getNewVersion: function getNewVersion(opts) {
+  getNewVersion: function(opts) {
     // semver release type
     if (config.releaseTypes.indexOf(opts.releaseType) !== -1) {
       return semver.inc(opts.version, opts.releaseType);
@@ -169,10 +203,10 @@ const utils = {
     return opts.releaseType;
   },
 
-  buildOptions: function buildOptions(options) {
-    let appName = options.appName || 'ump';
-    let rcOptions = rc(appName);
-    let opts = utils.extend(config.defaults, rcOptions, options);
+  buildOptions: async function(options) {
+    const appName = options.appName || 'ump';
+    const rcOptions = rc(appName);
+    const opts = utils.extend(config.defaults, rcOptions, options);
 
     opts.files = utils.getFiles(opts.files);
     opts.extraFiles = utils.getFiles(opts.extras || []);
@@ -183,7 +217,9 @@ const utils = {
       opts.release = true;
     }
 
-    opts.version = utils.readJSON(opts.sourceFile).version;
+    const src = await utils.readJSON(opts.sourceFile);
+
+    opts.version = src.version;
 
     if (utils.bumpError(opts)) {
       return Object.assign(opts, {error: true});
@@ -193,20 +229,6 @@ const utils = {
 
     return opts;
   },
-
-  // Taken from https://github.com/inikulin/publish-please/blob/master/src/publish.js
-  checkNodeNpm: function checkNodeNpm() {
-    return exec('npm version --json')
-    .then((versions) => {
-      const npmVersion = JSON.parse(versions).npm;
-      const isNode6 = semver.gte(process.version, '6.0.0');
-      const isSafeNpmVersion = semver.satisfies(npmVersion, '>=2.15.8 <3.0.0 || >=3.10.1');
-
-      if (isNode6 && !isSafeNpmVersion) {
-        throw new Error(`npm@${npmVersion} has known issues publishing when running Node.js 6. Please upgrade npm or downgrade Node and publish again. See: https://github.com/npm/npm/issues/5082`);
-      }
-    });
-  },
 };
 
-module.exports = utils;
+export {utils};

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "ump",
   "title": "ump",
-  "version": "2.1.7",
+  "version": "3.1.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.js ump.js bin lib test",
+    "lint": "eslint --config .eslintrc.cjs *.js bin lib test",
     "snyk-protect": "snyk protect",
     "prepare": "npm run snyk-protect"
   },
@@ -16,6 +16,7 @@
     "type": "git",
     "url": "git@github.com:kswedberg/ump.git"
   },
+  "type": "module",
   "main": "ump.js",
   "bin": {
     "ump": "bin/ump.js"
@@ -26,26 +27,26 @@
     "url": "https://karlswedberg.com/"
   },
   "engines": {
-    "node": ">= 8.6.0"
+    "node": ">=14"
   },
   "dependencies": {
-    "bluebird": "^3.7.1",
-    "chalk": "^4.1.2",
+    "bluebird": "^3.7.2",
+    "chalk": "^5.0.0",
     "fs-extra": "^10.0.0",
-    "git-config": "0.0.7",
-    "glob": "^7.1.4",
-    "inquirer": "^7.3.3",
+    "git-config": "^0.0.7",
+    "glob": "^7.2.0",
+    "inquirer": "^8.2.0",
     "rc": "^1.2.8",
-    "semver": "^6.3.0",
-    "snyk": "^1.685.0",
-    "update-notifier": "^4.1.3",
-    "yargs": "^13.3.2"
+    "semver": "^7.3.5",
+    "snyk": "^1.812.0",
+    "update-notifier": "^6.0.2",
+    "yargs": "^17.3.1"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^6.8.0",
-    "eslint-config-kswedberg": "^3.1.1",
-    "mocha": "^7.2.0"
+    "chai": "^4.3.4",
+    "eslint": "^8.5.0",
+    "eslint-config-kswedberg": "^5.1.1",
+    "mocha": "^9.1.3"
   },
   "license": "MIT",
   "snyk": true

package/test/test.js

@@ -1,8 +1,14 @@
-const Promises = require('bluebird');
-const fs = require('fs-extra');
-const path = require('path');
-const ump = require('../ump');
-const expect = require('chai').expect;
+import path from 'path';
+import Promises from 'bluebird';
+import fs from 'fs-extra';
+import ump from '../ump.js';
+import {utils} from '../lib/utils.js';
+import {commands} from '../lib/commands.js';
+
+import {expect} from 'chai';
+
+// @ts-ignore
+const dirname = utils.getDirName(import.meta.url);
 
 const settings = {
   inquire: false,
@@ -24,13 +30,10 @@ const pkg = {
   version: '1.0.0',
 };
 
-const utils = require('../lib/utils');
+let opts = {};
 
 const tests = {
-  utils: function() {
-
-    const opts = utils.buildOptions(settings);
-
+  utils() {
     it('should build options object', () => {
       expect(opts.sourceFile).to.equal(settings.files[0]);
       expect(opts.newVersion).to.equal('1.0.1');
@@ -49,9 +52,8 @@ const tests = {
       expect(opts.extraFiles.length).to.equal(2);
     });
   },
-  commands: function() {
-    const opts = utils.buildOptions(settings);
-    const commands = require('../lib/commands');
+
+  commands() {
     const extras = commands.extras(opts);
 
     it('should have correct log info', () => {
@@ -76,7 +78,6 @@ const tests = {
   },
 };
 
-
 const files = [
   {
     file: 'package.json',
@@ -111,16 +112,22 @@ const files = [
   },
 ];
 
-Promises.each(files, (file) => {
-  return fs.writeFile(path.join(__dirname, 'testarea/', file.file), file.content);
-})
-.then(() => {
-  describe('ump', () => {
-    Object.keys(tests).forEach((test) => {
-      describe(test, tests[test]);
+const runTests = async() => {
+  try {
+    await Promises.each(files, (file) => {
+      return fs.writeFile(path.join(dirname, 'testarea/', file.file), file.content);
     });
-  });
 
+    opts = await utils.buildOptions(settings);
+    describe('ump', () => {
+      Object.entries(tests).forEach(([name, test]) => {
+        describe(name, test);
+      });
+    });
+  } catch (err) {
+    console.error(err);
+  }
   run();
-})
-.catch(run);
+};
+
+runTests();

package/ump.js

@@ -1,25 +1,21 @@
 'use strict';
 
-const path = require('path');
-const Promises = require('bluebird');
-const inquirer = require('inquirer');
-const semver = require('semver');
-
-const utils = require('./lib/utils');
-const commands = require('./lib/commands');
-const log = require('./lib/log');
-const config = require('./lib/config');
+import Promises from 'bluebird';
+import inquirer from 'inquirer';
+
+import {utils} from './lib/utils.js';
+import {commands} from './lib/commands.js';
+import {log} from './lib/log.js';
+import {config} from './lib/config.js';
+
 const sequence = [];
 
 const runCommands =  function(sequence, options) {
-  return utils.checkNodeNpm()
+  return Promises.each(sequence, (command) => {
+    return command.cmd(options);
+  })
   .then(() => {
-    return Promises.each(sequence, (command) => {
-      return command.cmd(options);
-    })
-    .then(() => {
-      log.color('*** DONE! ***', 'green');
-    });
+    log.color('*** DONE! ***', 'green');
   })
   .catch((err) => {
     console.error(err);
@@ -28,7 +24,7 @@ const runCommands =  function(sequence, options) {
 };
 
 const ump = async function(options) {
-  const opts = utils.buildOptions(options);
+  const opts = await utils.buildOptions(options);
 
   if (opts.error) {
     return;
@@ -70,4 +66,4 @@ const ump = async function(options) {
   runCommands(sequence, opts);
 };
 
-module.exports = ump;
+export default ump;

package/.eslintrc.js

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