Merge pull request #1229 from pjkaufman/master

Feat: `Line Break at Document End` No Longer Adds Blank Line at End of Empty Notes

Author: pjkaufman

src/lang/locale/en.ts

@@ -510,7 +510,7 @@ export default {
     // line-break-at-document-end.ts
     'line-break-at-document-end': {
       'name': 'Line Break at Document End',
-      'description': 'Ensures that there is exactly one line break at the end of a document.',
+      'description': 'Ensures that there is exactly one line break at the end of a document if the note is not empty.',
     },
     // move-footnotes-to-the-bottom.ts
     'move-footnotes-to-the-bottom': {

src/rules/line-break-at-document-end.ts

@@ -17,6 +17,10 @@ export default class LineBreakAtDocumentEnd extends RuleBuilder<LineBreakAtDocum
     return LineBreakAtDocumentEndOptions;
   }
   apply(text: string, options: LineBreakAtDocumentEndOptions): string {
+    if (text.length === 0) {
+      return text;
+    }
+
     text = text.replace(/\n+$/g, '');
     text += '\n';
     return text;
@@ -46,6 +50,11 @@ export default class LineBreakAtDocumentEnd extends RuleBuilder<LineBreakAtDocum
           ${''}
         `,
       }),
+      new ExampleBuilder({ // https://github.com/platers/obsidian-linter/issues/1228
+        description: 'Empty files will not have a blank line added',
+        before: dedent``,
+        after: dedent``,
+      }),
     ];
   }
   get optionBuilders(): OptionBuilderBase<LineBreakAtDocumentEndOptions>[] {