@w5s/commitlint-config 1.0.0-alpha.8 → 1.0.0

package/README.md

@@ -21,19 +21,23 @@ npm install --save-dev @w5s/commitlint-config @commitlint/cli
 
 In the `package.json` of your project
 
+<!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=```json\n{\n  "commitlint": {\n    "extends": ["${name}"]\n  }\n}\n```) -->
 ```json
 {
-    "commitlint": {
-        "extends": ["@w5s/commitlint-config"],
-        "rules": {}
-    },
-    "husky": {
-        "hooks": {
-            "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-        }  
-    }
+  "commitlint": {
+    "extends": ["@w5s/commitlint-config"]
+  }
 }
 ```
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+Ensure the `commitlint` is setup on husky commit message hook (default `.husky/commit-msg`)
+
+```console
+commitlint --edit $1
+# -OR-
+npm exec --no -- commitlint --edit $1
+```
 
 ## License
 <!-- AUTO-GENERATED-CONTENT:START (PKGJSON:template=[${license}][license-url] © ${author}) -->

package/index.d.ts

@@ -0,0 +1,3 @@
+import Config from './lib/index.js';
+
+export = Config;

package/index.js

@@ -0,0 +1,2 @@
+/** @type {import('prettier').Config} */
+module.exports = require('./lib/index.js').default;

package/lib/index.d.ts

@@ -1,15 +1,7 @@
+import { type LintOptions } from '@commitlint/types';
 declare const config: {
+    parserPreset: LintOptions;
     rules: Partial<import("@commitlint/types").RulesConfig<import("@commitlint/types").RuleConfigQuality.Qualified>>;
-    parserPreset: {
-        parserOpts: {
-            headerPattern: RegExp;
-            headerCorrespondence: string[];
-        };
-        plugins: {
-            gitmoji: import("@commitlint/types").Plugin;
-        };
-    };
-    plugins: import("@commitlint/types").Plugin[];
 };
 export default config;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAyBA,QAAA,MAAM,MAAM;;;;;;;;;;;;CASX,CAAC;AAMF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAA2C,KAAK,WAAW,EAAE,MAAM,mBAAmB,CAAC;AA+B9F,QAAA,MAAM,MAAM;;;CAGX,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/index.js

@@ -1,4 +1,13 @@
 "use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,12 +15,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable import/no-import-module-exports */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 var types_1 = require("@commitlint/types");
