relion 0.42.1 → 0.43.0

package/README.md

@@ -5,145 +5,61 @@
 	</picture>
 	<br>
 	<a href="https://www.npmjs.com/package/relion"><img src="https://img.shields.io/npm/v/relion?label=npm&logo=npm&style=flat-square&color=B2BFFF&labelColor=303145" alt="npm version"/></a>&nbsp;
-	<a href="https://www.npmjs.com/package/relion"><img src="https://img.badgesize.io/https:/unpkg.com/relion/dist/index.js?label=Size&logo=hackthebox&logoColor=c97026&style=flat-square&color=B2BFFF&labelColor=303145" alt="runtime size"/></a>&nbsp;
+	<a href="https://www.npmjs.com/package/relion"><img src="https://img.badgesize.io/https:/unpkg.com/relion/dist/cli.js?label=Size&logo=hackthebox&logoColor=c97026&style=flat-square&color=B2BFFF&labelColor=303145" alt="runtime size"/></a>&nbsp;
 	<a href="https://github.com/kh4f/relion/blob/master/LICENSE"><img src="https://img.shields.io/github/license/kh4f/relion?style=flat-square&label=%F0%9F%9B%A1%EF%B8%8F%20License&color=B2BFFF&labelColor=303145" alt="license"></a>&nbsp;
 	<a href="https://github.com/kh4f/relion/issues?q=is%3Aissue+is%3Aopen+label%3Abug"><img src="https://img.shields.io/github/issues/kh4f/relion/bug?label=%F0%9F%90%9B%20Bugs&style=flat-square&color=B2BFFF&labelColor=303145" alt="open bugs"></a>
 	<br><br>
 	<b>A minimal npm library for automating release workflow:<br></b> version bumping, release commit & tag creation, and AI‑assisted changelog generation
 	<br><br>
 	<p><b>
-		<a href="#-installation">Installation</a>&nbsp; •&nbsp;
-		<a href="#%EF%B8%8F-cli-usage">CLI</a>&nbsp; •&nbsp;
-		<a href="#-api-usage">API</a>&nbsp; •&nbsp;
+		<a href="#%EF%B8%8F-usage">Usage</a>&nbsp; •&nbsp;
 		<a href="#%EF%B8%8F-workflow-steps">Workflow Steps</a>&nbsp; •&nbsp;
 		<a href="#-changelog-generation">Changelog Generation</a>
 	</b></p>
 	<br>
 </div>
 
-## ⚙️ Setup
+## 🕹️ Usage
 
 ```bash
-bun add -D relion # install as dev dependency
-bunx relion # or run directly
-```
-
-## 🕹️ CLI Usage
-
-```bash
-$ bun relion -h
+$ bunx relion -h
 
 Usage: relion [options]
 
 Options:
-  -f            Prepare release context
-  -b            Bump the version
-  -c            Create a release commit
-  -t            Create a release tag
-  -v <version>  Set the new version explicitly
-  -m <file>     Specify manifest file
-  -d            Run in dry run mode
-  -h            Show the help message
+  -b <files>    Files to bump version in (def: ['package.json']; package.json is always included if exists)
+  -v <version>  Release version (def: calculated from commits)
+  -t <prefix>   Tag prefix (def: 'v')
+  -d            Dry run (def: false)
 
 Examples:
-- `bun relion -bct` — bump version, create release commit and tag
-- `bun relion -f` — generate release context file
-- `bun relion -m Cargo.toml` — use Cargo.toml as manifest
-- `bun relion` — run all release steps
+- `bunx relion -b src/manifest.json`
+- `bunx relion -d -v 1.2.3`
 ```
 
-<details><summary>Example output of running <code>bun relion</code>:</summary>
+<details><summary>Example output of running <code>bunx relion</code>:</summary>
 
-```txt
+```
 Project: relion
 Repo: github.com/kh4f/relion
