@programinglive/commiter 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.0.5](https://github.com/programinglive/commiter/compare/v1.0.4...v1.0.5) (2025-10-19)
+
+
+### 🐛 Bug Fixes
+
+* allow release commits with emoji ([26c4afa](https://github.com/programinglive/commiter/commit/26c4afa26fc7c11c91ac576dcba197cba5d3d98a))
+
+### [1.0.4](https://github.com/programinglive/commiter/compare/v1.0.3...v1.0.4) (2025-10-19)
+
+
+### 🐛 Bug Fixes
+
+* ensure safe test default for initial release ([27d2ee3](https://github.com/programinglive/commiter/commit/27d2ee35d1e558ef459a61e41627305997621392))
+
 ### [1.0.3](https://github.com/programinglive/commiter/compare/v1.0.2...v1.0.3) (2025-10-19)
 
 ### [1.0.2](https://github.com/programinglive/commiter/compare/v1.0.1...v1.0.2) (2025-10-19)

package/README.md

@@ -150,6 +150,8 @@ type(scope): subject
 
 Valid types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
 
+Release commits generated by `standard-version` such as `chore(release): 1.0.0 🚀` are automatically ignored by `commitlint`.
+
 ### First release
 
 If this is your first release and you don't have a version tag yet:
@@ -158,6 +160,8 @@ If this is your first release and you don't have a version tag yet:
 npm run release -- --first-release
 ```
 
+Running the setup command ensures the default `npm test` script is `echo "No tests specified"`, preventing the Husky `pre-commit` hook from failing during this initial release. Replace it with your real test command once available.
+
 ### Dry run
 
 To see what would happen without making changes:

package/commitlint.config.cjs

@@ -1 +1,4 @@
-module.exports = { extends: ['@commitlint/config-conventional'] };
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  ignores: [(message) => message.startsWith('chore(release):')]
+};

package/index.js

@@ -11,6 +11,14 @@ const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
 
+function ensureSafeTestScript(scripts = {}) {
+  const defaultFailingTestScript = 'echo "Error: no test specified" && exit 1';
+  if (!scripts.test || scripts.test === defaultFailingTestScript) {
+    scripts.test = 'echo "No tests specified"';
+  }
+  return scripts;
+}
+
 function setupCommiter() {
   console.log('🚀 Setting up Commiter...\n');
 
@@ -31,8 +39,8 @@ function setupCommiter() {
     const packageJsonPath = path.join(process.cwd(), 'package.json');
     const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
 
+    packageJson.scripts = ensureSafeTestScript(packageJson.scripts || {});
     // Add scripts
-    packageJson.scripts = packageJson.scripts || {};
     packageJson.scripts.prepare = 'husky';
     packageJson.scripts.release = 'standard-version';
     packageJson.scripts['release:major'] = 'npm run release -- --release-as major';
@@ -64,8 +72,14 @@ function setupCommiter() {
     const isEsmProject = packageJson.type === 'module';
     const commitlintConfigFile = isEsmProject ? 'commitlint.config.js' : 'commitlint.config.cjs';
     const commitlintConfigContent = isEsmProject
-      ? `export default { extends: ['@commitlint/config-conventional'] }\n`
-      : `module.exports = { extends: ['@commitlint/config-conventional'] }\n`;
+      ? `export default {
+  extends: ['@commitlint/config-conventional'],
+  ignores: [(message) => message.startsWith('chore(release):')]
+}\n`
+      : `module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  ignores: [(message) => message.startsWith('chore(release):')]
+}\n`;
 
     const legacyCommitlintConfigFile = isEsmProject ? 'commitlint.config.cjs' : 'commitlint.config.js';
     if (fs.existsSync(legacyCommitlintConfigFile)) {
@@ -112,4 +126,4 @@ if (require.main === module) {
   setupCommiter();
 }
 
-module.exports = { setupCommiter };
+module.exports = { setupCommiter, ensureSafeTestScript };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@programinglive/commiter",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Commit convention tooling for standard-version releases with beautiful changelogs",
   "main": "index.js",
   "bin": {
     "commiter": "./index.js"
   },
   "scripts": {
-    "test": "echo \"No tests specified\"",
+    "test": "node test/ensureSafeTestScript.test.js",
     "prepare": "husky",
     "release": "standard-version",
     "release:major": "npm run release -- --release-as major",