-var commitlint_plugin_gitmoji_1 = __importDefault(require("commitlint-plugin-gitmoji"));
-var parser_opts_1 = __importDefault(require("@gitmoji/parser-opts"));
-var commit_types_1 = __importDefault(require("@gitmoji/commit-types"));
-var Error = types_1.RuleConfigSeverity.Error, Warning = types_1.RuleConfigSeverity.Warning, Disabled = types_1.RuleConfigSeverity.Disabled;
+var gitmojis_1 = require("gitmojis");
+var emoji_regex_1 = __importDefault(require("emoji-regex"));
+var allGitmojiCodes = __spreadArray(__spreadArray([], gitmojis_1.gitmojis.map(function (gitmoji) { return gitmoji.code; }), true), gitmojis_1.gitmojis.map(function (gitmoji) { return gitmoji.emoji; }), true);
+var Error = types_1.RuleConfigSeverity.Error, Warning = types_1.RuleConfigSeverity.Warning;
+var parserPreset = {
+    parserOpts: {
+        // eslint-disable-next-line unicorn/no-unsafe-regex, prefer-regex-literals
+        headerPattern: new RegExp("^(:\\w*:|".concat(String((0, emoji_regex_1.default)().source), ") (?:\\((.*)\\):? )?(.*)$")),
+        headerCorrespondence: ['type', 'scope', 'subject'],
+    },
+};
 var rules = {
-    'start-with-gitmoji': [Error, 'always'],
     'body-leading-blank': [Warning, 'always'],
     'body-max-line-length': [Error, 'always', 100],
     'footer-leading-blank': [Warning, 'always'],
@@ -19,25 +34,16 @@ var rules = {
     'header-max-length': [Error, 'always', 72],
     'scope-case': [Error, 'always', 'lower-case'],
     'subject-case': [Error, 'always', ['sentence-case']],
-    'subject-empty': [Disabled, 'never'],
+    'subject-empty': [Error, 'never'],
+    'subject-exclamation-mark': [Error, 'never'],
     'subject-full-stop': [Error, 'never', '.'],
     'type-case': [Error, 'always', 'lower-case'],
-    'type-empty': [Error, 'always'],
-    'type-enum': [Error, 'always', commit_types_1.default],
+    'type-empty': [Error, 'never'],
+    'type-enum': [Error, 'always', allGitmojiCodes],
 };
 var config = {
+    parserPreset: parserPreset,
     rules: rules,
-    parserPreset: {
-        parserOpts: parser_opts_1.default,
-        plugins: {
-            gitmoji: commitlint_plugin_gitmoji_1.default,
-        },
-    },
-    plugins: [commitlint_plugin_gitmoji_1.default],
 };
-// FIXME: this is a workaround for commonjs loading
-if (typeof module !== 'undefined') {
-    module.exports = config;
-}
 exports.default = config;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,oDAAoD;AACpD,4DAA4D;AAC5D,2CAA4E;AAC5E,wFAAsD;AACtD,qEAAqD;AACrD,uEAAgD;AAExC,IAAA,KAAK,GAAwB,0BAAkB,MAA1C,EAAE,OAAO,GAAe,0BAAkB,QAAjC,EAAE,QAAQ,GAAK,0BAAkB,SAAvB,CAAwB;AAExD,IAAM,KAAK,GAAmB;IAC5B,oBAAoB,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IACvC,oBAAoB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IACzC,sBAAsB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC;IAC9C,sBAAsB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3C,wBAAwB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC;IAChD,mBAAmB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC1C,YAAY,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC;IAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,CAAC;IACpD,eAAe,EAAE,CAAC,QAAQ,EAAE,OAAO,CAAC;IACpC,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC;IAC1C,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC;IAC5C,YAAY,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IAC/B,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,sBAAW,CAAC;CAC5C,CAAC;AAEF,IAAM,MAAM,GAAG;IACb,KAAK,OAAA;IACL,YAAY,EAAE;QACZ,UAAU,EAAE,qBAAiB;QAC7B,OAAO,EAAE;YACP,OAAO,EAAE,mCAAa;SACvB;KACF;IACD,OAAO,EAAE,CAAC,mCAAa,CAAC;CACzB,CAAC;AACF,mDAAmD;AACnD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;IACjC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;CACzB;AAED,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAAoD;AACpD,4DAA4D;AAC5D,2CAA8F;AAC9F,qCAAoC;AACpC,4DAAsC;AAEtC,IAAM,eAAe,mCAAO,mBAAQ,CAAC,GAAG,CAAC,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,IAAI,EAAZ,CAAY,CAAC,SAAK,mBAAQ,CAAC,GAAG,CAAC,UAAC,OAAO,IAAK,OAAA,OAAO,CAAC,KAAK,EAAb,CAAa,CAAC,OAAC,CAAC;AAC1G,IAAA,KAAK,GAAc,0BAAkB,MAAhC,EAAE,OAAO,GAAK,0BAAkB,QAAvB,CAAwB;AAE9C,IAAM,YAAY,GAAgB;IAChC,UAAU,EAAE;QACV,0EAA0E;QAC1E,aAAa,EAAE,IAAI,MAAM,CAAC,mBAAY,MAAM,CAAC,IAAA,qBAAW,GAAE,CAAC,MAAM,CAAC,8BAA2B,CAAC;QAC9F,oBAAoB,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC;KACnD;CACF,CAAC;AAEF,IAAM,KAAK,GAAmB;IAC5B,oBAAoB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IACzC,sBAAsB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC;IAC9C,sBAAsB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;IAC3C,wBAAwB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC;IAChD,mBAAmB,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC1C,YAAY,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC;IAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,CAAC,eAAe,CAAC,CAAC;IACpD,eAAe,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;IACjC,0BAA0B,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;IAC5C,mBAAmB,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC;IAC1C,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,YAAY,CAAC;IAC5C,YAAY,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;IAC9B,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,eAAe,CAAC;CAChD,CAAC;AAEF,IAAM,MAAM,GAAG;IACb,YAAY,cAAA;IACZ,KAAK,OAAA;CACN,CAAC;AAEF,kBAAe,MAAM,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@w5s/commitlint-config",
-  "version": "1.0.0-alpha.8",
+  "version": "1.0.0",
   "description": "Commitlint configuration presets",
   "keywords": [
     "commitlint",
@@ -19,27 +19,33 @@
   "license": "MIT",
   "author": "Julien Polo <julien.polo@gmail.com>",
   "type": "commonjs",
-  "exports": "./lib/index.js",
+  "exports": {
+    ".": "./index.js",
+    "./lib/*": "./lib/*"
+  },
+  "typings": "./index.d.ts",
   "files": [
     "lib/**/!(*.spec).d.ts",
     "lib/**/!(*.spec).d.ts.map",
     "lib/**/!(*.spec).js.map",
     "lib/**/!(*.spec).js",
-    "src/**/!(*.spec).ts"
+    "src/**/!(*.spec).ts",
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
-    "build": "concurrently \"npm:build:*\" ",
+    "build": "concurrently \"npm:build:*\" \":\"",
     "build:src": "tsc",
     "clean": "concurrently \"npm:clean:*\" \":\"",
     "docs": "md-magic --path '**/*.md' --ignore='node_modules'",
     "format": "concurrently \"npm:format:*\" \":\"",
-    "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json",
+    "format:src": "eslint . --fix --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
     "lint": "concurrently \"npm:lint:*\" \":\"",
-    "lint:src": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json",
+    "lint:src": "eslint . --ext=mjs,cjs,js,jsx,ts,tsx,json,jsonc,json5,yml,yaml",
     "prepare": "concurrently \"npm:prepare:*\" \":\"",
     "spellcheck": "cspell --no-progress '**'",
-    "test": "jest",
-    "validate": "npm run lint && npm run build && npm run test"
+    "test": "concurrently \"npm:test:*\" ",
+    "test:src": "jest"
   },
   "jest": {
     "moduleNameMapper": {
@@ -57,13 +63,12 @@
   },
   "dependencies": {
     "@commitlint/types": "^17.0.0",
-    "@gitmoji/commit-types": "^1.1.5",
-    "@gitmoji/parser-opts": "^1.3.0",
-    "commitlint-plugin-gitmoji": "^2.2.0"
+    "emoji-regex": "^10.2.1",
+    "gitmojis": "^3.13.0"
   },
   "devDependencies": {
-    "@commitlint/lint": "17.0.3",
-    "@jest/globals": "28.1.3"
+    "@commitlint/lint": "17.2.0",
+    "@jest/globals": "29.3.1"
   },
   "peerDependencies": {
     "@commitlint/cli": "^16.0.0 || ^17.0.0"

package/src/index.ts

@@ -1,14 +1,21 @@
 /* eslint-disable import/no-import-module-exports */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
-import { RuleConfigSeverity, type QualifiedRules } from '@commitlint/types';
-import gitmojiPlugin from 'commitlint-plugin-gitmoji';
-import gitmojiParserOpts from '@gitmoji/parser-opts';
-import commitTypes from '@gitmoji/commit-types';
+import { RuleConfigSeverity, type QualifiedRules, type LintOptions } from '@commitlint/types';
+import { gitmojis } from 'gitmojis';
+import emojiRegexp from 'emoji-regex';
 
-const { Error, Warning, Disabled } = RuleConfigSeverity;
+const allGitmojiCodes = [...gitmojis.map((gitmoji) => gitmoji.code), ...gitmojis.map((gitmoji) => gitmoji.emoji)];
+const { Error, Warning } = RuleConfigSeverity;
+
+const parserPreset: LintOptions = {
+  parserOpts: {
+    // eslint-disable-next-line unicorn/no-unsafe-regex, prefer-regex-literals
+    headerPattern: new RegExp(`^(:\\w*:|${String(emojiRegexp().source)}) (?:\\((.*)\\):? )?(.*)$`), /// ^(:\w*:) (?:\((.*)\) )?(.*)$/,
+    headerCorrespondence: ['type', 'scope', 'subject'],
+  },
+};
 
 const rules: QualifiedRules = {
-  'start-with-gitmoji': [Error, 'always'],
   'body-leading-blank': [Warning, 'always'],
   'body-max-line-length': [Error, 'always', 100],
   'footer-leading-blank': [Warning, 'always'],
@@ -16,26 +23,17 @@ const rules: QualifiedRules = {
   'header-max-length': [Error, 'always', 72],
   'scope-case': [Error, 'always', 'lower-case'],
   'subject-case': [Error, 'always', ['sentence-case']],
-  'subject-empty': [Disabled, 'never'], // [Error, 'never'],
+  'subject-empty': [Error, 'never'],
+  'subject-exclamation-mark': [Error, 'never'],
   'subject-full-stop': [Error, 'never', '.'],
   'type-case': [Error, 'always', 'lower-case'],
-  'type-empty': [Error, 'always'],
-  'type-enum': [Error, 'always', commitTypes],
+  'type-empty': [Error, 'never'],
+  'type-enum': [Error, 'always', allGitmojiCodes],
 };
 
 const config = {
+  parserPreset,
   rules,
-  parserPreset: {
-    parserOpts: gitmojiParserOpts,
-    plugins: {
-      gitmoji: gitmojiPlugin,
-    },
-  },
-  plugins: [gitmojiPlugin],
 };
-// FIXME: this is a workaround for commonjs loading
-if (typeof module !== 'undefined') {
-  module.exports = config;
-}
 
 export default config;