-Current tag: v0.36.1
-Current version: 0.36.1
-Parsed commits: 16
-New version: 0.37.0
-New tag: v0.37.0
-Commit message: 'chore(release): v0.37.0'
+Current tag: v0.42.1
+Current version: 0.42.1
+Parsed commits: 26
+New version: 0.43.0
+New tag: v0.43.0
 ------------------------------
 
+('' to continue / 's' to skip)
 About to write context to 'RELEASE.md'
-Press Enter to continue ('s' to skip):
-
-About to bump versions in files: package.json
-Press Enter to continue ('s' to skip):
-
-About to commit changes: 'git commit -m "chore(release): v0.37.0"'
-Press Enter to continue ('s' to skip):
-
-About to create a tag: 'git tag v0.37.0 -m "chore(release): v0.37.0"'
-Press Enter to continue ('s' to skip):
+About to bump version in files: package.json
+About to commit changes: 'git commit -m "chore(release): v0.43.0"'
+About to create a tag: 'git tag v0.43.0 -m "chore(release): v0.43.0"'
 ```
 </details>
 
-## 🧩 API Usage
-
-```ts
-import relion from 'relion';
-
-relion({
-	flow: ['context', 'bump', 'commit', 'tag'],
-	newVersion: '1.2.3',
-	bump: [
-		'package.json', // uses default bumper
-		// custom bumper (equivalent to the default bumper implementation)
-		{
-			file: 'manifest.json',
-			pattern: /("version": )".*"/,
-			replacement: '$1"{{newVersion}}"'
-		}
-	],
-	contextFile: 'RELEASE.md',
-	commitMessage: 'chore(release): {{tag}}',
-	tagPrefix: 'v',
-	dryRun: false,
-});
-```
-
-### Options
-
-- `manifest`: manifest file (default: auto-detects `package.json` or `Cargo.toml`)
-- `flow`: release workflow steps (`'context' | 'bump' | 'commit' | 'tag'`) (default: all steps)
-- `newVersion`: set the new version explicitly
-- `bump`: files or custom bumpers for version update (default: [`'package.json', 'Cargo.toml'`])
-- `contextFile`: path to release context output file (default: `'RELEASE.md'`)
-- `commitMessage`: release commit message template (default: `'chore(release): {{tag}}'`)
-- `tagPrefix`: release tag prefix (default: `'v'`)
-- `dryRun`: run in dry mode (no modifications)
-
-> For detailed option descriptions, see [src/types.d.ts](src/types.d.ts).
-
-### Configuration via `package.json`
-
-Relion can also be configured via `relion` field in `package.json`:
-
-```jsonc
-{
-  // ...
-  "relion": {
-    "commitMessage": "release(relion): {{tag}}",
-    "tagPrefix": "",
-    "bump": ["package.json",
-	  {
-	    "file": "manifest.json",
-	    "pattern": "/(\"version\": )\".*\"/",
-	    "replacement": "$1\"{{newVersion}}\""
-	  }
-	],
-    // ...
-  }
-}
-```
-
-> [!NOTE]
-> CLI flags override `package.json` configuration.
-
 ## ♻️ Workflow Steps
 
-- **Context**: generates a file with upcoming release metadata and commit log
+- **Context**: generates a `RELEASE.md` file with upcoming release metadata and commit log
 - **Bump**: updates version in specified files
 - **Commit**: creates a release commit
 - **Tag**: creates an annotated release tag
@@ -155,7 +71,7 @@ Relion can also be configured via `relion` field in `package.json`:
 tag: v0.33.0
 prevTag: v0.32.1
 date: Jan 10, 2026
-repoURL: https://github.com/kh4f/relion
+repoURL: github.com/kh4f/relion
 ---
 
 ## Commit Log
@@ -168,7 +84,6 @@ Previously, if commits contained both features and breaking changes, features wo
 
 - Implement `mergeConfigs` to support merging config profiles in `config-merger.ts`
 - Export `mergeConfigs` from `src/index.ts`
-------------------------------
 ```
 </details>
 
@@ -181,7 +96,7 @@ Recommended workflow:
 1. Set up GitHub Copilot instruction and prompt:
    - [.github/instructions/changelog-format.instructions.md](.github/instructions/changelog-format.instructions.md)
    - [.github/prompts/generate-changelog.prompt.md](.github/prompts/generate-changelog.prompt.md)
