Merge branch 'space-footnotes' into 'master'

Require spacing between paragraphs and footnotes

See merge request mkjeldsen/commitmsgfmt!38

Author: commonquail

CHANGELOG.md

@@ -12,6 +12,12 @@ understanding of patterns often seen in commit messages.
 - Extend the range of non-breakable tokens to include any sequence of ASCII
   punctuation. Previously `foo ...` could wrap; now it cannot.
 
+- Restrict the definition of footnotes to require a vertical space after
+  a preceding paragraph. This prevents footnote references that have ended up
+  at the start of a line from degenerating into footnotes. That is, previously
+  `foo\n[1] bar` would be a paragraph followed by a footnote whereas now it is
+  a single paragraph containing a footnote reference.
+
 ## 1.4.1 - 2021-04-05
 
 - Fix an errant man page header accidentally added in v1.4.0.

doc/commitmsgfmt.1.adoc

@@ -128,11 +128,16 @@ a space is considered a _footnote_:
 Official Git Web site [1][git]
 
 [1] https://git-scm.com/
-[git]: https://git-scm.com/
+[git]: Git is a free and open source distributed version control system
+       designed to handle everything from small to very large projects
+       with speed and efficiency.
 ----
 
 This syntax is inspired by the IEEE whitepaper reference style.
 
+Multiple footnotes may follow each other immediately, however, the first
+footnote in any block of footnotes must be preceded by an empty line.
+
 Footnotes are wrapped like _paragraphs_, with continuation lines space-indented
 to match the first line. Additional spaces after the mandatory space are
 stripped. Footnotes are not considered to have a natural order and

src/commitmsgfmt.rs

@@ -223,6 +223,7 @@ foo
 foo
 
 paragraph
+
 [2] note
 [1] note
 [3]    foo bar baz qux https://a.really-long-url.example
@@ -236,6 +237,7 @@ paragraph
 foo
 
 paragraph
+
 [2] note
 [1] note
 [3] foo bar baz qux
@@ -279,12 +281,11 @@ x [1]
 x [1].
 x [1] .
 
-yy [2] y
-[2] .
+yy [2]
+y [2] .
 
 zzz [3]
-z
-[3] .
+z [3] .
 
 www [4]
 w

src/parser.rs

@@ -55,6 +55,7 @@ pub fn parse(input: &str, comment_char: char) -> Vec<Token> {
     \s+)",
     )
     .unwrap();
+    let mut px = false;
     for line in lines {
         if has_scissors {
             match *toks.last_mut().expect("has_scissors") {
@@ -79,10 +80,12 @@ pub fn parse(input: &str, comment_char: char) -> Vec<Token> {
             if toks.last() != Some(&Token::VerticalSpace) {
                 toks.push(Token::VerticalSpace);
             }
+            px = true;
         } else if !has_subject {
             parse_subject(line, &mut toks);
             has_subject = true;
-        } else if footnote.is_match(line) {
+            px = false;
+        } else if px && footnote.is_match(line) {
             debug_assert!(footnote.as_str().contains(' '));
             let mut splitter = line.splitn(2, ' ');
             let key = splitter.next().unwrap().to_owned();
@@ -118,6 +121,7 @@ pub fn parse(input: &str, comment_char: char) -> Vec<Token> {
                     raw.push('\n'); // Recover linefeed lost from iterator.
                     Some(Token::Literal(raw))
                 } else {
+                    px = false;
                     Some(Token::Paragraph(line.trim().to_owned()))
                 }
             }
@@ -525,7 +529,7 @@ Signed-off-by: Jane Doe <jane@doe.com>
     }
 
     #[test]
-    fn footnotes_are_left_bracket_ident_right_bracket_space_text() {
+    fn footnotes_are_left_bracket_ident_right_bracket_space_text_distanced_from_paragraph() {
         assert_eq!(
             parse(
                 "
@@ -564,13 +568,18 @@ subject
     }
 
     #[test]
-    fn footnote_does_not_join_immediately_preceding_paragraph() {
+    fn footnote_cannot_follow_paragraph_immediately() {
         assert_eq!(
             parse(
                 "
 subject
 
-paragraph
+paragraph 1
+[1] not footnote 1
+[2] not footnote 2
+
+paragraph 2
+
 [1] footnote 1
 [2] footnote 2
 "
@@ -579,7 +588,10 @@ paragraph
                 VerticalSpace,
                 Subject("subject".to_owned()),
                 VerticalSpace,
-                Paragraph("paragraph".to_owned()),
+                Paragraph("paragraph 1 [1] not footnote 1 [2] not footnote 2".to_owned()),
+                VerticalSpace,
+                Paragraph("paragraph 2".to_owned()),
+                VerticalSpace,
                 Footnote("[1]".to_owned(), "footnote 1".to_owned()),
                 Footnote("[2]".to_owned(), "footnote 2".to_owned()),
             ],