release-it 18.1.2 → 19.0.0-next.1

package/lib/util.js

@@ -1,18 +1,57 @@
-import fs from 'node:fs';
+import fs, { close, openSync, statSync, utimesSync, accessSync } from 'node:fs'; // need import fs here due to test stubbing
+import util from 'node:util';
 import { EOL } from 'node:os';
-import _ from 'lodash';
 import gitUrlParse from 'git-url-parse';
 import semver from 'semver';
 import osName from 'os-name';
+import { Eta } from 'eta';
 import Log from './log.js';
 
-const readJSON = file => JSON.parse(fs.readFileSync(file, 'utf8'));
+const debug = util.debug('release-it:shell');
 
-const pkg = readJSON(new URL('../package.json', import.meta.url));
+const eta = new Eta({
+  autoEscape: false,
+  useWith: true,
+  tags: ['${', '}'],
+  parse: { interpolate: '' },
+  rmWhitespace: false,
+  autoTrim: false
+});
+const wait = ms => new Promise(resolve => setTimeout(resolve, ms));
+const before = (n, func) => {
+  var result;
+  if (typeof func != 'function') {
+    throw new TypeError('Missing argument for `func`');
+  }
+  n = parseInt(n);
+  return function () {
+    if (--n > 0) {
+      result = func.apply(this, arguments);
+    }
+    if (n <= 1) {
+      func = undefined;
+    }
+    return result;
+  };
+};
+const tryStatFile = filePath => {
+  try {
+    return statSync(filePath);
+  } catch (e) {
+    debug(e);
+    return null;
+  }
+};
+
+export const execOpts = {
+  stdio: process.env.NODE_DEBUG && process.env.NODE_DEBUG.indexOf('release-it') === 0 ? 'pipe' : []
+};
 
-const log = new Log();
+export const readJSON = file => JSON.parse(fs.readFileSync(file, 'utf8'));
 
