relion 0.1.1 → 0.2.0

package/package.json

@@ -1,74 +1,85 @@
 {
-	"name": "relion",
-	"version": "0.1.1",
-	"description": "Release workflow helper for Node.js projects.",
-	"author": "Kh4f",
-	"license": "MIT",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/Kh4f/relion.git"
-	},
-	"bugs": {
-		"url": "https://github.com/Kh4f/relion/issues"
-	},
-	"homepage": "https://github.com/Kh4f/relion#readme",
-	"keywords": [
-		"relion",
-		"release",
-		"release-workflow",
-		"release-helper",
-		"semantic-release",
-		"conventional-changelog",
-		"standard-version",
-		"commit-and-tag-version"
-	],
-	"main": "./src/index.js",
-	"type": "module",
-	"bin": "bin/cli.js",
-	"files": [
-		"bin",
-		"src",
-		"package.json",
-		"LICENSE",
-		"README.md",
-		"CHANGELOG.md"
-	],
-	"scripts": {
-		"lint": "eslint .",
-		"lint:fix": "npm run lint -- --fix",
-		"format:base": "prettier \"./**/*.{ts,js}\"",
-		"format:fix": "npm run format:base -- --write",
-		"format:check": "npm run format:base -- --check",
-		"release": "node bin/cli.js --changelog --bump --commit --tag",
-		"release:gh-notes": "node bin/cli.js --profile gh-release-notes --changelog"
-	},
-	"dependencies": {
-		"chalk": "^5.4.1",
-		"conventional-changelog": "^6.0.0",
-		"conventional-changelog-config-spec": "^2.1.0",
-		"conventional-changelog-conventionalcommits": "^8.0.0",
-		"conventional-recommended-bump": "^11.0.0",
-		"detect-indent": "^7.0.1",
-		"detect-newline": "^4.0.1",
-		"dotgitignore": "^2.1.0",
-		"figures": "^6.1.0",
-		"find-up": "^7.0.0",
-		"git-semver-tags": "^8.0.0",
-		"jsdom": "^26.1.0",
-		"mergician": "^2.0.2",
-		"semver": "^7.7.2",
-		"w3c-xmlserializer": "^5.0.0",
-		"yaml": "^2.8.0",
-		"yargs": "^17.7.2"
-	},
-	"devDependencies": {
-		"@eslint/js": "^9.27.0",
-		"eslint": "^9.27.0",
-		"eslint-config-prettier": "^10.1.5",
-		"eslint-plugin-import": "^2.31.0",
-		"eslint-plugin-jest": "^28.11.0",
-		"eslint-plugin-n": "^17.18.0",
-		"eslint-plugin-promise": "^7.2.1",
-		"prettier": "^3.5.3"
-	}
-}
+  "name": "relion",
+  "version": "0.2.0",
+  "description": "Release workflow helper for Node.js projects.",
+  "author": "Kh4f",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Kh4f/relion.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Kh4f/relion/issues"
+  },
+  "homepage": "https://github.com/Kh4f/relion#readme",
+  "keywords": [
+    "relion",
+    "release",
+    "release-workflow",
+    "release-helper",
+    "semantic-release",
+    "conventional-changelog",
+    "standard-version",
+    "commit-and-tag-version"
+  ],
+  "main": "./src/index.js",
+  "type": "module",
+  "bin": "./src/cli.js",
+  "files": [
+    "src",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*.{js,ts}": "pnpm lint:fix"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "compare-func": "^2.0.0",
+    "conventional-changelog": "^6.0.0",
+    "conventional-changelog-config-spec": "^2.1.0",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
+    "conventional-recommended-bump": "^11.0.0",
+    "detect-indent": "^7.0.1",
+    "detect-newline": "^4.0.1",
+    "dotgitignore": "^2.1.0",
+    "figures": "^6.1.0",
+    "find-up": "^7.0.0",
+    "git-semver-tags": "^8.0.0",
+    "jsdom": "^26.1.0",
+    "mergician": "^2.0.2",
+    "semver": "^7.7.2",
+    "w3c-xmlserializer": "^5.0.0",
+    "yaml": "^2.8.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.29.0",
+    "@stylistic/eslint-plugin": "^4.4.1",
+    "@types/node": "^24.0.3",
+    "eslint": "^9.29.0",
+    "globals": "^16.2.0",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.5.3",
+    "simple-git-hooks": "^2.13.0",
+    "tsdown": "^0.12.8",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.34.1",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "build": "tsdown",
+    "build:watch": "tsdown --watch",
+    "build:prod": "tsdown --production",
+    "release": "node ./src/cli.js --changelog --bump --commit --tag",
+    "release:gh-notes": "node ./src/cli.js --changelog --profile gh-release-notes "
+  }
+}

