@regardio/dev 1.0.1 → 1.4.0

package/README.md

@@ -35,7 +35,7 @@ Exceptions are allowed but must be intentional and documented. The goal is code
 
 ## What's inside
 
-- **CLI bins**: exec-clean, exec-husky, exec-p, exec-s, exec-ts, exec-tsc, lint-biome, lint-commit, lint-md
+- **CLI bins**: exec-clean, exec-husky, exec-p, exec-s, exec-ts, exec-tsc, flow-release, lint-biome, lint-commit, lint-md
 - **Config presets**: Biome, Commitlint, Markdownlint, TypeScript (base/react)
 - **Testing configs**: Vitest (node/react), Playwright base config, Testing Library setup
 - **Dev dependencies**: All commonly needed testing and linting packages bundled
@@ -316,31 +316,68 @@ When you add `@regardio/dev` as a dev dependency, you get access to:
 
 ## Releasing
 
-This package uses [Changesets](https://github.com/changesets/changesets) for versioning and npm publishing.
+This package uses [Changesets](https://github.com/changesets/changesets) for versioning and npm publishing, with a streamlined `flow-release` command that automates the entire process.
 
-### Adding a Changeset
+### Quick Release (Recommended)
 
-When making changes that should be released:
+The `flow-release` command handles everything in one step:
 
 ```bash
-pnpm changeset
+# From the package directory:
+pnpm release minor "Add new vitest configs"
+
+# Or use the bin directly after build:
+flow-release patch "Fix typo in config"
+flow-release minor "Add new feature"
+flow-release major "Breaking API change"
 ```
 
-### Automated Release (GitHub Action)
+This command:
+
+1. Creates a changeset file with the specified bump type and message
+2. Runs `changeset version` to update package.json and CHANGELOG
+3. Updates the lockfile (`pnpm install --ignore-workspace`)
+4. Commits all changes with `chore(release): vX.Y.Z`
+5. Pushes to the current branch
 
-When changesets are merged to `main`:
+The GitHub Action then publishes to npm automatically.
 
-1. A "Version Packages" PR is created with updated version and CHANGELOG
-2. Merging that PR publishes to npm
+### Manual Release (Step by Step)
 
-### Manual Release
+If you prefer more control:
 
 ```bash
-pnpm version    # Update version and CHANGELOG
-pnpm build      # Build the package
-pnpm release    # Publish to npm
+pnpm changeset              # Interactive: create changeset file
+git add . && git commit     # Commit the changeset
+git push                    # Push to trigger GitHub Action
+# GitHub Action creates "Version Packages" PR
+# Merge that PR → publishes to npm
 ```
 
+### Reusing in Other Packages
+
+The `flow-release` bin is available to any package that depends on `@regardio/dev`:
+
+```json
+{
+  "scripts": {
+    "release": "flow-release"
+  }
+}
+```
+
+Then run:
+
+```bash
+pnpm release minor "Your release message"
+```
+
+**Requirements for other packages:**
+
+1. A `.changeset/config.json` file (copy from this package and update `repo`)
+2. A `.github/workflows/release.yml` (copy from this package)
+3. GitHub repo configured with NPM_TOKEN secret and Actions permissions
+
 ### GitHub Repository Setup
 
 Before the release action works, configure these in **GitHub repo settings**:

package/dist/bin/flow-release.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=flow-release.d.ts.map

package/dist/bin/flow-release.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flow-release.d.ts","sourceRoot":"","sources":["../../src/bin/flow-release.ts"],"names":[],"mappings":""}

package/dist/bin/flow-release.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+import { execSync } from 'node:child_process';
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+const args = process.argv.slice(2);
+const bumpType = args[0];
+const message = args.slice(1).join(' ') || 'Release update';
+if (!bumpType || !['patch', 'minor', 'major'].includes(bumpType)) {
+    console.error('Usage: flow-release <patch|minor|major> [message]');
+    console.error('Example: flow-release minor "Add new vitest configs"');
+    process.exit(1);
+}
+const run = (cmd) => {
+    console.log(`$ ${cmd}`);
+    execSync(cmd, { stdio: 'inherit' });
+};
+const runQuiet = (cmd) => {
+    return execSync(cmd, { encoding: 'utf-8' }).trim();
+};
+try {
+    const status = runQuiet('git status --porcelain');
+    if (status) {
+        console.log('Working directory has uncommitted changes. Staging all changes...');
+    }
+}
+catch {
+    console.error('Not in a git repository');
+    process.exit(1);
+}
+const changesetDir = join(process.cwd(), '.changeset');
+const changesetId = `release-${Date.now()}`;
+const changesetFile = join(changesetDir, `${changesetId}.md`);
+const changesetContent = `---
+"@regardio/dev": ${bumpType}
+---
+
+${message}
+`;
+mkdirSync(changesetDir, { recursive: true });
+writeFileSync(changesetFile, changesetContent);
+console.log(`Created changeset: .changeset/${changesetId}.md`);
+run('pnpm changeset version');
+console.log('Updating lockfile...');
+run('pnpm install --ignore-workspace');
+run('git add -A');
+const packageJsonPath = join(process.cwd(), 'package.json');
+const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+const { version } = packageJson;
+run(`git commit -m "chore(release): v${version}"`);
+const branch = runQuiet('git branch --show-current');
+run(`git push origin ${branch}`);
+console.log(`\n✅ Released v${version}`);
+console.log('The GitHub Action will now publish to npm.');

package/package.json

@@ -2,21 +2,21 @@
   "$schema": "https://www.schemastore.org/package.json",
   "author": "Bernd Matzner <bernd.matzner@regard.io>",
   "bin": {
-    "exec-clean": "./dist/bin/exec-clean.js",
-    "exec-husky": "./dist/bin/exec-husky.js",
-    "exec-p": "./dist/bin/exec-p.js",
-    "exec-s": "./dist/bin/exec-s.js",
-    "exec-ts": "./dist/bin/exec-ts.js",
-    "exec-tsc": "./dist/bin/exec-tsc.js",
-    "lint-biome": "./dist/bin/lint-biome.js",
-    "lint-commit": "./dist/bin/lint-commit.js",
-    "lint-md": "./dist/bin/lint-md.js"
+    "exec-clean": "dist/bin/exec-clean.js",
+    "exec-husky": "dist/bin/exec-husky.js",
+    "exec-p": "dist/bin/exec-p.js",
+    "exec-s": "dist/bin/exec-s.js",
+    "exec-ts": "dist/bin/exec-ts.js",
+    "exec-tsc": "dist/bin/exec-tsc.js",
+    "flow-release": "dist/bin/flow-release.js",
+    "lint-biome": "dist/bin/lint-biome.js",
+    "lint-commit": "dist/bin/lint-commit.js",
+    "lint-md": "dist/bin/lint-md.js"
   },
   "bugs": {
     "url": "https://github.com/regardio/dev/issues"
   },
-  "description": "Regardio developer tooling for testing, linting, and build workflows",
-  "devDependencies": {
+  "dependencies": {
     "@biomejs/biome": "2.3.10",
     "@changesets/changelog-github": "0.5.2",
     "@changesets/cli": "2.29.8",
@@ -29,7 +29,7 @@
     "@types/node": "25.0.3",
     "@vitest/ui": "4.0.16",
     "husky": "9.1.7",
-    "jsdom": "27.3.0",
+    "jsdom": "27.4.0",
     "markdownlint-cli2": "0.20.0",
     "npm-run-all": "4.1.5",
     "rimraf": "6.1.2",
@@ -38,14 +38,11 @@
     "vite": "7.3.0",
     "vitest": "4.0.16"
   },
+  "description": "Regardio developer tooling for testing, linting, and build workflows",
   "engines": {
     "node": ">=18"
   },
   "exports": {
-    ".": {
-      "default": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    },
     "./biome": "./src/biome/preset.json",
     "./commitlint": "./src/commitlint/commitlint.cjs",
     "./markdownlint": "./src/markdownlint/markdownlint.json",
@@ -75,13 +72,18 @@
   ],
   "homepage": "https://github.com/regardio/dev/blob/main/README.md",
   "keywords": [
+    "biome",
+    "changesets",
+    "commitlint",
     "dev",
-    "tooling",
-    "testing",
+    "husky",
     "linting",
-    "biome",
-    "vitest",
-    "playwright"
+    "markdownlint",
+    "playwright",
+    "testing",
+    "tooling",
+    "typescript",
+    "vitest"
   ],
   "license": "MIT",
   "name": "@regardio/dev",
@@ -92,7 +94,7 @@
   "repository": {
     "directory": "packages/dev",
     "type": "git",
-    "url": "https://github.com/regardio/dev.git"
+    "url": "git+https://github.com/regardio/dev.git"
   },
   "scripts": {
     "build": "pnpm exec tsc -p tsconfig.build.json",
@@ -104,12 +106,12 @@
     "lint:biome": "biome check .",
     "lint:md": "markdownlint-cli2 \"**/*.md\" \"**/*.mdx\" \"!**/node_modules/**\" \"!**/dist/**\"",
     "prepare": "pnpm run build && husky",
-    "release": "pnpm changeset publish",
+    "release": "pnpm exec tsx src/bin/flow-release.ts",
     "test": "run-p test:*",
     "test:unit": "vitest run",
     "version": "pnpm changeset version"
   },
   "sideEffects": false,
   "type": "module",
-  "version": "1.0.1"
+  "version": "1.4.0"
 }

package/src/bin/flow-release.ts

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+/**
+ * flow-release: Automate the release flow for @regardio/dev.
+ *
+ * Usage: flow-release <patch|minor|major> [message]
+ *
+ * This script:
+ * 1. Creates a changeset file with the specified bump type
+ * 2. Runs `changeset version` to apply the version bump
+ * 3. Updates the lockfile (pnpm install --ignore-workspace)
+ * 4. Commits all changes
+ * 5. Pushes to the current branch
+ *
+ * The GitHub Action will then publish to npm automatically.
+ */
+import { execSync } from 'node:child_process';
+import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+const args = process.argv.slice(2);
+const bumpType = args[0];
+const message = args.slice(1).join(' ') || 'Release update';
+
+if (!bumpType || !['patch', 'minor', 'major'].includes(bumpType)) {
+  console.error('Usage: flow-release <patch|minor|major> [message]');
+  console.error('Example: flow-release minor "Add new vitest configs"');
+  process.exit(1);
+}
+
+const run = (cmd: string) => {
+  console.log(`$ ${cmd}`);
+  execSync(cmd, { stdio: 'inherit' });
+};
+
+const runQuiet = (cmd: string): string => {
+  return execSync(cmd, { encoding: 'utf-8' }).trim();
+};
+
+// Ensure we're in a clean git state
+try {
+  const status = runQuiet('git status --porcelain');
+  if (status) {
+    console.log('Working directory has uncommitted changes. Staging all changes...');
+  }
+} catch {
+  console.error('Not in a git repository');
+  process.exit(1);
+}
+
+// Generate a unique changeset filename
+const changesetDir = join(process.cwd(), '.changeset');
+const changesetId = `release-${Date.now()}`;
+const changesetFile = join(changesetDir, `${changesetId}.md`);
+
+// Create the changeset file
+const changesetContent = `---
+"@regardio/dev": ${bumpType}
+---
+
+${message}
+`;
+
+mkdirSync(changesetDir, { recursive: true });
+writeFileSync(changesetFile, changesetContent);
+console.log(`Created changeset: .changeset/${changesetId}.md`);
+
+// Run changeset version to apply the bump
+run('pnpm changeset version');
+
+// Update lockfile to ensure it matches package.json
+// Use --ignore-workspace to update this package's lockfile independently
+console.log('Updating lockfile...');
+run('pnpm install --ignore-workspace');
+
+// Stage all changes
+run('git add -A');
+
+// Get the new version
+const packageJsonPath = join(process.cwd(), 'package.json');
+const packageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8')) as { version: string };
+const { version } = packageJson;
+
+// Commit
+run(`git commit -m "chore(release): v${version}"`);
+
+// Push
+const branch = runQuiet('git branch --show-current');
+run(`git push origin ${branch}`);
+
+console.log(`\n✅ Released v${version}`);
+console.log('The GitHub Action will now publish to npm.');

package/dist/bin/flow-branch.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=flow-branch.d.ts.map

package/dist/bin/flow-branch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"flow-branch.d.ts","sourceRoot":"","sources":["../../src/bin/flow-branch.ts"],"names":[],"mappings":""}

package/dist/bin/flow-branch.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-import { spawnSync } from 'node:child_process';
-const [expectedBranch, deploymentLabel] = process.argv.slice(2);
-if (!expectedBranch || !deploymentLabel) {
-    console.error('Usage: flow-branch <expected-branch> <deployment-label>');
-    process.exit(1);
-}
-const envBranch = process.env.GITHUB_REF_NAME || process.env.GITHUB_HEAD_REF || process.env.BRANCH_NAME || '';
-let currentBranch = envBranch;
-if (!currentBranch) {
-    const res = spawnSync('git', ['rev-parse', '--abbrev-ref', 'HEAD'], {
-        encoding: 'utf8',
-        stdio: ['ignore', 'pipe', 'pipe'],
-    });
-    if (res.status !== 0) {
-        console.error('Failed to determine the current Git branch.');
-        if (res.stderr)
-            console.error(res.stderr.trim());
-        process.exit(1);
-    }
-    currentBranch = (res.stdout || '').toString().trim();
-}
-if (currentBranch !== expectedBranch) {
-    console.error(`Refusing to deploy ${deploymentLabel}. Expected branch "${expectedBranch}", but current branch is "${currentBranch}".`);
-    process.exit(1);
-}
-console.log(`Branch check passed. Proceeding with ${deploymentLabel} deployment from "${expectedBranch}".`);

package/dist/bin/flow-version.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=flow-version.d.ts.map

package/dist/bin/flow-version.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"flow-version.d.ts","sourceRoot":"","sources":["../../src/bin/flow-version.ts"],"names":[],"mappings":""}