-2. Run the context step to generate RELEASE.md: `bun relion -f`
+2. Run Relion to generate `RELEASE.md` with the release context
 3. Review the release context, adjust as needed
 4. Run the prompt in VSCode Copilot chat: `/generate-changelog`
 5. Copilot produces a polished changelog entry based on the release context

package/dist/cli.js

@@ -1,19 +1,17 @@
 #!/usr/bin/env node
-import e from"./index.js";const t=process.argv.slice(2).join(` `);t.includes(`-h`)&&(console.log(`Usage: relion [options]
+import{execSync as e,spawnSync as t}from"node:child_process";import{existsSync as n,readFileSync as r,writeFileSync as i}from"node:fs";import{createInterface as a}from"node:readline";import o from"semver";const s=()=>{let t=e(`git config --get remote.origin.url`,{encoding:`utf8`}).trim(),n=/(github\.com.*?)(\.git)?$/.exec(t)?.[1]??``;return{url:n,name:n.split(`/`).at(-1)??``}},c=t=>e(`git log ${t?`${t}..`:``} --format="%h %B---" .`,{encoding:`utf8`}).trim().split(`---`).filter(Boolean).map(e=>/^(.+?) (.+)/s.exec(e.trim())).map(e=>({hash:e?.[1]??``,message:e?.[2].trim()??``})),l=(e,t)=>{let n=e.some(e=>e.message.includes(`BREAKING CHANGE`))?t.startsWith(`0.`)?`minor`:`major`:e.some(e=>/feat(\(.*?\))?:/.test(e.message))?`minor`:`patch`;return o.inc(t,n)??(()=>{throw Error(`Failed to increment version '${t}' with release type '${n}'`)})()},u=async e=>{let t=a({input:process.stdin,output:process.stdout});return await new Promise(n=>{t.question(e,e=>{t.close(),n(e.trim()!==`s`)})})},d=async(e,t,n,r,a)=>{if(!await u(`About to write context to 'RELEASE.md'`)||e.dryRun)return;let o=``,s=`---\ntag: ${r}\nprevTag: ${n}\ndate: ${new Date().toLocaleString(`en-US`,{month:`short`,day:`numeric`,year:`numeric`})}\nrepoURL: ${a}
+---
+`;o+=s+`
+`;let c=t.map(e=>`[${e.hash}] ${e.message}`).join(`\n${`-`.repeat(30)}\n`);o+=`## Commit Log\n\n\`\`\`\n${c}\n\`\`\``,i(`RELEASE.md`,o,`utf8`)},f=async e=>{let t=e.bump.filter(n);await u(`About to bump version in files: ${t.join(`, `)}`)&&t.forEach(t=>{let n=r(t,`utf8`).replace(/(\bversion\b.*?)\d[\w.+-]*/,`$1${e.newVersion}`);e.dryRun||i(t,n,`utf8`)})},p=async(t,n)=>{let r=`git commit -m "${n}"`;await u(`About to commit changes: '${r}'`)&&(t.dryRun||e(r,{stdio:`inherit`}))},m=async(t,n,r)=>{let i=`git tag ${n} -m "${r}"`;await u(`About to create a tag: '${i}'`)&&(t.dryRun||e(i,{stdio:`inherit`}))},h={bump:[`package.json`],newVersion:``,tagPrefix:`v`,dryRun:!1},g=async e=>{let n=s();console.log(`Project: ${n.name}`),console.log(`Repo: ${n.url}`);let r={...h,...e,bump:[...h.bump,...e.bump??[]]},i=t(`git`,[`describe`,`--match`,`${r.tagPrefix}[0-9]*.[0-9]*.[0-9]*`,`--abbrev=0`],{encoding:`utf8`}).stdout.trim();console.log(`Current tag: ${i}`);let a=/\d+\.\d+\.\d+.*/.exec(i)?.[0]??`0.0.0`;console.log(`Current version: ${a}`);let o=c(i);console.log(`Parsed commits: ${o.length}`),r.newVersion||=l(o,a),console.log(`New version: ${r.newVersion}`);let u=`${r.tagPrefix}${r.newVersion}`;console.log(`New tag: ${u}`);let g=`chore(release): ${u}`;console.log(`Commit message: '${g}'`),console.log(`-`.repeat(30)),console.log(`
+('' to continue / 's' to skip)`),await d(r,o,i,u,n.url),await f(r),await p(r,g),await m(r,u,g)},_=process.argv.slice(2).join(` `);_.includes(`-h`)&&(console.log(`Usage: relion [options]
 
 Options:
-  -f            Prepare release context
-  -b            Bump the version
-  -c            Create a release commit
-  -t            Create a release tag
-  -v <version>  Set the new version explicitly
-  -m <file>     Specify manifest file
-  -d            Run in dry run mode
-  -h            Show the help message
+  -b <files>    Files to bump version in (def: ['package.json']; package.json is always included if exists)
+  -v <version>  Release version (def: calculated from commits)
+  -t <prefix>   Tag prefix (def: 'v')
+  -d            Dry run (def: false)
 
 Examples:
-- \`pnpm relion -bct\` — bump version, create release commit and tag
-- \`pnpm relion -f\` — generate release context file
-- \`pnpm relion -m Cargo.toml\` — use Cargo.toml as manifest
-- \`pnpm relion\` — run all release steps
-`),process.exit(0));let n=[/-\w*f/.test(t)&&`context`,/-\w*b/.test(t)&&`bump`,/-\w*c/.test(t)&&`commit`,/-\w*t/.test(t)&&`tag`].filter(Boolean);n.length||(n=[`context`,`bump`,`commit`,`tag`]);const r=/-v (\S+)/.exec(t)?.[1],i=/-m (\S+)/.exec(t)?.[1],a=/-\w*d/.test(t);e({flow:n,...r&&{newVersion:r},...i&&{manifest:i},...a&&{dryRun:a}}).catch(e=>{console.error(e),process.exit(1)});export{};
+- \`bunx relion -b src/manifest.json\`
+- \`bunx relion -d -v 1.2.3\`
+`),process.exit(0));const v=/-b (.+?)( -|$)/.exec(_)?.[1].split(` `),y=/-v (\S+)/.exec(_)?.[1],b=/-t (\S+)/.exec(_)?.[1],x=/-\w*d/.test(_);g({...v&&{bump:v},...y&&{newVersion:y},...b&&{tagPrefix:b},...x&&{dryRun:x}}).catch(e=>{console.error(e),process.exit(1)});export{};

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "relion",
-	"version": "0.42.1",
-	"description": "🏷️ Modern Release Workflow Helper",
+	"version": "0.43.0",
+	"description": "🏷️ Release Workflow Helper",
 	"author": "kh4f <kh4f.dev@gmail.com>",
 	"license": "MIT",
 	"repository": "https://github.com/kh4f/relion",
