Merge pull request #1345 from pjkaufman/master

Fix `YAML Title Alias` Adding and Leaving Blank YAML in Notes

Author: pjkaufman

__tests__/yaml-title-alias.test.ts

@@ -635,8 +635,6 @@ ruleTest({
         # Filename
       `,
       after: dedent`
-        ---
-        ---
         # Filename
       `,
       options: {
@@ -1062,8 +1060,6 @@ ruleTest({
         # Filename
       `,
       after: dedent`
-        ---
-        ---
         # Filename
       `,
       options: {
@@ -1414,5 +1410,42 @@ ruleTest({
         fileName: 'Filename',
       },
     },
+    { // accounts for https://github.com/platers/obsidian-linter/issues/1293
+      testName: 'Make sure that a blank YAML block is not added when there is no value to be added by the rule',
+      before: dedent`
+        # Filename
+      `,
+      after: dedent`
+        # Filename
+      `,
+      options: {
+        aliasArrayStyle: NormalArrayFormats.MultiLine,
+        defaultEscapeCharacter: '"',
+        preserveExistingAliasesSectionStyle: true,
+        aliasHelperKey: 'aliases2',
+        keepAliasThatMatchesTheFilename: false,
+        fileName: 'Filename',
+      },
+    },
+    { // relates to https://github.com/platers/obsidian-linter/issues/1293
+      testName: 'Make sure that a blank YAML block is not added when there is no value to be added by the rule and that extra space is removed before the first piece of content',
+      before: dedent`
+        ---
+        ---
+        ${''}
+        # Filename
+      `,
+      after: dedent`
+        # Filename
+      `,
+      options: {
+        aliasArrayStyle: NormalArrayFormats.MultiLine,
+        defaultEscapeCharacter: '"',
+        preserveExistingAliasesSectionStyle: true,
+        aliasHelperKey: 'aliases2',
+        keepAliasThatMatchesTheFilename: false,
+        fileName: 'Filename',
+      },
+    },
   ],
 });

src/rules/yaml-title-alias.ts

@@ -112,7 +112,17 @@ export default class YamlTitleAlias extends RuleBuilder<YamlTitleAliasOptions> {
       newYaml = setYamlSection(newYaml, aliasHelperKey, ` ${title}`);
     }
 
-    text = text.replace(`---\n${yaml}---`, `---\n${newYaml}---`);
+    const oldYaml = `---\n${yaml}---`;
+    let newYamlValue = `---\n${newYaml}---`;
+    if (newYaml === '') {
+      newYamlValue = '';
+    }
+
+    text = text.replace(oldYaml, newYamlValue);
+
+    if (newYaml === '') {
+      text = text.trimStart();
+    }
 
     return text;
   }

src/utils/strings.ts

@@ -359,7 +359,7 @@ export function hashString53Bit(str: string, seed: number = 0): number {
 }
 
 /**
- * Takes a string and converts string that have the string escaped form of escape characters such as new line, backspace,
+ * Takes a string and converts string that have the string escaped form of escape characters such as new line,
  * form feed, carriage return, horizontal tab, and vertical tab and makes sure they are their escaped character values.
  * @param {string} val - The string to make sure has the escape characters as escape characters rather than a stringified form.
  * @return {string} The string with the escape characters converted to their escape character form.