Internal improvements, add more tests

package.json

@@ -71,16 +71,22 @@
 	},
 	"devDependencies": {
 		"ava": "^5.2.0",
+		"chalk-template": "^1.0.0",
 		"common-tags": "^1.8.2",
 		"esmock": "^2.2.1",
 		"fs-extra": "^11.1.1",
 		"move-file": "^3.1.0",
 		"sinon": "^15.0.3",
+		"strip-ansi": "^7.0.1",
 		"tempy": "^3.0.0",
 		"write-pkg": "^5.1.0",
 		"xo": "^0.53.1"
 	},
 	"ava": {
+		"files": [
+			"!test/fixtures",
+			"!test/_helpers"
+		],
 		"environmentVariables": {
 			"FORCE_HYPERLINK": "1"
 		},

source/cli-implementation.js

@@ -10,7 +10,7 @@ import config from './config.js';
 import * as util from './util.js';
 import * as git from './git-util.js';
 import * as npm from './npm/util.js';
-import Version from './version.js';
+import {SEMVER_INCREMENTS} from './version.js';
 import ui from './ui.js';
 import np from './index.js';
 
@@ -19,7 +19,7 @@ const cli = meow(`
 	  $ np <version>
 
 	  Version can be:
-	    ${Version.SEMVER_INCREMENTS.join(' | ')} | 1.2.3
+	    ${SEMVER_INCREMENTS.join(' | ')} | 1.2.3
 
 	Options
 	  --any-branch           Allow publishing from any branch
@@ -130,8 +130,8 @@ try {
 		isUnknown: false,
 	};
 
-	// Use current (latest) version when 'releaseDraftOnly', otherwise use the first argument.
-	const version = flags.releaseDraftOnly ? pkg.version : (cli.input.length > 0 ? cli.input[0] : false);
+	// Use current (latest) version when 'releaseDraftOnly', otherwise try to use the first argument.
+	const version = flags.releaseDraftOnly ? pkg.version : (cli.input.at(0) ?? false); // TODO: can this be undefined?
 
 	const branch = flags.branch || await git.defaultBranch();
 	const options = await ui({

source/git-util.js

@@ -2,7 +2,7 @@ import path from 'node:path';
 import {execa} from 'execa';
 import escapeStringRegexp from 'escape-string-regexp';
 import ignoreWalker from 'ignore-walk';
-import Version from './version.js';
+import * as util from './util.js';
 
 export const latestTag = async () => {
 	const {stdout} = await execa('git', ['describe', '--abbrev=0', '--tags']);
@@ -38,6 +38,12 @@ export const readFileFromLastRelease = async file => {
 	return oldFile;
 };
 
+const tagList = async () => {
+	// Returns the list of tags, sorted by creation date in ascending order.
+	const {stdout} = await execa('git', ['tag', '--sort=creatordate']);
+	return stdout.split('\n');
+};
+
 const firstCommit = async () => {
 	const {stdout} = await execa('git', ['rev-list', '--max-parents=0', 'HEAD']);
 	return stdout;
@@ -97,12 +103,6 @@ export const verifyCurrentBranchIsReleaseBranch = async releaseBranch => {
 	}
 };
 
-export const tagList = async () => {
-	// Returns the list of tags, sorted by creation date in ascending order.
-	const {stdout} = await execa('git', ['tag', '--sort=creatordate']);
-	return stdout.split('\n');
-};
-
 export const isHeadDetached = async () => {
 	try {
 		// Command will fail with code 1 if the HEAD is detached.
@@ -113,7 +113,7 @@ export const isHeadDetached = async () => {
 	}
 };
 
-export const isWorkingTreeClean = async () => {
+const isWorkingTreeClean = async () => {
 	try {
 		const {stdout: status} = await execa('git', ['status', '--porcelain']);
 		if (status !== '') {
@@ -182,7 +182,27 @@ export const fetch = async () => {
 	await execa('git', ['fetch']);
 };
 
-export const tagExistsOnRemote = async tagName => {
+const hasLocalBranch = async branch => {
+	try {
+		await execa('git', ['show-ref', '--verify', '--quiet', `refs/heads/${branch}`]);
+		return true;
+	} catch {
+		return false;
+	}
+};
+
+export const defaultBranch = async () => {
+	for (const branch of ['main', 'master', 'gh-pages']) {
+		// eslint-disable-next-line no-await-in-loop
+		if (await hasLocalBranch(branch)) {
+			return branch;
+		}
+	}
+
+	throw new Error('Could not infer the default Git branch. Please specify one with the --branch flag or with a np config.');
+};
+
+const tagExistsOnRemote = async tagName => {
 	try {
 		const {stdout: revInfo} = await execa('git', ['rev-parse', '--quiet', '--verify', `refs/tags/${tagName}`]);
 
@@ -202,26 +222,6 @@ export const tagExistsOnRemote = async tagName => {
 	}
 };
 
-async function hasLocalBranch(branch) {
-	try {
-		await execa('git', ['show-ref', '--verify', '--quiet', `refs/heads/${branch}`]);
-		return true;
-	} catch {
-		return false;
-	}
-}
-
-export const defaultBranch = async () => {
-	for (const branch of ['main', 'master', 'gh-pages']) {
-		// eslint-disable-next-line no-await-in-loop
-		if (await hasLocalBranch(branch)) {
-			return branch;
-		}
-	}
-
-	throw new Error('Could not infer the default Git branch. Please specify one with the --branch flag or with a np config.');
-};
-
 export const verifyTagDoesNotExistOnRemote = async tagName => {
 	if (await tagExistsOnRemote(tagName)) {
 		throw new Error(`Git tag \`${tagName}\` already exists.`);
@@ -233,6 +233,10 @@ export const commitLogFromRevision = async revision => {
 	return stdout;
 };
 
+const push = async () => {
+	await execa('git', ['push', '--follow-tags']);
+};
+
 export const pushGraceful = async remoteIsOnGitHub => {
 	try {
 		await push();
@@ -247,10 +251,6 @@ export const pushGraceful = async remoteIsOnGitHub => {
 	}
 };
 
-export const push = async () => {
-	await execa('git', ['push', '--follow-tags']);
-};
-
 export const deleteTag = async tagName => {
 	await execa('git', ['tag', '--delete', tagName]);
 };
@@ -267,8 +267,7 @@ const gitVersion = async () => {
 
 export const verifyRecentGitVersion = async () => {
 	const installedVersion = await gitVersion();
-
-	Version.verifyRequirementSatisfied('git', installedVersion);
+	util.validateEngineVersionSatisfies('git', installedVersion);
 };
 
 export const checkIfFileGitIgnored = async pathToFile => {

source/index.js

@@ -83,10 +83,13 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 		if (publishStatus === 'FAILED') {
 			await rollback();
 		} else {
-			console.log('\nAborted!');
+			console.log('\nAborted!'); // TODO: maybe only show 'Aborted!' if user cancels?
 		}
 	}, {minimumWait: 2000});
 
+	const shouldEnable2FA = options['2fa'] && options.availability.isAvailable && !options.availability.isUnknown && !pkg.private && !npm.isExternalRegistry(pkg);
+
+	// TODO: move tasks to subdirectory
 	const tasks = new Listr([
 		{
 			title: 'Prerequisite check',
@@ -97,13 +100,7 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 			title: 'Git',
 			task: () => gitTasks(options),
 		},
-	], {
-		showSubtasks: false,
-		renderer: options.renderer ?? 'default',
-	});
-
-	if (runCleanup) {
-		tasks.add([
+		...runCleanup ? [
 			{
 				title: 'Cleanup',
 				enabled: () => !hasLockFile,
@@ -136,11 +133,8 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 					return exec('npm', [...args, '--engine-strict']);
 				},
 			},
-		]);
-	}
-
-	if (runTests) {
-		tasks.add([
+		] : [],
+		...runTests ? [
 			{
 				title: 'Running tests using npm',
 				enabled: () => options.yarn === false,
@@ -159,10 +153,7 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 					}),
 				),
 			},
-		]);
-	}
-
-	tasks.add([
+		] : [],
 		{
 			title: 'Bumping version using Yarn',
 			enabled: () => options.yarn === true,
@@ -211,10 +202,7 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 				return exec('npm', args);
 			},
 		},
