relion 0.2.0 → 0.3.0

package/package.json

@@ -1,17 +1,12 @@
 {
   "name": "relion",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Release workflow helper for Node.js projects.",
-  "author": "Kh4f",
+  "author": "Kh4f <kh4f.dev@gmail.com>",
   "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",
+  "repository": "https://github.com/kh4f/relion",
+  "bugs": "https://github.com/kh4f/relion/issues",
+  "homepage": "https://github.com/kh4f/relion#readme",
   "keywords": [
     "relion",
     "release",
@@ -22,55 +17,41 @@
     "standard-version",
     "commit-and-tag-version"
   ],
-  "main": "./src/index.js",
-  "type": "module",
-  "bin": "./src/cli.js",
   "files": [
-    "src",
+    "dist",
     "package.json",
     "LICENSE",
     "README.md"
   ],
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": "dist/cli.js",
+  "dependencies": {
+    "cleye": "^1.3.4",
+    "handlebars": "^4.7.8",
+    "semver": "^7.7.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.34.0",
+    "@stylistic/eslint-plugin": "^5.3.1",
+    "@types/node": "^24.3.1",
+    "@types/semver": "^7.7.1",
+    "eslint": "^9.34.0",
+    "globals": "^16.3.0",
+    "lint-staged": "^16.1.6",
+    "simple-git-hooks": "^2.13.1",
+    "tsdown": "^0.14.2",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.42.0",
+    "vitest": "^3.2.4"
+  },
   "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",
@@ -79,7 +60,7 @@
     "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 "
+    "release": "node dist/cli.js -blct",
+    "release:github": "node dist/cli.js -l -p github"
   }
 }

package/src/cli.js

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

package/src/commands.js