@@ -10,9 +10,7 @@
 	"keywords": ["relion", "release", "release-automation", "release-workflow", "release-helper", "release-workflow-helper"],
 	"files": ["dist"],
 	"type": "module",
-	"main": "dist/index.js",
 	"bin": "dist/cli.js",
-	"types": "dist/index.d.ts",
 	"scripts": {
 		"build": "tsdown",
 		"build:watch": "tsdown --watch",
@@ -24,12 +22,12 @@
 	"devDependencies": {
 		"@eslint/js": "^10.0.1",
 		"@stylistic/eslint-plugin": "^5.10.0",
-		"@types/node": "^25.3.5",
+		"@types/node": "^25.4.0",
 		"@types/semver": "^7.7.1",
 		"eslint": "^10.0.3",
 		"jiti": "^2.6.1",
-		"tsdown": "^0.21.0",
+		"tsdown": "^0.21.1",
 		"typescript": "^5.9.3",
-		"typescript-eslint": "^8.56.1"
+		"typescript-eslint": "^8.57.0"
 	}
 }

package/dist/index.d.ts

@@ -1,62 +0,0 @@
-//#region src/types.d.ts
-interface Config {
-  /** Manifest file path. Auto-detects `package.json` or `Cargo.toml` if omitted. */
-  manifest?: string;
-  /**
-   * Release workflow steps to execute (e.g. bump, context, commit, tag)
-   * @default []
-   */
-  flow?: Step[];
-  /**
-   * Explicitly set the version for the upcoming release. If not provided, the version will be determined automatically based on conventional commit messages.
-   * @default ''
-   */
-  newVersion?: string;
-  /**
-   * Files or bumpers for version update. Each item is either:
-   * - a Bumper object specifying `file`, `pattern`, and `replacement`
-   * - a file name for which a default bumper exists (currently only 'package.json', 'Cargo.toml')
-   *
-   * If a file doesn't exist, it will be skipped silently.
-   *
-   * @default ['package.json', 'Cargo.toml']
-   */
-  bump?: (Bumper | string)[];
-  /**
-   * Path to the release context output file
-   * @default 'RELEASE.md'
-   */
-  contextFile?: string;
-  /**
-   * Release commit message template
-   * @default 'chore(release): {{tag}}'
-   */
-  commitMessage?: string;
-  /**
-   * Release tag prefix
-   * @default 'v'
-   */
-  tagPrefix?: string;
-  /**
-   * Run in dry mode without making any changes
-   * @default false
-   */
-  dryRun?: boolean;
-}
-type Step = 'bump' | 'context' | 'commit' | 'tag';
-interface Bumper {
-  /** Path or array of paths to the file(s) to bump version in */
-  file: string | string[];
-  /** Pattern to locate the version string (RegExp or a stringified RegExp) */
-  pattern: RegExp | string;
-  /** Replacement string for the version (use `{{newVersion}}` as a placeholder) */
-  replacement: string;
-}
-//#endregion
-//#region src/relion.d.ts
-declare function relion(userCfg?: Config): Promise<void>;
-//#endregion
-//#region src/index.d.ts
-declare const defineConfig: (config: Config) => Config;
-//#endregion
-export { relion as default, defineConfig };