package/src/cli.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+import relion from './index.js'
+import cmdParser from './commands.js'
+
+relion(cmdParser.argv)

package/src/commands.js

@@ -1,15 +1,11 @@
-import spec from 'conventional-changelog-config-spec';
-import { getConfiguration } from './lib/configuration.js';
-import defaults from './defaults.js';
-import yargs from 'yargs/yargs';
-import { hideBin } from 'yargs/helpers';
+import spec from 'conventional-changelog-config-spec'
+import { getConfiguration } from './lib/configuration.js'
+import defaults from './defaults.js'
+import yargs from 'yargs/yargs'
+import { hideBin } from 'yargs/helpers'
 
 const yargsInstance = yargs(hideBin(process.argv))
 	.usage('Usage: $0 [options]')
-	.option('packageFiles', {
-		default: defaults.packageFiles,
-		array: true,
-	})
 	.option('bumpFiles', {
 		default: defaults.bumpFiles,
 		array: true,
@@ -30,12 +26,6 @@ const yargsInstance = yargs(hideBin(process.argv))
 		describe: 'Read the CHANGELOG from this file',
 		default: defaults.infile,
 	})
-	.option('message', {
-		alias: ['m'],
-		describe:
-			'[DEPRECATED] Commit message, replaces %s with new version.\nThis option will be removed in the next major version, please use --releaseCommitMessageFormat.',
-		type: 'string',
-	})
 	.option('sign', {
 		alias: 's',
 		describe: 'Should the git commit and tag be signed?',
@@ -60,7 +50,7 @@ const yargsInstance = yargs(hideBin(process.argv))
 		default: defaults.commitAll,
 	})
 	.option('silent', {
-		describe: "Don't print logs and errors",
+		describe: 'Don\'t print logs and errors',
 		type: 'boolean',
 		default: defaults.silent,
 	})
@@ -145,11 +135,6 @@ const yargsInstance = yargs(hideBin(process.argv))
 		type: 'string',
 		describe: 'Only populate commits made under this path',
 	})
-	.option('changelogHeader', {
-		type: 'string',
-		describe:
-			'[DEPRECATED] Use a custom header when generating and updating changelog.\nThis option will be removed in the next major version, please use --header.',
-	})
 	.option('lerna-package', {
 		type: 'string',
 		describe: 'Name of the package from which the tags will be extracted',
@@ -161,9 +146,10 @@ const yargsInstance = yargs(hideBin(process.argv))
 	})
 	.check((argv) => {
 		if (typeof argv.scripts !== 'object' || Array.isArray(argv.scripts)) {
-			throw Error('scripts must be an object');
-		} else {
-			return true;
+			throw Error('scripts must be an object')
+		}
+		else {
+			return true
 		}
 	})
 	.alias('version', 'v')
@@ -175,16 +161,16 @@ const yargsInstance = yargs(hideBin(process.argv))
 	)
 	.pkgConf('relion')
 	.config(await getConfiguration())
-	.wrap(97);
+	.wrap(97)
 
 Object.keys(spec.properties).forEach((propertyKey) => {
-	const property = spec.properties[propertyKey];
-	if (!defaults.preset[propertyKey]) return;
+	const property = spec.properties[propertyKey]
+	if (!defaults.preset[propertyKey]) return
 	yargsInstance.option('preset.' + propertyKey, {
 		type: property.type,
 		describe: property.description,
 		default: defaults.preset[propertyKey],
-	});
-});
+	})
+})
 