-const getSystemInfo = () => {
+const pkg = readJSON(new URL('../package.json', import.meta.url));
+
+export const getSystemInfo = () => {
   return {
     'release-it': pkg.version,
     node: process.version,
@@ -20,9 +59,11 @@ const getSystemInfo = () => {
   };
 };
 
-const format = (template = '', context = {}) => {
+export const format = (template = '', context = {}) => {
+  if (!context || context === null || !template || template === null || template.indexOf('${') === -1) return template;
+  const log = new Log();
   try {
-    return _.template(template)(context);
+    return eta.renderString(template, context);
   } catch (error) {
     log.error(`Unable to render template with context:\n${template}\n${JSON.stringify(context)}`);
     log.error(error);
@@ -30,21 +71,19 @@ const format = (template = '', context = {}) => {
   }
 };
 
-const truncateLines = (input, maxLines = 10, surplusText = null) => {
+export const truncateLines = (input, maxLines = 10, surplusText = null) => {
   const lines = input.split(EOL);
   const surplus = lines.length - maxLines;
   const output = lines.slice(0, maxLines).join(EOL);
   return surplus > 0 ? (surplusText ? `${output}${surplusText}` : `${output}${EOL}...and ${surplus} more`) : output;
 };
 
-const wait = ms => new Promise(resolve => setTimeout(resolve, ms));
-
-const rejectAfter = (ms, error) =>
+export const rejectAfter = (ms, error) =>
   wait(ms).then(() => {
     throw error;
   });
 
-const parseGitUrl = remoteUrl => {
+export const parseGitUrl = remoteUrl => {
   if (!remoteUrl) return { host: null, owner: null, project: null, protocol: null, remote: null, repository: null };
   const normalizedUrl = (remoteUrl || '')
     .replace(/^[A-Z]:\\\\/, 'file://') // Assume file protocol for Windows drive letters
@@ -52,12 +91,12 @@ const parseGitUrl = remoteUrl => {
     .replace(/\\+/g, '/'); // Replace forward with backslashes
   const parsedUrl = gitUrlParse(normalizedUrl);
   const { resource: host, name: project, protocol, href: remote } = parsedUrl;
-  const owner = protocol === 'file' ? _.last(parsedUrl.owner.split('/')) : parsedUrl.owner; // Fix owner for file protocol
+  const owner = protocol === 'file' ? parsedUrl.owner.split('/').at(-1) : parsedUrl.owner; // Fix owner for file protocol
   const repository = `${owner}/${project}`;
   return { host, owner, project, protocol, remote, repository };
 };
 
-const reduceUntil = async (collection, fn) => {
+export const reduceUntil = async (collection, fn) => {
   let result;
   for (const item of collection) {
     if (result) break;
@@ -66,16 +105,16 @@ const reduceUntil = async (collection, fn) => {
   return result;
 };
 
-const hasAccess = path => {
+export const hasAccess = path => {
   try {
-    fs.accessSync(path);
+    accessSync(path);
     return true;
   } catch (err) {
     return false;
   }
 };
 
-const parseVersion = raw => {
+export const parseVersion = raw => {
   if (raw == null) return { version: raw, isPreRelease: false, preReleaseId: null };
   const version = semver.valid(raw) ? raw : semver.coerce(raw);
   if (!version) return { version: raw, isPreRelease: false, preReleaseId: null };
@@ -89,22 +128,50 @@ const parseVersion = raw => {
   };
 };
 
-const e = (message, docs, fail = true) => {
+export const e = (message, docs, fail = true) => {
   const error = new Error(docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message);
   error.code = fail ? 1 : 0;
   error.cause = fail ? 'ERROR' : 'INFO';
   return error;
 };
 
-export {
-  getSystemInfo,
-  format,
-  truncateLines,
-  rejectAfter,
-  reduceUntil,
-  parseGitUrl,
-  hasAccess,
-  parseVersion,
-  readJSON,
-  e
+export const touch = (path, callback) => {
+  const stat = tryStatFile(path);
+  if (stat && stat.isDirectory()) {
+    // don't error just exit
+    return;
+  }
+
+  const fd = openSync(path, 'a');
+  close(fd);
+  const now = new Date();
+  const mtime = now;
+  const atime = now;
+  utimesSync(path, atime, mtime);
+  if (callback) {
+    callback();
+  }
+};
+
+export const fixArgs = args => (args ? (typeof args === 'string' ? args.split(' ') : args) : []);
+
+export const upperFirst = string => {
+  return string ? string.charAt(0).toUpperCase() + string.slice(1) : '';
+};
+
+export const castArray = arr => {
+  return Array.isArray(arr) ? arr : [arr];
+};
+
+export const once = fn => {
+  return before(2, fn);
+};
+
+export const pick = (object, keys) => {
+  return keys.reduce((obj, key) => {
+    if (object && Object.prototype.hasOwnProperty.call(object, key)) {
+      obj[key] = object[key];
+    }
+    return obj;
+  }, {});
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "18.1.2",
+  "version": "19.0.0-next.1",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -69,7 +69,7 @@
     "lint": "eslint lib test",
     "format": "prettier --write eslint.config.mjs \"{lib,test}/**/*.js\"",
     "docs": "remark README.md 'docs/**/*.md' '.github/*.md' -o",
-    "test": "ava --no-worker-threads && installed-check --ignore ava",
+    "test": "ava --no-worker-threads && installed-check --ignore ava --ignore nock",
     "release": "./bin/release-it.js"
   },
   "author": {
@@ -79,25 +79,28 @@
   "license": "MIT",
   "dependencies": {
     "@iarna/toml": "2.2.5",
-    "@octokit/rest": "21.0.2",
+    "@nodeutils/defaults-deep": "1.1.0",
+    "@octokit/rest": "21.1.1",
+    "@phun-ky/typeof": "1.2.3",
     "async-retry": "1.3.3",
     "chalk": "5.4.1",
-    "ci-info": "^4.1.0",
+    "ci-info": "^4.2.0",
     "cosmiconfig": "9.0.0",
+    "eta": "3.5.0",
     "execa": "9.5.2",
-    "git-url-parse": "16.0.0",
-    "globby": "14.0.2",
-    "inquirer": "12.3.0",
+    "git-url-parse": "16.0.1",
+    "globby": "14.1.0",
+    "inquirer": "12.4.3",
     "issue-parser": "7.0.1",
-    "lodash": "4.17.21",
+    "lodash.get": "4.4.2",
+    "lodash.merge": "4.6.2",
     "mime-types": "2.1.35",
     "new-github-release-url": "2.0.0",
     "open": "10.1.0",
-    "ora": "8.1.1",
+    "ora": "8.2.0",
     "os-name": "6.0.0",
     "proxy-agent": "6.5.0",
-    "semver": "7.6.3",
-    "shelljs": "0.8.5",
+    "semver": "7.7.1",
     "undici": "6.21.1",
     "update-notifier": "7.3.1",
     "url-join": "5.0.0",
@@ -105,30 +108,30 @@
     "yargs-parser": "21.1.1"
   },
   "devDependencies": {
-    "@eslint/compat": "1.2.5",
-    "@eslint/eslintrc": "3.2.0",
-    "@eslint/js": "9.18.0",
-    "@octokit/request-error": "6.1.6",
-    "@types/node": "20.17.11",
+    "@eslint/compat": "1.2.7",
+    "@eslint/eslintrc": "3.3.0",
+    "@eslint/js": "9.22.0",
+    "@octokit/request-error": "6.1.7",
+    "@types/node": "20.17.17",
     "ava": "6.2.0",
-    "eslint": "9.18.0",
-    "eslint-config-prettier": "10.0.1",
+    "eslint": "9.22.0",
+    "eslint-config-prettier": "10.1.1",
     "eslint-plugin-ava": "15.0.1",
     "eslint-plugin-import-x": "4.6.1",
     "eslint-plugin-prettier": "5.2.3",
     "fs-monkey": "1.0.6",
-    "globals": "15.14.0",
+    "globals": "16.0.0",
     "installed-check": "9.3.0",
-    "knip": "5.43.1",
+    "knip": "5.45.0",
     "memfs": "4.17.0",
     "mock-stdio": "1.0.3",
-    "nock": "14.0.0-beta.8",
-    "prettier": "3.4.2",
+    "nock": "14.0.1",
+    "prettier": "3.5.3",
     "remark-cli": "12.0.1",
     "remark-preset-webpro": "1.1.1",
     "sinon": "19.0.2",
     "strip-ansi": "7.1.0",
-    "typescript": "5.7.3"
+    "typescript": "5.8.2"
   },
   "overrides": {
     "pac-resolver": "7.0.1",

package/test/git.init.js

@@ -1,8 +1,10 @@
+import childProcess from 'node:child_process';
+import { mkdirSync } from 'node:fs';
 import test from 'ava';
-import sh from 'shelljs';
 import Shell from '../lib/shell.js';
 import Git from '../lib/plugin/git/Git.js';
-import { readJSON } from '../lib/util.js';
+import { execOpts, readJSON } from '../lib/util.js';
+import sh from './util/sh.js';
 import { factory } from './util/index.js';
 import { mkTmpDir, gitAdd } from './util/helpers.js';
 
@@ -11,10 +13,10 @@ const { git } = readJSON(new URL('../config/release-it.json', import.meta.url));
 test.serial.beforeEach(t => {
   const bare = mkTmpDir();
   const target = mkTmpDir();
-  sh.pushd('-q', bare);
-  sh.exec(`git init --bare .`);
-  sh.exec(`git clone ${bare} ${target}`);
-  sh.pushd('-q', target);
+  process.chdir(bare);
+  sh.exec(`git init --bare .`, execOpts);
+  sh.exec(`git clone ${bare} ${target}`, execOpts);
+  process.chdir(target);
   gitAdd('line', 'file', 'Add file');
   t.context = { bare, target };
 });
@@ -22,14 +24,14 @@ test.serial.beforeEach(t => {
 test.serial('should throw if on wrong branch', async t => {
   const options = { git: { requireBranch: 'dev' } };
   const gitClient = factory(Git, { options });
-  sh.exec('git remote remove origin');
+  childProcess.execSync('git remote remove origin', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^Must be on branch dev/ });
 });
 
 test.serial('should throw if on negated branch', async t => {
   const options = { git: { requireBranch: '!main' } };
   const gitClient = factory(Git, { options });
-  sh.exec('git checkout -b main');
+  sh.exec('git checkout -b main', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^Must be on branch !main/ });
 });
 
@@ -42,39 +44,39 @@ test.serial('should not throw if required branch matches', async t => {
 test.serial('should not throw if one of required branch matches', async t => {
   const options = { git: { requireBranch: ['release/*', 'hotfix/*'] } };
   const gitClient = factory(Git, { options });
-  sh.exec('git checkout -b release/v1');
+  childProcess.execSync('git checkout -b release/v1', execOpts);
   await t.notThrowsAsync(gitClient.init());
 });
 
 test.serial('should throw if there is no remote Git url', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('git remote remove origin');
+  childProcess.execSync('git remote remove origin', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^Could not get remote Git url/ });
 });
 
 test.serial('should throw if working dir is not clean', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('rm file');
+  childProcess.execSync('rm file', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^Working dir must be clean/ });
 });
 
 test.serial('should throw if no upstream is configured', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('git checkout -b foo');
+  childProcess.execSync('git checkout -b foo', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^No upstream configured for current branch/ });
 });
 
 test.serial('should throw if there are no commits', async t => {
   const options = { git: { requireCommits: true } };
   const gitClient = factory(Git, { options });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^There are no commits since the latest tag/ });
 });
 
 test.serial('should not throw if there are commits', async t => {
   const options = { git: { requireCommits: true } };
   const gitClient = factory(Git, { options });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   gitAdd('line', 'file', 'Add file');
   await t.notThrowsAsync(gitClient.init(), 'There are no commits since the latest tag');
 });
@@ -82,29 +84,29 @@ test.serial('should not throw if there are commits', async t => {
 test.serial('should fail (exit code 1) if there are no commits', async t => {
   const options = { git: { requireCommits: true } };
   const gitClient = factory(Git, { options });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await t.throwsAsync(gitClient.init(), { code: 1 });
 });
 
 test.serial('should not fail (exit code 0) if there are no commits', async t => {
   const options = { git: { requireCommits: true, requireCommitsFail: false } };
   const gitClient = factory(Git, { options });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await t.throwsAsync(gitClient.init(), { code: 0 });
 });
 
 test.serial('should throw if there are no commits in specified path', async t => {
   const options = { git: { requireCommits: true, commitsPath: 'dir' } };
   const gitClient = factory(Git, { options });
-  sh.mkdir('dir');
-  sh.exec('git tag 1.0.0');
+  mkdirSync('dir', { recursive: true });
+  sh.exec('git tag 1.0.0', execOpts);
   await t.throwsAsync(gitClient.init(), { message: /^There are no commits since the latest tag/ });
 });
 
 test.serial('should not throw if there are commits in specified path', async t => {
   const options = { git: { requireCommits: true, commitsPath: 'dir' } };
   const gitClient = factory(Git, { options });
-  sh.exec('git tag 1.0.0');
+  sh.exec('git tag 1.0.0', execOpts);
   gitAdd('line', 'dir/file', 'Add file');
   await t.notThrowsAsync(gitClient.init());
 });
@@ -117,14 +119,14 @@ test.serial('should not throw if there are no tags', async t => {
 });
 
 test.serial('should not throw if origin remote is renamed', async t => {
-  sh.exec('git remote rename origin upstream');
+  childProcess.execSync('git remote rename origin upstream', execOpts);
   const gitClient = factory(Git);
   await t.notThrowsAsync(gitClient.init());
 });
 
 test.serial('should detect and include version prefix ("v")', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('git tag v1.0.0');
+  childProcess.execSync('git tag v1.0.0', execOpts);
   await gitClient.init();
   await gitClient.bump('1.0.1');
   t.is(gitClient.config.getContext('tagName'), 'v1.0.1');
@@ -132,7 +134,7 @@ test.serial('should detect and include version prefix ("v")', async t => {
 
 test.serial('should detect and exclude version prefix', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await gitClient.init();
   await gitClient.bump('1.0.1');
   t.is(gitClient.config.getContext('tagName'), '1.0.1');
@@ -140,7 +142,7 @@ test.serial('should detect and exclude version prefix', async t => {
 
 test.serial('should detect and exclude version prefix (configured)', async t => {
   const gitClient = factory(Git, { options: { git: { tagName: 'v${version}' } } });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await gitClient.init();
   await gitClient.bump('1.0.1');
   t.is(gitClient.config.getContext('tagName'), 'v1.0.1');
@@ -148,7 +150,7 @@ test.serial('should detect and exclude version prefix (configured)', async t =>
 
 test.serial('should honor custom tagName configuration', async t => {
   const gitClient = factory(Git, { options: { git: { tagName: 'TAGNAME-${repo.project}-v${version}' } } });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   await gitClient.init();
   await gitClient.bump('1.0.1');
   const { project } = gitClient.getContext('repo');
@@ -160,12 +162,13 @@ test.serial('should get the latest tag after fetch', async t => {
   const gitClient = factory(Git, { container: { shell } });
   const { bare, target } = t.context;
   const other = mkTmpDir();
-  sh.exec('git push');
-  sh.exec(`git clone ${bare} ${other}`);
-  sh.pushd('-q', other);
-  sh.exec('git tag 1.0.0');
-  sh.exec('git push --tags');
-  sh.pushd('-q', target);
+  childProcess.execSync('git push', execOpts);
+  childProcess.execSync(`git clone ${bare} ${other}`, execOpts);
+
+  process.chdir(other);
+  childProcess.execSync('git tag 1.0.0', execOpts);
+  childProcess.execSync('git push --tags', execOpts);
+  process.chdir(target);
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), '1.0.0');
 });
@@ -178,14 +181,14 @@ test.serial('should get the latest custom tag after fetch when tagName is config
   });
   const { bare, target } = t.context;
   const other = mkTmpDir();
-  sh.exec('git push');
-  sh.exec(`git clone ${bare} ${other}`);
-  sh.pushd('-q', other);
-  sh.exec('git tag TAGNAME-OTHER-v2.0.0');
-  sh.exec('git tag TAGNAME-v1.0.0');
-  sh.exec('git tag TAGNAME-OTHER-v2.0.2');
-  sh.exec('git push --tags');
-  sh.pushd('-q', target);
+  childProcess.execSync('git push', execOpts);
+  childProcess.execSync(`git clone ${bare} ${other}`, execOpts);
+  process.chdir(other);
+  childProcess.execSync('git tag TAGNAME-OTHER-v2.0.0', execOpts);
+  childProcess.execSync('git tag TAGNAME-v1.0.0', execOpts);
+  childProcess.execSync('git tag TAGNAME-OTHER-v2.0.2', execOpts);
+  childProcess.execSync('git push --tags', execOpts);
+  process.chdir(target);
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), 'TAGNAME-v1.0.0');
 });
@@ -196,10 +199,10 @@ test.serial('should get the latest tag based on tagMatch', async t => {
     options: { git: { tagMatch: '[0-9][0-9]\\.[0-1][0-9]\\.[0-9]*' } },
     container: { shell }
   });
-  sh.exec('git tag 1.0.0');
-  sh.exec('git tag 21.04.3');
-  sh.exec('git tag 1.0.1');
-  sh.exec('git push --tags');
+  childProcess.execSync('git tag 1.0.0', execOpts);
+  childProcess.execSync('git tag 21.04.3', execOpts);
+  childProcess.execSync('git tag 1.0.1', execOpts);
+  childProcess.execSync('git push --tags', execOpts);
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), '21.04.3');
 });
@@ -210,20 +213,20 @@ test.serial('should get the latest tag based on tagExclude', async t => {
     options: { git: { tagExclude: '*[-]*' } },
     container: { shell }
   });
-  sh.exec('git tag 1.0.0');
-  sh.exec('git commit --allow-empty -m "commit 1"');
-  sh.exec('git tag 1.0.1-rc.0');
-  sh.exec('git tag 1.0.1');
-  sh.exec('git commit --allow-empty -m "commit 2"');
-  sh.exec('git tag 1.1.0-rc.0');
-  sh.exec('git push --tags');
+  childProcess.execSync('git tag 1.0.0', execOpts);
+  childProcess.execSync('git commit --allow-empty -m "commit 1"', execOpts);
+  childProcess.execSync('git tag 1.0.1-rc.0', execOpts);
+  childProcess.execSync('git tag 1.0.1', execOpts);
+  childProcess.execSync('git commit --allow-empty -m "commit 2"', execOpts);
+  childProcess.execSync('git tag 1.1.0-rc.0', execOpts);
+  childProcess.execSync('git push --tags', execOpts);
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), '1.0.1');
 });
 
 test.serial('should generate correct changelog', async t => {
   const gitClient = factory(Git, { options: { git } });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   gitAdd('line', 'file', 'Add file');
   gitAdd('line', 'file', 'Add file');
   await gitClient.init();
@@ -237,11 +240,11 @@ test.serial('should get the full changelog since latest major tag', async t => {
     options: { git: { tagMatch: '[0-9]\\.[0-9]\\.[0-9]', changelog: git.changelog } },
     container: { shell }
   });
-  sh.exec('git tag 1.0.0');
+  childProcess.execSync('git tag 1.0.0', execOpts);
   gitAdd('line', 'file', 'Add file');
-  sh.exec('git tag 2.0.0-rc.0');
+  childProcess.execSync('git tag 2.0.0-rc.0', execOpts);
   gitAdd('line', 'file', 'Add file');
-  sh.exec('git tag 2.0.0-rc.1');
+  childProcess.execSync('git tag 2.0.0-rc.1', execOpts);
   gitAdd('line', 'file', 'Add file');
   await gitClient.init();
   t.is(gitClient.config.getContext('latestTag'), '1.0.0');