package/dist/bin/flow-version.js

@@ -1,83 +0,0 @@
-#!/usr/bin/env node
-import { spawnSync } from 'node:child_process';
-import fs from 'node:fs';
-import path from 'node:path';
-function fail(message) {
-    console.error(message);
-    process.exit(1);
-}
-function run(cmd, args, options = {}) {
-    const result = spawnSync(cmd, args, { stdio: 'inherit', ...options });
-    if (result.status !== 0) {
-        fail(`Command failed: ${cmd} ${args.join(' ')}`);
-    }
-}
-const type = process.argv[2];
-if (!type || !['patch', 'minor', 'major'].includes(type)) {
-    fail('Usage: flow-version <patch|minor|major>');
-}
-const pkgPath = path.resolve(process.cwd(), 'package.json');
-if (!fs.existsSync(pkgPath)) {
-    fail('Error: package.json not found in current directory');
-}
-const pkgRaw = fs.readFileSync(pkgPath, 'utf8');
-let pkg;
-try {
-    pkg = JSON.parse(pkgRaw);
-}
-catch (_e) {
-    fail('Error: Failed to parse package.json');
-}
-const current = pkg.version || '0.0.0';
-console.log(`Current version: ${current}`);
-const [majorStr, minorStr, patchStr] = String(current).split('.');
-let major = Number(majorStr);
-let minor = Number(minorStr);
-let patch = Number(patchStr);
-switch (type) {
-    case 'major':
-        major += 1;
-        minor = 0;
-        patch = 0;
-        break;
-    case 'minor':
-        minor += 1;
-        patch = 0;
-        break;
-    case 'patch':
-        patch += 1;
-        break;
-}
-const newVersion = `${major}.${minor}.${patch}`;
-console.log(`New version: ${newVersion}`);
-pkg.version = newVersion;
-fs.writeFileSync(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`, 'utf8');
-run('pnpm', ['lint']);
-const isMajor = type === 'major';
-const isPatch = type === 'patch';
-const conventionalType = isPatch ? 'fix' : 'feat';
-const scope = 'release';
-const subject = `v${newVersion}`;
-const breakingBang = isMajor ? '!' : '';
-const commitMessage = `${conventionalType}(${scope})${breakingBang}: ${subject}` +
-    (isMajor ? `\n\nBREAKING CHANGE: ${subject}` : '');
-const branchRes = spawnSync('git', ['rev-parse', '--abbrev-ref', 'HEAD'], {
-    encoding: 'utf8',
-});
-if (branchRes.status !== 0)
-    fail('Error: Not a git repository or git not available');
-const currentBranch = branchRes.stdout.trim();
-if (currentBranch !== 'develop') {
-    fail(`Error: You must run releases from 'develop' (current: ${currentBranch})`);
-}
-run('git', ['add', 'package.json']);
-run('git', ['commit', '-m', commitMessage]);
-run('git', ['checkout', 'main']);
-run('git', ['merge', 'develop', '--no-ff', '-m', commitMessage]);
-run('git', ['tag', '-a', `v${newVersion}`, '-m', commitMessage]);
-run('git', ['push', 'origin', 'main']);
-run('git', ['push', 'origin', '--tags']);
-run('git', ['checkout', 'develop']);
-run('git', ['merge', 'main', '--ff-only']);
-run('git', ['push', 'origin', 'develop']);
-console.log(`Released version ${newVersion} successfully!`);