-export default yargsInstance;
+export default yargsInstance

package/src/defaults.js

@@ -1,4 +1,4 @@
-const defaultPresetURL = import.meta.resolve('./preset/index.js');
+const defaultPresetURL = import.meta.resolve('./preset/index.js')
 
 const defaults = {
 	bump: false,
@@ -20,7 +20,7 @@ const defaults = {
 	tagForce: false,
 	gitTagFallback: true,
 	npmPublishHint: undefined,
-	packageFiles: ['package.json', 'bower.json', 'manifest.json'],
+	bumpFiles: ['package.json', 'package-lock.json'],
 
 	context: {
 		linkReferences: true,
@@ -29,8 +29,6 @@ const defaults = {
 
 	preset: {
 		name: defaultPresetURL,
-		// defaults provided by the spec
-		// https://github.com/conventional-changelog/conventional-changelog-config-spec/tree/master/versions/2.2.0
 		header: '# Changelog\n\n\n',
 		types: [
 			{ type: 'feat', section: 'Features' },
@@ -42,11 +40,10 @@ const defaults = {
 			{ type: 'perf', hidden: true },
 			{ type: 'test', hidden: true },
 		],
-		/* preMajor value is defined in spec, but should not be in defaults 
-		   since it's set to true automatically if version < 1.0.0, 
+		/* Is set to true automatically if version < 1.0.0,
 		   or matches the user config if provided.
 		*/
-		// preMajor: false,
+		// preMajor: true,
 		commitUrlFormat: '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
 		compareUrlFormat: '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
 		issueUrlFormat: '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
@@ -58,11 +55,6 @@ const defaults = {
 	writerOpts: {
 		commitsSort: false,
 	},
-};
+}
 
-defaults.bumpFiles = defaults.packageFiles.concat([
-	'package-lock.json',
-	'npm-shrinkwrap.json',
-]);
-
-export default defaults;
+export default defaults

package/src/index.js

@@ -1,126 +1,49 @@
-import bump, { getNewVersion } from './lib/lifecycles/bump.js';
-import changelog from './lib/lifecycles/changelog.js';
-import commit from './lib/lifecycles/commit.js';
-import fs from 'fs';
-import latestSemverTag from './lib/latest-semver-tag.js';
-import path from 'path';
-import printError from './lib/print-error.js';
-import tag from './lib/lifecycles/tag.js';
-import { resolveUpdaterObjectFromArgument } from './lib/updaters/index.js';
-import defaults from './defaults.js';
-import { mergician } from 'mergician';
-import { execSync } from 'child_process';
+import bump, { getNewVersion } from './lib/lifecycles/bump.js'
+import changelog from './lib/lifecycles/changelog.js'
+import commit from './lib/lifecycles/commit.js'
+import { readFileSync } from 'fs'
+import tag from './lib/lifecycles/tag.js'
+import defaults from './defaults.js'
+import { mergician } from 'mergician'
+import { execSync } from 'child_process'
 
 export default async function relion(argv) {
-	/**
-	 * `--message` (`-m`) support will be removed in the next major version.
-	 */
-	const message = argv.m || argv.message;
-	if (message) {
-		/**
-		 * The `--message` flag uses `%s` for version substitutions, we swap this
-		 * for the substitution defined in the config-spec for future-proofing upstream
-		 * handling.
-		 */
-		argv.preset.releaseCommitMessageFormat = message.replace(/%s/g, '{{currentTag}}');
-		if (!argv.silent) {
-			console.warn(
-				'[relion]: --message (-m) will be removed in the next major release. Use --releaseCommitMessageFormat.',
-			);
-		}
-	}
+	let args = mergician(defaults, argv)
+	if (args.profile) args = mergeProfileConfig(args)
 
-	if (argv.changelogHeader) {
-		argv.preset.header = argv.changelogHeader;
-		if (!argv.silent) {
-			console.warn(
-				'[relion]: --changelogHeader will be removed in the next major release. Use --header.',
-			);
-		}
-	}
+	if (args.all) args.bump = args.changelog = args.commit = args.tag = true
 
-	if (argv.preset.header && argv.preset.header.search(changelog.START_OF_LAST_RELEASE_PATTERN) !== -1) {
-		throw Error(`custom changelog header must not match ${changelog.START_OF_LAST_RELEASE_PATTERN}`);
-	}
+	const currentVersion = getCurrentVersion()
+	const newVersion = await getNewVersion(args, currentVersion)
+	args.context.version = newVersion
+	args.context.newTag = args.tagPrefix + newVersion
 
-	/**
-	 * If an argument for `packageFiles` provided, we include it as a "default" `bumpFile`.
-	 */
-	if (argv.packageFiles) {
-		defaults.bumpFiles = defaults.bumpFiles.concat(argv.packageFiles);
-	}
+	if (lastCommitHasTag()) {
+		// use the current version as the new version if there's no new commits
+		// to avoid empty new release changelog generation
+		args.context.version = currentVersion
 
-	let args = mergician(defaults, argv);
-	if (args.profile) {
-		args = mergeProfileConfig(args);
-	}
-	
-	let pkg;
-	for (const packageFile of args.packageFiles) {
-		const updater = await resolveUpdaterObjectFromArgument(packageFile);
-		if (!updater) return;
-		const pkgPath = path.resolve(process.cwd(), updater.filename);
-		try {
-			const contents = fs.readFileSync(pkgPath, 'utf8');
-			pkg = {
-				version: updater.updater.readVersion(contents),
-				private:
-					typeof updater.updater.isPrivate === 'function'
-						? updater.updater.isPrivate(contents)
-						: false,
-			};
-			break;
-			// eslint-disable-next-line no-unused-vars
-		} catch (err) {
-			/* This probably shouldn't be empty? */
+		if (args.releaseCount === 1) {
+			// genearate the last release changelog
+			args.releaseCount = 2
 		}
 	}
-	try {
-		let version;
-		if (pkg && pkg.version) {
-			version = pkg.version;
-		} else if (args.gitTagFallback) {
-			version = await latestSemverTag(args);
-		} else {
-			throw new Error('no package file found');
-		}
 
-		if (args.all) {
-			args.bump = true;
-			args.changelog = true;
-			args.commit = true;
-			args.tag = true;
-		}
-
-		const newVersion = await getNewVersion(args, version);
-		args.context.version = newVersion;
-		args.context.newTag = args.tagPrefix + newVersion;
-
-		if (lastCommitHasTag()) {
-			// use the current version as the new version if there's no new commits
-			// to avoid empty new release changelog generation
-			args.context.version = version;
+	if (args.bump) await bump(args, newVersion)
+	if (args.changelog) await changelog(args, newVersion)
+	if (args.commit) await commit(args, newVersion)
+	if (args.tag) await tag(newVersion, false, args)
+}
 
-			if (args.releaseCount === 1) {
-				// genearate the last release changelog
-				args.releaseCount = 2;
-			}
-		}
-		
-		args.bump && (await bump(args, newVersion));
-		args.changelog && (await changelog(args, newVersion));
-		args.commit && (await commit(args, newVersion));
-		args.tag && (await tag(newVersion, pkg ? pkg.private : false, args));
-	} catch (err) {
-		printError(args, err.message);
-		throw err;
-	}
+function getCurrentVersion() {
+	const packageJsonContent = readFileSync('package.json', 'utf-8')
+	return /"version".*?"(.*?)"/.exec(packageJsonContent)?.[1]
 }
 
 function lastCommitHasTag() {
-	const lastCommit = execSync('git rev-parse HEAD').toString().trim();
-	const tags = execSync(`git tag --points-at ${lastCommit}`).toString().trim();
-	return !!tags;
+	const lastCommit = execSync('git rev-parse HEAD').toString().trim()
+	const tags = execSync(`git tag --points-at ${lastCommit}`).toString().trim()
+	return !!tags
 }
 
 /**
@@ -129,24 +52,24 @@ function lastCommitHasTag() {
  */
 function mergeProfileConfig(args) {
 	function uniqBy(arr, keyFn) {
-		const seen = new Set();
-		return arr.filter(item => {
-			const key = keyFn(item);
-			if (seen.has(key)) return false;
-			seen.add(key);
-			return true;
-		});
+		const seen = new Set()
+		return arr.filter((item) => {
+			const key = keyFn(item)
+			if (seen.has(key)) return false
+			seen.add(key)
+			return true
+		})
 	}
 
-	const profileKey = `_${args.profile}`;
+	const profileKey = `_${args.profile}`
 	const merged = mergician({
 		prependArrays: true,
-		dedupArrays: true
-	})(args, structuredClone(args[profileKey]));
+		dedupArrays: true,
+	})(args, structuredClone(args[profileKey]))
 
-	const dedupedTypes = uniqBy(merged.preset.types, item => item.type);
-	merged.preset.types = dedupedTypes;
+	const dedupedTypes = uniqBy(merged.preset.types, item => item.type)
+	merged.preset.types = dedupedTypes
 
-	delete merged[profileKey];
-	return merged;
-}
+	delete merged[profileKey]
+	return merged
+}

package/src/lib/checkpoint.js

@@ -1,23 +1,23 @@
-import chalk from 'chalk';
-import figures from 'figures';
-import util from 'util';
+import chalk from 'chalk'
+import figures from 'figures'
+import util from 'util'
 
 export default function (argv, msg, args, figure) {
 	const defaultFigure = argv.dryRun
 		? chalk.yellow(figures.tick)
-		: chalk.green(figures.tick);
+		: chalk.green(figures.tick)
 	if (!argv.silent) {
 		console.info(
-			(figure || defaultFigure) +
-			' ' +
-			util.format.apply(
+			(figure || defaultFigure)
+			+ ' '
+			+ util.format.apply(
 				util,
 				[msg].concat(
 					args.map(function (arg) {
-						return chalk.bold(arg);
+						return chalk.bold(arg)
 					}),
 				),
 			),
-		);
+		)
 	}
-}
+}

package/src/lib/configuration.js

@@ -1,35 +1,35 @@
-import path from 'path';
-import { findUpSync } from 'find-up';
-import { readFileSync } from 'fs';
-import { pathToFileURL } from 'url';
-
+import path from 'path'
+import { findUpSync } from 'find-up'
+import { readFileSync } from 'fs'
+import { pathToFileURL } from 'url'
 
 const CONFIGURATION_FILES = [
 	'', '.json', '.js', '.cjs', '.mjs', '.ts']
-	.map(ext => `.versionrc${ext}`);
-
+	.map(ext => `.versionrc${ext}`)
 
 export async function getConfiguration() {
-	let config = {};
-	const configPath = findUpSync(CONFIGURATION_FILES);
-	if (!configPath) return config;
+	let config = {}
+	const configPath = findUpSync(CONFIGURATION_FILES)
+	if (!configPath) return config
 
-	const ext = path.extname(configPath);
-	const regex = /^\.([cm]?js|ts)$/;
+	const ext = path.extname(configPath)
+	const regex = /^\.([cm]?js|ts)$/
 	if (regex.test(ext)) {
-		const exportedConfig = (await import(pathToFileURL(configPath).href)).default;
+		const exportedConfig = (await import(pathToFileURL(configPath).href)).default
 		if (typeof exportedConfig === 'function') {
-			config = exportedConfig();
-		} else {
-			config = exportedConfig;
+			config = exportedConfig()
 		}
-	} else {
-		config = JSON.parse(readFileSync(configPath));
+		else {
+			config = exportedConfig
+		}
+	}
+	else {
+		config = JSON.parse(readFileSync(configPath))
 	}
 
 	if (typeof config !== 'object') {
-		throw Error(`[relion] Invalid configuration in ${configPath} provided. Expected an object but found ${typeof config}.`,);
+		throw Error(`[relion] Invalid configuration in ${configPath} provided. Expected an object but found ${typeof config}.`)
 	}
 
-	return config;
-}
+	return config
+}