@@ -1,176 +0,0 @@
-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('bumpFiles', {
-		default: defaults.bumpFiles,
-		array: true,
-	})
-	.option('release-as', {
-		alias: 'r',
-		describe: 'Specify the release type manually (like npm version <major|minor|patch>)',
-		requiresArg: true,
-		string: true,
-	})
-	.option('prerelease', {
-		alias: 'P',
-		describe: 'make a pre-release with optional option value to specify a tag id',
-		string: true,
-	})
-	.option('infile', {
-		alias: 'i',
-		describe: 'Read the CHANGELOG from this file',
-		default: defaults.infile,
-	})
-	.option('sign', {
-		alias: 's',
-		describe: 'Should the git commit and tag be signed?',
-		type: 'boolean',
-		default: defaults.sign,
-	})
-	.option('signoff', {
-		describe: 'Should the git commit have a "Signed-off-by" trailer',
-		type: 'boolean',
-		default: defaults.signoff,
-	})
-	.option('no-verify', {
-		alias: 'n',
-		describe: 'Bypass pre-commit or commit-msg git hooks during the commit phase',
-		type: 'boolean',
-		default: defaults.noVerify,
-	})
-	.option('commit-all', {
-		alias: 'C',
-		describe: 'Commit all staged changes, not just files affected by relion',
-		type: 'boolean',
-		default: defaults.commitAll,
-	})
-	.option('silent', {
-		describe: 'Don\'t print logs and errors',
-		type: 'boolean',
-		default: defaults.silent,
-	})
-	.option('tag-prefix', {
-		alias: 'T',
-		describe: 'Set a custom prefix for the git tag to be created',
-		type: 'string',
-		default: defaults.tagPrefix,
-	})
-	.option('release-count', {
-		describe:
-			'How many releases of changelog you want to generate. It counts from the upcoming release. Useful when you forgot to generate any previous changelog. Set to 0 to regenerate all.',
-		type: 'number',
-		default: defaults.releaseCount,
-	})
-	.option('tag-force', {
-		describe: 'Allow tag replacement',
-		type: 'boolean',
-		default: defaults.tagForce,
-	})
-	.option('scripts', {
-		describe: 'Provide scripts to execute for lifecycle events (prebump, precommit, etc.,)',
-		default: defaults.scripts,
-	})
-	.option('bump', {
-		alias: 'b',
-		describe: 'Bump the version in bumpFiles',
-		type: 'boolean',
-		default: defaults.bump,
-	})
-	.option('changelog', {
-		alias: 'l',
-		describe: 'Generate a changelog',
-		type: 'boolean',
-		default: defaults.changelog,
-	})
-	.option('commit', {
-		alias: 'c',
-		describe: 'Create a git commit',
-		type: 'boolean',
-		default: defaults.commit,
-	})
-	.option('tag', {
-		alias: 't',
-		describe: 'Create a git tag',
-		type: 'boolean',
-		default: defaults.tag,
-	})
-	.option('all', {
-		alias: 'a',
-		describe: 'Run all lifecycle events',
-		type: 'boolean',
-		default: defaults.all,
-	})
-	.option('context.linkReferences', {
-		describe: 'Should all references be linked?',
-		type: 'boolean',
-		default: defaults.context.linkReferences,
-	})
-	.option('context.fullChangelogLink', {
-		describe: 'Add a "Full Changelog: v1...v2" link to the footer',
-		type: 'boolean',
-		default: defaults.context.fullChangelogLink,
-	})
-	.option('profile', {
-		alias: 'p',
-		describe: 'Specify a named config profile to merge with the base config (properties under _<profile-name> in .versionrc)',
-		type: 'string',
-	})
-	.option('dry-run', {
-		type: 'boolean',
-		default: defaults.dryRun,
-		describe: 'See the commands that running relion would run',
-	})
-	.option('git-tag-fallback', {
-		type: 'boolean',
-		default: defaults.gitTagFallback,
-		describe:
-			'fallback to git tags for version, if no meta-information file is found (e.g., package.json)',
-	})
-	.option('path', {
-		type: 'string',
-		describe: 'Only populate commits made under this path',
-	})
-	.option('lerna-package', {
-		type: 'string',
-		describe: 'Name of the package from which the tags will be extracted',
-	})
-	.option('npmPublishHint', {
-		type: 'string',
-		default: defaults.npmPublishHint,
-		describe: 'Customized publishing hint',
-	})
-	.check((argv) => {
-		if (typeof argv.scripts !== 'object' || Array.isArray(argv.scripts)) {
-			throw Error('scripts must be an object')
-		}
-		else {
-			return true
-		}
-	})
-	.alias('version', 'v')
-	.alias('help', 'h')
-	.example('$0', 'Update changelog and tag release')
-	.example(
-		'$0 -m "%s: see changelog for details"',
-		'Update changelog and tag release with custom commit message',
-	)
-	.pkgConf('relion')
-	.config(await getConfiguration())
-	.wrap(97)
-
-Object.keys(spec.properties).forEach((propertyKey) => {
-	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

package/src/defaults.js

@@ -1,60 +0,0 @@
-const defaultPresetURL = import.meta.resolve('./preset/index.js')
-
-const defaults = {
-	bump: false,
-	changelog: false,
-	commit: false,
-	tag: false,
-	all: false,
-
-	infile: 'CHANGELOG.md',
-	sign: false,
-	signoff: false,
-	noVerify: false,
-	commitAll: false,
-	silent: false,
-	tagPrefix: 'v',
-	releaseCount: 1,
-	scripts: {},
-	dryRun: false,
-	tagForce: false,
-	gitTagFallback: true,
-	npmPublishHint: undefined,
-	bumpFiles: ['package.json', 'package-lock.json'],
-
-	context: {
-		linkReferences: true,
-		fullChangelogLink: false,
-	},
-
-	preset: {
-		name: defaultPresetURL,
-		header: '# Changelog\n\n\n',
-		types: [
-			{ type: 'feat', section: 'Features' },
-			{ type: 'fix', section: 'Bug Fixes' },
-			{ type: 'chore', hidden: true },
-			{ type: 'docs', hidden: true },
-			{ type: 'style', hidden: true },
-			{ type: 'refactor', hidden: true },
-			{ type: 'perf', hidden: true },
-			{ type: 'test', hidden: true },
-		],
-		/* Is set to true automatically if version < 1.0.0,
-		   or matches the user config if provided.
-		*/
-		// preMajor: true,
-		commitUrlFormat: '{{host}}/{{owner}}/{{repository}}/commit/{{hash}}',
-		compareUrlFormat: '{{host}}/{{owner}}/{{repository}}/compare/{{previousTag}}...{{currentTag}}',
-		issueUrlFormat: '{{host}}/{{owner}}/{{repository}}/issues/{{id}}',
-		userUrlFormat: '{{host}}/{{user}}',
-		releaseCommitMessageFormat: 'chore(release): {{currentTag}}',
-		issuePrefixes: ['#'],
-	},
-
-	writerOpts: {
-		commitsSort: false,
-	},
-}
-
-export default defaults

package/src/index.js

@@ -1,75 +0,0 @@
-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) {
-	let args = mergician(defaults, argv)
-	if (args.profile) args = mergeProfileConfig(args)
-
-	if (args.all) args.bump = args.changelog = args.commit = args.tag = true
-
-	const currentVersion = getCurrentVersion()
-	const newVersion = await getNewVersion(args, currentVersion)
-	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 = currentVersion
-
-		if (args.releaseCount === 1) {
-			// genearate the last release changelog
-			args.releaseCount = 2
-		}
-	}
-
-	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)
-}
-
-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
-}
-
-/**
- * Merge profile config if args.profile is specified.
- * Merges args._<profile> into args, then deletes args._<profile>.
- */
-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 profileKey = `_${args.profile}`
-	const merged = mergician({
-		prependArrays: true,
-		dedupArrays: true,
-	})(args, structuredClone(args[profileKey]))
-
-	const dedupedTypes = uniqBy(merged.preset.types, item => item.type)
-	merged.preset.types = dedupedTypes
-
-	delete merged[profileKey]
-	return merged
-}

