@afoures/auto-release 0.4.1 → 0.5.0

package/README.md

@@ -43,26 +43,26 @@ bunx add @afoures/auto-release
 Create `auto-release.config.ts`:
 
 ```typescript
-import { define_config } from 'auto-release'
-import { semver } from 'auto-release/versioning'
-import { github } from 'auto-release/providers'
-import { node } from 'auto-release/components'
+import { define_config } from "@afoures/auto-release";
+import { semver } from "@afoures/auto-release/versioning";
+import { github } from "@afoures/auto-release/providers";
+import { node } from "@afoures/auto-release/components";
 
 export default define_config({
   projects: {
-    'my-app': {
-      components: [node('packages/my-app')],
+    "my-app": {
+      components: [node("packages/my-app")],
       versioning: semver(),
-      changelog: 'CHANGELOG.md',
+      changelog: "CHANGELOG.md",
     },
   },
   git: {
     platform: github({
       token: process.env.GITHUB_TOKEN!,
-      owner: 'your-org',
-      repo: 'your-repo',
+      owner: "your-org",
+      repo: "your-repo",
     }),
-    target_branch: 'main',
+    target_branch: "main",
   },
 })
 ```

package/dist/lib/change-file.d.mts

@@ -3,12 +3,16 @@ declare class ChangeFile<kind extends string> {
   #private;
   constructor(props: {
     kind: kind;
+    index?: number;
     slug?: string;
     summary: string;
+    birthtime?: Date;
   });
   get kind(): kind;
+  get index(): number;
   get summary(): string;
   get filename(): string;
+  get birthtime(): Date;
 }
 //#endregion
 export { ChangeFile };

package/dist/lib/change-file.mjs

@@ -1,30 +1,40 @@
-import { list_files, read_file, write_file } from "./utils/fs.mjs";
+import { get_file_stats, list_files, read_file, write_file } from "./utils/fs.mjs";
 import { basename, join } from "node:path";
 import { regex } from "arkregex";
 import { humanId } from "human-id";
 
 //#region src/lib/change-file.ts
-const CHANGE_FILENAME_REGEX = regex("^(?<kind>[a-z0-9-]+)\\.(?<slug>[a-z0-9-]+)\\.md$");
+const CHANGE_FILENAME_REGEX = regex("^(?<kind>[a-z0-9-]+)\\.(?:(?<index>\\d+)-)?(?<slug>[a-z0-9-]+)\\.md$");
 var ChangeFile = class {
 	#kind;
+	#index;
 	#slug;
 	#summary;
+	#birthtime;
 	constructor(props) {
 		this.#kind = props.kind;
+		this.#index = props.index ?? 1;
 		this.#slug = props.slug ?? humanId({
 			separator: "-",
 			capitalize: false
 		});
 		this.#summary = props.summary;
+		this.#birthtime = props.birthtime ?? /* @__PURE__ */ new Date(0);
 	}
 	get kind() {
 		return this.#kind;
 	}
