@xxkeefer/mrkl 0.2.4 → 0.2.6

package/README.md

@@ -28,7 +28,7 @@ Most task trackers live outside your codebase. mrkl keeps tasks as markdown file
 ## Install
 
 ```sh
-npm install -g @xxkeefer/mrkl
+pnpm add -g @xxkeefer/mrkl
 ```
 
 Or use without installing:
@@ -186,6 +186,30 @@ your-project/
 
 Commit `.config/mrkl/` and `.tasks/` to version control. They're designed to be tracked alongside your code.
 
+## Team Workflow
+
+When using mrkl with **git worktrees** or **protected branches**, task IDs can conflict if multiple branches create tasks concurrently. The fix is a simple convention: **separate planning from execution.**
+
+1. **Plan** — Create tasks on a `planning/` branch, merge to main via PR
+2. **Execute** — Branch feature work from main (which has all tasks)
+3. **Ad-hoc** — Mid-sprint tasks follow the same pattern at smaller scale
+
+```sh
+# Sprint planning
+git checkout -b planning/sprint-3 main
+mrkl create feat "user authentication"
+mrkl create fix "login redirect loop"
+# commit, PR, merge to main
+
+# Feature work (branch from main after planning merges)
+git checkout -b feature/MRKL-019_user-auth main
+# ... do the work ...
+mrkl done MRKL-019
+# commit, PR, merge to main
+```
+
+The counter only increments on planning branches — one at a time — so IDs never conflict. See **[docs/workflow.md](docs/workflow.md)** for the full guide with examples and edge cases.
+
 ## Configuration
 
 Configuration lives in `.config/mrkl/mrkl.toml` (or `mrkl.toml` at the project root):
@@ -205,27 +229,21 @@ tasks_dir = ".tasks"
 ```sh
 git clone https://github.com/xxKeefer/mrkl.git
 cd mrkl
-npm install
+pnpm install
 
 # Run tests
-npm test
+pnpm test
 
 # Run CLI in development
-npx tsx src/cli.ts list
+pnpm tsx src/cli.ts list
 
 # Build
-npm run build
+pnpm build
 ```
 
 ## Contributing
 
-Contributions are welcome. Please open an issue first to discuss what you'd like to change.
-
-1. Fork the repo
-2. Create your branch (`git checkout -b feat/my-feature`)
-3. Commit your changes using [conventional commits](https://www.conventionalcommits.org/)
-4. Push to your branch (`git push origin feat/my-feature`)
-5. Open a Pull Request
+Contributions are welcome! See **[CONTRIBUTING.md](CONTRIBUTING.md)** for branch protection rules, merge strategy, and development setup.
 
 ## License
 

package/dist/cli.mjs

@@ -117,6 +117,11 @@ function parse(content, filename) {
   };
 }
 
+function normalizeTitle(raw) {
+  const result = raw.trim().toLowerCase().replace(/[/\\]/g, "-").replace(/[<>:"|?*\x00-\x1f]/g, "").replace(/-{2,}/g, "-").replace(/ {2,}/g, " ").replace(/^-+|-+$/g, "");
+  if (!result) throw new Error("Title is empty after normalisation");
+  return result;
+}
 function createTask(opts) {
   const config = loadConfig(opts.dir);
   const num = nextId(opts.dir);
@@ -127,7 +132,7 @@ function createTask(opts) {
     type: opts.type,
     status: "todo",
     created: today,
-    title: opts.title,
+    title: normalizeTitle(opts.title),
     description: opts.description ?? "",
     acceptance_criteria: opts.acceptance_criteria ?? []
   };
@@ -224,7 +229,7 @@ const createCommand = defineCommand({
         type: args.type,
         title: args.title,
         description: args.desc,
-        acceptance_criteria: args.ac ? [args.ac] : void 0
+        acceptance_criteria: args.ac ? Array.isArray(args.ac) ? args.ac : [args.ac] : void 0
       });
       consola.success(`Created ${task.id}: ${task.title}`);
     } catch (err) {
@@ -304,8 +309,11 @@ const main = defineCommand({
   subCommands: {
     init: initCommand,
     create: createCommand,
+    c: createCommand,
     list: listCommand,
     done: doneCommand
   }
 });
 runMain(main);
+
+export { main };

package/package.json

@@ -1,17 +1,11 @@
 {
   "name": "@xxkeefer/mrkl",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "type": "module",
   "description": "Lightweight CLI tool for structured markdown task tracking",
   "bin": {
     "mrkl": "./dist/cli.mjs"
   },
-  "scripts": {
-    "build": "unbuild",
-    "dev": "node --import tsx src/cli.ts",
-    "test": "vitest run",
-    "release": "./scripts/release.sh"
-  },
   "keywords": [
     "cli",
     "task",
@@ -38,8 +32,17 @@
   },
   "devDependencies": {
     "@types/node": "^25.3.3",
+    "changelogen": "^0.6.2",
     "typescript": "^5.7.0",
     "unbuild": "^3.3.1",
     "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "node --import tsx src/cli.ts",
+    "test": "vitest run",
+    "release": "./scripts/release.sh",
+    "changelog": "changelogen",
+    "changelog:preview": "changelogen --no-output"
   }
-}
+}