-	]);
-
-	if (options.runPublish) {
-		tasks.add([
+		...options.runPublish ? [
 			{
 				title: `Publishing package using ${pkgManagerName}`,
 				skip() {
@@ -239,49 +227,37 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 						);
 				},
 			},
-		]);
-
-		const isExternalRegistry = npm.isExternalRegistry(pkg);
-		if (options['2fa'] && options.availability.isAvailable && !options.availability.isUnknown && !pkg.private && !isExternalRegistry) {
-			tasks.add([
-				{
-					title: 'Enabling two-factor authentication',
-					skip() {
-						if (options.preview) {
-							const args = enable2fa.getEnable2faArgs(pkg.name, options);
-							return `[Preview] Command not executed: npm ${args.join(' ')}.`;
-						}
-					},
-					task: (context, task) => enable2fa(task, pkg.name, {otp: context.otp}),
+			...shouldEnable2FA ? [{
+				title: 'Enabling two-factor authentication',
+				skip() {
+					if (options.preview) {
+						const args = enable2fa.getEnable2faArgs(pkg.name, options);
+						return `[Preview] Command not executed: npm ${args.join(' ')}.`;
+					}
 				},
-			]);
-		}
-	} else {
-		publishStatus = 'SUCCESS';
-	}
-
-	tasks.add({
-		title: 'Pushing tags',
-		async skip() {
-			if (!(await git.hasUpstream())) {
-				return 'Upstream branch not found; not pushing.';
-			}
+				task: (context, task) => enable2fa(task, pkg.name, {otp: context.otp}),
+			}] : [],
+		] : [],
+		{
+			title: 'Pushing tags',
+			async skip() {
+				if (!(await git.hasUpstream())) {
+					return 'Upstream branch not found; not pushing.';
+				}
 
-			if (options.preview) {
-				return '[Preview] Command not executed: git push --follow-tags.';
-			}
+				if (options.preview) {
+					return '[Preview] Command not executed: git push --follow-tags.';
+				}
 
-			if (publishStatus === 'FAILED' && options.runPublish) {
-				return 'Couldn\'t publish package to npm; not pushing.';
-			}
-		},
-		async task() {
-			pushedObjects = await git.pushGraceful(isOnGitHub);
+				if (publishStatus === 'FAILED' && options.runPublish) {
+					return 'Couldn\'t publish package to npm; not pushing.';
+				}
+			},
+			async task() {
+				pushedObjects = await git.pushGraceful(isOnGitHub);
+			},
 		},
-	});
-
-	if (options.releaseDraft) {
-		tasks.add({
+		...options.releaseDraft ? [{
 			title: 'Creating release draft on GitHub',
 			enabled: () => isOnGitHub === true,
 			skip() {
@@ -290,7 +266,14 @@ const np = async (input = 'patch', options, {pkg, rootDir}) => {
 				}
 			},
 			task: () => releaseTaskHelper(options, pkg),
-		});
+		}] : [],
+	], {
+		showSubtasks: false,
+		renderer: options.renderer ?? 'default',
+	});
+
+	if (!options.runPublish) {
+		publishStatus = 'SUCCESS';
 	}
 
 	await tasks.run();

source/npm/handle-npm-error.js

@@ -27,7 +27,7 @@ const handleNpmError = (error, task, message, executor) => {
 	// Attempting to privately publish a scoped package without the correct npm plan
 	// https://stackoverflow.com/a/44862841/10292952
 	if (error.code === 402 || error.stderr.includes('npm ERR! 402 Payment Required')) {
-		throw new Error('You cannot publish a privately scoped package without a paid plan. Did you mean to publish publicly?');
+		throw new Error('You cannot publish a scoped package privately without a paid plan. Did you mean to publish publicly?');
 	}
 
 	return throwError(() => error);