@pplancq/commitlint-config 2.3.2 → 3.0.0

package/README.md

@@ -23,3 +23,27 @@ npx init-commitlint-config
 ### @pplancq/commitlint-config
 
 This is the default configuration. To use, add `"commitlint": { "extends": ["@pplancq/commitlint-config"] }` to your `package.json`.
+
+## ⚠️ Breaking Change: ESM Only from v3
+
+As of version 3.x, this package is ESM-only. CommonJS (`require`) is no longer supported.
+
+## Migration from CommonJS to ESM
+
+**Old (CommonJS) usage:**
+
+```js
+// .commitlintrc.js or commitlint.config.js
+module.exports = { extends: ['@pplancq/commitlint-config'] };
+```
+
+**New (ESM) usage:**
+
+```js
+// commitlint.config.mjs (or commitlint.config.js when using "type": "module")
+export default {
+  extends: ['@pplancq/commitlint-config'],
+};
+```
+
+If you are using a `.js` config file, ensure your environment supports ESM (e.g., Node.js >= 18, or set "type": "module" in your package.json).

package/bin/init.mjs

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+import { writeFileSync } from 'node:fs';
+
+console.info('Add commitlint config in commitlint.config.mjs');
+
+writeFileSync(
+  'commitlint.config.mjs',
+  `export default {
+  extends: ['@pplancq/commitlint-config'],
+};
+`,
+  {
+    encoding: 'utf-8',
+  },
+);

package/index.js

@@ -9,4 +9,5 @@ const config = {
   },
 };
 
-module.exports = config;
+// eslint-disable-next-line import/no-default-export
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pplancq/commitlint-config",
-  "version": "2.3.2",
+  "version": "3.0.0",
   "license": "MIT",
   "description": "pplancq commitlint config",
   "author": "pplancq <paul.plancq@outlook.fr>",
@@ -24,25 +24,26 @@
   "bugs": {
     "url": "https://github.com/pplancq/dev-tools/issues"
   },
+  "type": "module",
   "main": "index.js",
   "bin": {
-    "init-commitlint-config": "bin/init.js"
+    "init-commitlint-config": "bin/init.mjs"
   },
   "keywords": [
     "commitlint",
     "config"
   ],
   "dependencies": {
-    "@commitlint/config-conventional": "^20.3.0"
+    "@commitlint/config-conventional": "^20.3.1"
   },
   "peerDependencies": {
     "@commitlint/cli": "^19.0.3 || ^20.0.0"
   },
   "devDependencies": {
     "eslint": "^9.39.2",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-prettier": "^5.5.5",
     "lint-staged": "^16.2.7",
-    "prettier": "^3.7.4"
+    "prettier": "^3.8.1"
   },
   "engines": {
     "node": ">=v18"

package/bin/init.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-const { writeFileSync } = require('fs');
-
-console.info('Add commitlint config in .commitlintrc.js');
-
-writeFileSync('.commitlintrc.js', "module.exports = { extends: ['@pplancq/commitlint-config'] };\n", {
-  encoding: 'utf-8',
-});