@ethima/commitlint-config 1.0.0 → 1.1.0

package/README.md

@@ -10,22 +10,28 @@ adjustments as detailed below.
 
 ### More lenient rules regarding long lines in bodies and footers
 
-When referencing URIs in commit messages, which is a common scenario when
-referencing code on source hosting platforms, etc., it is trivial to trigger
-the `{body,footer}-max-line-length` rules.
-
-To ensure URIs like these can be included in commit messages, this
-configuration replaces the `{body,footer}-max-line-length` rules with the
-`{body,footer}-max-line-length-with-footnote-exemption` rules. These rules
-allow long lines in either the body or the footer of commit messages if they
-are written as Markdown footnotes, e.g. `[^1]: <long line>`,
-`[^named-footnote]: <long line>`. These footnotes can then be referenced
-elsewhere in the commit message and most hosting platforms will render these
-footnotes with proper links, etc.
-
-Both the `body-` and `footer-` rules are replaced as some URIs may trigger the
-footer detection in the commit meesage parser, particularly when a URI includes
-a `#`.
+When referencing URIs in commit messages it is trivial to trigger the
+`{body,footer}-max-line-length` rules. This is a common scenario when
+referencing code, commits, etc. on source hosting platforms.
+
+One scenario in which long URIs in a commit message are common are release
+commits of the semantic release process. Specifically linking to source commits
+for changelog entries, see [the initial release of this configuration for an
+example][ethima-commitlint-config-initial-release-commit-url]. These commits,
+assumed to have a header of the form `build|chore(release): v<x.y.z>`, are
+exempt from any checks.
+
+Other long URI references can be included in commit messages by writing them as
+Markdown footnotes, e.g. `[^1]: <long URI>`, `[^named-footnote]: <long URI>` at
+the end of the commit message and referencing them from the body. Most hosting
+platforms will render these footnotes with proper links, etc. in various places
+in their UI. To support this functionality, this configuration replaces the
+`{body,footer}-max-line-length` rules with the
+`{body,footer}-max-line-length-with-footnote-exemption` rules. Apart from the
+exemption, these rules behave the same as the original rules and accept the
+same configuration. Both the `body-` and `footer-` rules are replaced as some
+URIs may trigger the footer detection in the commit message parser,
+particularly when a URI includes a `#`.
 
 ### Stricter rules on merge and `fixup!`/`squash!` commits
 
@@ -54,4 +60,5 @@ into (pre)release branches.
 [commitlint-is-ignored-wildcards-url]: https://github.com/conventional-changelog/commitlint/blob/3bc4726f0dddfa051bc75f6af7b7ca076b04a839/%40commitlint/is-ignored/src/defaults.ts#L17-L29
 [commitlint-url]: https://commitlint.js.org
 [conventional-commits-url]: https://conventionalcommits.org/
+[ethima-commitlint-config-initial-release-commit-url]: https://gitlab.com/ethima/commitlint-config/-/commit/3c32023a5647f8bf4090e1158a3d1f4fa9279324
 [ethima-url]: https://gitlab.com/ethima/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethima/commitlint-config",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A shareable Commitlint configuration for the Ethima organization",
   "main": "src/index.js",
   "scripts": {
@@ -22,12 +22,12 @@
   },
   "homepage": "https://gitlab.com/ethima/commitlint-config",
   "dependencies": {
-    "@commitlint/config-conventional": "18.1.0",
-    "@commitlint/is-ignored": "18.1.0"
+    "@commitlint/config-conventional": "18.4.3",
+    "@commitlint/is-ignored": "18.4.3"
   },
   "devDependencies": {
-    "@commitlint/lint": "18.1.0",
-    "@commitlint/load": "18.2.0",
-    "ava": "5.3.1"
+    "@commitlint/lint": "18.4.3",
+    "@commitlint/load": "18.4.3",
+    "ava": "6.0.1"
   }
 }

package/src/index.js

@@ -5,6 +5,12 @@ const {
 
 const footnoteMatcher = new RegExp("^\\[\\^.+?\\]:");
 
+// Matches the header of commits representing semantic releases
+const semanticReleaseCommitMatcher = new RegExp(
+  "^(build|chore)\\(release\\):\\s*v?\\d+(\\.\\d+){2}.*$",
+  "m",
+);
+
 // When referencing URIs in commit messages, it is very common to hit
 // `max-line-length` restrictions. As a work-around, these URIs may be added as
 // Markdown footnotes which can then be detected and given an exemption
@@ -37,18 +43,26 @@ const buildMaxLineLengthWithFootnoteExemption = (section) => {
 //
 // Instead of duplicating these function definitions, it is more
 // straightforward to obtain them from the defaults
-const ignores = defaultIgnoreFunctions.filter(
+const applicableDefaultIgnoreFunctions = defaultIgnoreFunctions.filter(
   (ignoreFunction) =>
     ignoreFunction("Revert ") || ignoreFunction("Merge 'x' into 'y' "),
 );
 
+// Ignore functions specific to this commitlint configuration
+const configurationSpecificIgnoreFunctions = [
+  semanticReleaseCommitMatcher.test.bind(semanticReleaseCommitMatcher),
+];
+
 module.exports = {
   // Do not use the default ignore patterns as they allow patterns, e.g.
   // `fixup!` and `squash!` commits, that should be blocked in the workflows
   // primarily supported by this configuration
   defaultIgnores: false,
   extends: ["@commitlint/config-conventional"],
-  ignores,
+  ignores: [
+    ...applicableDefaultIgnoreFunctions,
+    ...configurationSpecificIgnoreFunctions,
+  ],
   plugins: [
     {
       rules: {