package/src/lib/checkpoint.js

@@ -1,23 +0,0 @@
-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)
-	if (!argv.silent) {
-		console.info(
-			(figure || defaultFigure)
-			+ ' '
-			+ util.format.apply(
-				util,
-				[msg].concat(
-					args.map(function (arg) {
-						return chalk.bold(arg)
-					}),
-				),
-			),
-		)
-	}
-}

package/src/lib/configuration.js

@@ -1,35 +0,0 @@
-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}`)
-
-export async function getConfiguration() {
-	let config = {}
-	const configPath = findUpSync(CONFIGURATION_FILES)
-	if (!configPath) return config
-
-	const ext = path.extname(configPath)
-	const regex = /^\.([cm]?js|ts)$/
-	if (regex.test(ext)) {
-		const exportedConfig = (await import(pathToFileURL(configPath).href)).default
-		if (typeof exportedConfig === 'function') {
-			config = exportedConfig()
-		}
-		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}.`)
-	}
-
-	return config
-}

package/src/lib/detect-package-manager.js

@@ -1,52 +0,0 @@
-/**
- * modified from <https://github.com/egoist/detect-package-manager/blob/main/src/index.ts>
- * the original code is licensed under MIT
- * modified to support only detecting lock file and not detecting global package manager
- */
-
-import { promises as fs } from 'fs'
-import { resolve } from 'path'
-
-/**
- * Check if a path exists
- */
-async function pathExists(p) {
-	try {
-		await fs.access(p)
-		return true
-	}
-	catch {
-		return false
-	}
-}
-
-function getTypeofLockFile(cwd = '.') {
-	return Promise.all([
-		pathExists(resolve(cwd, 'yarn.lock')),
-		pathExists(resolve(cwd, 'package-lock.json')),
-		pathExists(resolve(cwd, 'pnpm-lock.yaml')),
-	]).then(([isYarn, isNpm, isPnpm]) => {
-		let value = null
-
-		if (isYarn) {
-			value = 'yarn'
-		}
-		else if (isPnpm) {
-			value = 'pnpm'
-		}
-		else if (isNpm) {
-			value = 'npm'
-		}
-
-		return value
-	})
-}
-
-export async function detectPMByLockFile(cwd) {
-	const type = await getTypeofLockFile(cwd)
-	if (type) {
-		return type
-	}
-
-	return 'npm'
-}

package/src/lib/format-commit-message.js

@@ -1,4 +0,0 @@
-export default function (args) {
-	const message = String(args.preset.releaseCommitMessageFormat)
-	return message.replace(/{{currentTag}}/g, args.tagPrefix + args.context.version)
-}

package/src/lib/latest-semver-tag.js

@@ -1,34 +0,0 @@
-import * as gitSemverTags from 'git-semver-tags'
-import semver from 'semver'
-
-export default function ({ tagPrefix, prerelease }) {
-	return new Promise((resolve, reject) => {
-		gitSemverTags({ tagPrefix }, function (err, tags) {
-			if (err) return reject(err)
-			else if (!tags.length) return resolve('1.0.0')
-			// Respect tagPrefix
-			tags = tags.map(tag => tag.replace(new RegExp('^' + tagPrefix), ''))
-			if (prerelease) {
-				// ignore any other prelease tags
-				tags = tags.filter((tag) => {
-					if (!semver.valid(tag)) return false
-					if (!semver.prerelease(tag)) {
-						// include all non-prerelease versions
-						return true
-					}
-					// check if the name of the prerelease matches the one we are looking for
-					if (semver.prerelease(tag)[0] === prerelease) {
-						return true
-					}
-					return false
-				})
-			}
-			// ensure that the largest semver tag is at the head.
-			tags = tags.map((tag) => {
-				return semver.clean(tag)
-			})
-			tags.sort(semver.rcompare)
-			return resolve(tags[0])
-		})
-	})
-}