+	get index() {
+		return this.#index;
+	}
 	get summary() {
 		return this.#summary;
 	}
 	get filename() {
-		return `${this.#kind}.${this.#slug}.md`;
+		return `${this.#kind}.${this.#index}-${this.#slug}.md`;
+	}
+	get birthtime() {
+		return this.#birthtime;
 	}
 };
 async function save_change_file(change_file, to) {
@@ -36,21 +46,25 @@ async function save_change_file(change_file, to) {
 async function parse_change_file(path) {
 	const filename = basename(path);
 	const match = CHANGE_FILENAME_REGEX.exec(filename);
-	if (!match) return /* @__PURE__ */ new Error(`Invalid change filename format: ${path} (expected: <kind>.<slug>.md)`);
+	if (!match) return /* @__PURE__ */ new Error(`Invalid change filename format: ${path} (expected: <kind>.<index>-<slug>.md)`);
 	let file_content = await read_file(path);
 	file_content = file_content?.trim() ?? null;
 	if (file_content === null) return /* @__PURE__ */ new Error(`Change file is missing: ${path}`);
 	if (!file_content) return /* @__PURE__ */ new Error("Change file is empty");
 	const [title, ...rest] = file_content.split("\n");
 	const text = [`- ${title}`, ...rest.map((line) => `  ${line}`)].join("\n");
+	const index = match.groups.index ? parseInt(match.groups.index, 10) : 1;
+	const birthtime = (await get_file_stats(path))?.birthtime ?? /* @__PURE__ */ new Date(0);
 	return new ChangeFile({
+		index,
 		slug: match.groups.slug,
 		kind: match.groups.kind,
-		summary: text
+		summary: text,
+		birthtime
 	});
 }
 async function find_change_files(folder, { allowed_kinds }) {
-	const files = await list_files(folder, { sort: "creation" });
+	const files = await list_files(folder, { sort: "name" });
 	const list = [];
 	const warnings = [];
 	for (const filename of files) {
@@ -67,6 +81,11 @@ async function find_change_files(folder, { allowed_kinds }) {
 		}
 		list.push(change_file_or_error);
 	}
+	list.sort((a, b) => {
+		if (a.kind !== b.kind) return a.kind.localeCompare(b.kind);
+		if (a.index !== b.index) return a.index - b.index;
+		return a.birthtime.getTime() - b.birthtime.getTime();
+	});
 	return {
 		list,
 		warnings

package/dist/lib/commands/record-change.mjs

@@ -1,7 +1,7 @@
 import { create_command } from "../cli.mjs";
 import { exists, read_file } from "../utils/fs.mjs";
 import { find_nearest_config } from "../config.mjs";
-import { ChangeFile, save_change_file } from "../change-file.mjs";
+import { ChangeFile, find_change_files, save_change_file } from "../change-file.mjs";
 import { exec as exec$1 } from "../utils/exec.mjs";
 import { cancel, intro, isCancel, log, select, text } from "@clack/prompts";
 import { join, relative } from "node:path";
@@ -139,6 +139,8 @@ const record_change = create_command({
 			status: "error",
 			error: `Invalid change type "${change_type}". Valid types for ${project_name}: ${valid_types.join(", ")}`
 		};
+		const project_change_dir = join(config.changes_dir, project_name);
+		const next_index = (await find_change_files(project_change_dir, { allowed_kinds: valid_types })).list.filter((f) => f.kind === change_type).length + 1;
 		const initial_slug = humanId({
 			separator: "-",
 			capitalize: false
@@ -151,11 +153,12 @@ const record_change = create_command({
 		const slug = generate_slug(description_input) || initial_slug;
 		const change_file = new ChangeFile({
 			kind: change_type,
+			index: next_index,
 			slug,
 			summary: ""
 		});
 		try {
-			const file_path = await save_change_file(change_file, join(config.changes_dir, project_name));
+			const file_path = await save_change_file(change_file, project_change_dir);
 			const editor = await get_editor(config.changes_dir);
 			if (!editor) return {
 				status: "error",

package/dist/lib/formatter.mjs

@@ -110,7 +110,7 @@ function default_formatter({ allowed_changes, display_map }) {
 		generate_release_notes({ project, version }) {
 			const hash = version.replaceAll(".", "");
 			const file = `${project.changelog}#${hash}`;
-			return `[See the changelog for ${project.name}@${version} release notes](${file})`;
+			return `See the changelog for release notes: [${project.name}@${version}](${file})`;
 		},
 		generate_pr_body({ project, current_version, next_version, changes }) {
 			const lines = [];

package/dist/lib/utils/fs.mjs

@@ -69,6 +69,13 @@ async function list_files(dir, options) {
 		return [];
 	}
 }
+async function get_file_stats(path) {
+	try {
+		return await stat(path);
+	} catch {
+		return null;
+	}
+}
 
 //#endregion
-export { delete_all_files_from_folder, exists, list_files, read_file, write_file };
+export { delete_all_files_from_folder, exists, get_file_stats, list_files, read_file, write_file };

package/docs/change-file-anatomy.md

@@ -3,13 +3,13 @@
 Change files are stored in `.changes/<project-name>/` with format:
 
 ```
-<type>.<slug>.md
+<type>.<index>-<slug>.md
 ```
 
 Examples:
 
-- `.changes/my-app/major.add-authentication.md`
-- `.changes/my-app/patch.fix-login-bug.md`
+- `.changes/my-app/major.1-add-authentication.md`
+- `.changes/my-app/patch.1-fix-login-bug.md`
 
 The change files folder can be customized.
 

package/docs/configuration.md

@@ -6,18 +6,18 @@ The `projects` object defines each releasable unit:
 
 ```typescript
 projects: {
-  'my-app': {
+  "my-app": {
     // Components: where versions are read/written
     components: [
-      node('packages/my-app'),
-      node('packages/shared'),
+      node("packages/my-app"),
+      node("packages/shared"),
     ],
 
     // Versioning strategy
     versioning: semver(),
 
     // Changelog file path
-    changelog: 'apps/my-app/CHANGELOG.md',
+    changelog: "apps/my-app/CHANGELOG.md",
   },
 }
 ```
@@ -104,7 +104,7 @@ Useful for grouped projects where some projects may not have changes in every re
 ## Versioning Strategies
 
 ```typescript
-import { semver, calver, markver } from 'auto-release/versioning'
+import { semver, calver, markver } from "@afoures/auto-release/versioning"
 
 // Semantic versioning: 1.2.3
 versioning: semver()  // Change types: major, minor, patch
@@ -121,15 +121,15 @@ versioning: markver()  // Change types: marketing, feature, fix
 ### GitHub
 
 ```typescript
-import { github } from 'auto-release/providers'
+import { github } from "@afoures/auto-release/providers"
 
 git: {
   platform: github({
     token: process.env.GITHUB_TOKEN!,
-    owner: 'your-org',
-    repo: 'your-repo',
+    owner: "your-org",
+    repo: "your-repo",
   }),
-  target_branch: 'main',
+  target_branch: "main",
   tag_generator: ({ project, version }) => `${project.name}-${version}`,
 }
 ```
@@ -137,14 +137,14 @@ git: {
 ### GitLab
 
 ```typescript
-import { gitlab } from 'auto-release/providers'
+import { gitlab } from "@afoures/auto-release/providers"
 
 git: {
   platform: gitlab({
     token: process.env.GITLAB_TOKEN!,
-    project_id: 'your-project-id',
+    project_id: "your-project-id",
   }),
-  target_branch: 'main',
+  target_branch: "main",
 }
 ```
 
@@ -184,12 +184,12 @@ Components define version sources:
 - **`php(path)`**: any PHP project with composer.json
 
 ```typescript
-import { node, expo, php } from 'auto-release/components'
+import { node, expo, php } from "@afoures/auto-release/components"
 
 components: [
-  node('packages/web'),
-  bun('packages/bff'),
-  expo('apps/mobile'),
-  php('packages/api'),
+  node("packages/web"),
+  bun("packages/bff"),
+  expo("apps/mobile"),
+  php("packages/api"),
 ]
 ```

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@afoures/auto-release",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "A file based release management tool for monorepos",
+  "keywords": [],
   "homepage": "https://github.com/afoures/auto-release#readme",
   "bugs": {
     "url": "https://github.com/afoures/auto-release/issues"
@@ -21,7 +22,6 @@
     "package.json",
     "README.md"
   ],
-  "keywords": [],
   "type": "module",
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",