package/dist/index.js

@@ -1,4 +0,0 @@
-import{existsSync as e,readFileSync as t,writeFileSync as n}from"node:fs";import{execSync as r,spawnSync as i}from"node:child_process";import{createInterface as a}from"node:readline";import o from"semver";const s=()=>{let e=r(`git config --get remote.origin.url`,{encoding:`utf8`}).trim(),t=/(github\.com.*?)(\.git)?$/.exec(e)?.[1]??``;return{url:t,name:t.split(`/`).at(-1)??``}},c=e=>{let n=t(e,`utf8`),r=/name.*"(.*?)"/.exec(n)?.[1];if(!r)throw Error(`Manifest is missing 'name' field`);let i=/repository.*"(.*?)"/.exec(n)?.[1];if(!i)throw Error(`Manifest is missing 'repository' field`);let a=e.endsWith(`.json`)?/relion.*({.*?})/s.exec(n)?.[1]:void 0;return{name:r,url:i,relion:a?JSON.parse(a):void 0}},l=e=>r(`git log ${e?`${e}..`:``} --format="%h %B---" .`,{encoding:`utf8`}).trim().split(`---`).filter(Boolean).map(e=>/^(.+?) (.+)/s.exec(e.trim())).map(e=>({hash:e?.[1]??``,message:e?.[2].trim()??``})),u=(e,t)=>{let n=e.some(e=>e.message.includes(`BREAKING CHANGE`))?t.startsWith(`0.`)?`minor`:`major`:e.some(e=>/feat(\(.*?\))?:/.test(e.message))?`minor`:`patch`;return o.inc(t,n)??(()=>{throw Error(`Failed to increment version '${t}' with release type '${n}'`)})()},d=async()=>{let e=a({input:process.stdin,output:process.stdout});return await new Promise(t=>{e.question(`Press Enter to continue ('s' to skip): `,n=>{e.close(),t(n.trim()!==`s`)})})},f=e=>{let t=/^\/(.+)\/(\w*)$/.exec(e);return t?new RegExp(t[1],t[2]):new RegExp(e)},p=[`context`,`bump`,`commit`,`tag`],m={file:[`package.json`,`Cargo.toml`],pattern:/(\bversion\b.*?)\d[\w.+-]*/,replacement:`$1{{newVersion}}`},h=[`package.json`,`Cargo.toml`],g={flow:p,newVersion:``,bump:h,contextFile:`RELEASE.md`,commitMessage:`chore(release): {{tag}}`,tagPrefix:`v`,dryRun:!1},_=async(e,t,r,i,a)=>{if(console.log(`\nAbout to write context to '${e.contextFile}'`),!await d()||e.dryRun)return;let o=``,s=`---\ntag: ${i}\nprevTag: ${r}\ndate: ${new Date().toLocaleString(`en-US`,{month:`short`,day:`numeric`,year:`numeric`})}\nrepoURL: ${a}
----
-`;o+=s+`
-`;let c=t.map(e=>`[${e.hash}] ${e.message}`).join(`\n${`-`.repeat(30)}\n`);o+=`## Commit Log\n\n\`\`\`\n${c}\n\`\`\``,n(e.contextFile,o,`utf8`)},v=async r=>{let i=r.bump.map(e=>typeof e==`string`?{...m,file:e}:e).filter(t=>[t.file].flat().every(t=>e(t)));console.log(`\nAbout to bump versions in files: ${i.map(e=>[e.file].flat()).flat().join(`, `)}`),await d()&&i.forEach(e=>{typeof e.pattern==`string`&&(e.pattern=f(e.pattern)),[e.file].flat().forEach(i=>{let a=t(i,`utf8`).replace(e.pattern,e.replacement.replace(`{{newVersion}}`,r.newVersion));r.dryRun||n(i,a,`utf8`)})})},y=async e=>{let t=`git commit -m "${e.commitMessage}"`;console.log(`\nAbout to commit changes: '${t}'`),await d()&&(e.dryRun||r(t,{stdio:`inherit`}))},b=async(e,t,n)=>{let i=`git tag ${n} -m "${e.commitMessage}"`;console.log(`\nAbout to create a tag: '${i}'`),await d()&&(e.dryRun||r(i,{stdio:`inherit`}))};async function x(t){let n;if(t?.manifest&&!e(t.manifest))throw Error(`Specified manifest file '${t.manifest}' does not exist`);let r=t?.manifest??h.find(e);r?(console.log(`Manifest file: ${r}`),n=c(r)):(console.log(`No manifest file found, using repository info`),n=s()),console.log(`Project: ${n.name}`),console.log(`Repo: ${n.url}`),t={...n.relion,...t};let a={...g,...t};!t.tagPrefix&&n.name.startsWith(`@`)&&(a.tagPrefix=`${n.name}@`);let o=i(`git`,[`describe`,`--match`,`${a.tagPrefix}[0-9]*.[0-9]*.[0-9]*`,`--abbrev=0`],{encoding:`utf8`}).stdout.trim();console.log(`Current tag: ${o}`);let d=/\d+\.\d+\.\d+.*/.exec(o)?.[0]??`0.0.0`;console.log(`Current version: ${d}`);let f=l(o);console.log(`Parsed commits: ${f.length}`),a.newVersion||=u(f,d),console.log(`New version: ${a.newVersion}`);let m=`${a.tagPrefix}${a.newVersion}`;console.log(`New tag: ${m}`),a.commitMessage=a.commitMessage.replace(`{{tag}}`,m),console.log(`Commit message: '${a.commitMessage}'`),console.log(`-`.repeat(30));for(let e of p.filter(e=>a.flow.includes(e)))await{context:()=>_(a,f,o,m,n.url),bump:()=>v(a),commit:()=>y(a),tag:()=>b(a,o,m)}[e]()}const S=e=>e;export{x as default,S as defineConfig};