Merge PR #129 from parhamsaremi/footer-note-misplacement-false-positive

Fixes #118

Author: knocte

commitlint.config.ts

@@ -27,8 +27,7 @@ module.exports = {
             "always",
             footerMaxLineLength,
         ],
-        // temporarily disabled because of https://github.com/nblockchain/conventions/issues/118
-        "footer-notes-misplacement": [RuleConfigSeverity.Disabled, "always"],
+        "footer-notes-misplacement": [RuleConfigSeverity.Error, "always"],
         // temporarily disabled because of https://github.com/nblockchain/conventions/issues/125
         "footer-refs-validity": [RuleConfigSeverity.Disabled, "always"],
         "header-max-length-with-suggestions": [

commitlint/plugins.test.ts

@@ -475,7 +475,6 @@ test("empty-wip-3", () => {
     expect(emptyWIP3.status).toBe(0);
 });
 
-/* temporarily disabled rule because of https://github.com/nblockchain/conventions/issues/118
 test("footer-notes-misplacement-1", () => {
     let commitMsgWithRightFooter =
         "foo: this is only a title" +
@@ -529,7 +528,17 @@ test("footer-notes-misplacement-4", () => {
     let footerNotesMisplacement4 = runCommitLintOnMsg(commitMsgWithWrongFooter);
     expect(footerNotesMisplacement4.status).not.toBe(0);
 });
-*/
+
+test("footer-notes-misplacement-5", () => {
+    let commitMsgWithRightFooter =
+        "foo: this is only a title\n\n" +
+        "Bla bla blah[1]:\n\n" +
+        "```\nSome error message with a [] in the first of its line\n[warn] some warning\n```\n\n" +
+        "[1] http://foo.bar/baz";
+    let footerNotesMisplacement5 = runCommitLintOnMsg(commitMsgWithRightFooter);
+    console.log(footerNotesMisplacement5.stdout.toString());
+    expect(footerNotesMisplacement5.status).toBe(0);
+});
 
 /* temporarily disabled rule because of https://github.com/nblockchain/conventions/issues/125
 test("footer-refs-validity1", () => {

commitlint/plugins.ts

@@ -157,7 +157,7 @@ export abstract class Plugins {
         let offence = false;
 
         if (bodyStr !== null) {
-            bodyStr = bodyStr.trim();
+            bodyStr = Helpers.removeAllCodeBlocks(bodyStr).trim();
             let seenBody = false;
             let seenFooter = false;
             let lines = bodyStr.split(/\r?\n/);