Merge pull request #1200 from pjkaufman/master

Fix `Add Blank Line After YAML` Only Working When YAML Already Exists

Author: pjkaufman

.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18.x"
+          node-version: "16.x"
 
       - name: Build plugin and minfy css
         run: |

.gitignore

@@ -42,3 +42,4 @@ yarn.lock
 !__mocks__/*.js
 !/.eslintrc.js
 !babel.config.js
+!postcss.config.js

__integration__/yaml-rule.test.ts

@@ -1,5 +1,6 @@
 import TestLinterPlugin, {IntegrationTestCase} from './main.test';
-import {Editor} from 'obsidian';
+import {Editor, TFile} from 'obsidian';
+import moment from 'moment';
 
 function addBlankLineAfterSetup(plugin: TestLinterPlugin, _: Editor): Promise<void> {
   plugin.plugin.settings.ruleConfigs['add-blank-line-after-yaml'] = {
@@ -9,6 +10,53 @@ function addBlankLineAfterSetup(plugin: TestLinterPlugin, _: Editor): Promise<vo
   return;
 }
 
+function addBlankLineAfterYAMLConflictWithYAMLTimestampInsert(plugin: TestLinterPlugin): Promise<void> {
+  plugin.plugin.settings.ruleConfigs['add-blank-line-after-yaml'] = {
+    'enabled': true,
+  };
+  plugin.plugin.settings.ruleConfigs['yaml-timestamp'] = {
+    'enabled': true,
+    'date-created': true,
+    'date-created-key': 'created',
+    'date-created-source-of-truth': 'file system',
+    'date-modified': true,
+    'date-modified-key': 'last_modified',
+    'format': 'YYYY-MM-DD',
+  };
+
+  return;
+}
+
+function addBlankLineAfterYAMLConflictWithYAMLTimestampInsertExpectedTextModifications(text: string, file: TFile):string {
+  text = text.replace('{{created_date}}', moment(file.stat.ctime ?? '').format('YYYY-MM-DD'));
+  text = text.replace('{{modified_date}}', moment().format('YYYY-MM-DD'));
+
+  return text;
+}
+
+function addBlankLineAfterYAMLConflictWithYAMLTimestampUpdate(plugin: TestLinterPlugin): Promise<void> {
+  plugin.plugin.settings.ruleConfigs['add-blank-line-after-yaml'] = {
+    'enabled': true,
+  };
+  plugin.plugin.settings.ruleConfigs['yaml-timestamp'] = {
+    'enabled': true,
+    'date-created': false,
+    'date-modified': true,
+    'date-modified-key': 'last_modified',
+    'date-modified-source-of-truth': 'user or Linter edits',
+    'format': 'YYYY-MM-DD',
+  };
+
+  return;
+}
+
+function addBlankLineAfterYAMLConflictWithYAMLTimestampUpdateExpectedTextModifications(text: string):string {
+  text = text.replace('{{modified_date}}', moment().format('YYYY-MM-DD'));
+
+  return text;
+}
+
+
 export const obsidianYAMLRuleTestCases: IntegrationTestCase[] = [
   {
     name: 'Updating a file with no yaml for adding blank lines after yaml should do nothing',
@@ -20,4 +68,16 @@ export const obsidianYAMLRuleTestCases: IntegrationTestCase[] = [
     filePath: 'yaml-rules/add-blank-line-after-yaml/yaml.md',
     setup: addBlankLineAfterSetup,
   },
+  {
+    name: 'Updating a file with no yaml where YAML Timestamp Adds a Date Created, should properly update the YAML with a blank line after the frontmatter',
+    filePath: 'yaml-rules/add-blank-line-after-yaml/no-yaml-timestamp-addition.md',
+    setup: addBlankLineAfterYAMLConflictWithYAMLTimestampInsert,
+    modifyExpected: addBlankLineAfterYAMLConflictWithYAMLTimestampInsertExpectedTextModifications,
+  },
+  {
+    name: 'Updating a file with yaml where YAML Timestamp will only be updated if a change is made to the file, should properly add the missing blank line and update the date modified timestamp',
+    filePath: 'yaml-rules/add-blank-line-after-yaml/yaml-timestamp-update.md',
+    setup: addBlankLineAfterYAMLConflictWithYAMLTimestampUpdate,
+    modifyExpected: addBlankLineAfterYAMLConflictWithYAMLTimestampUpdateExpectedTextModifications,
+  },
 ];

postcss.config.js

@@ -0,0 +1,7 @@
+module.exports = {
+  plugins: [
+    require('cssnano')({
+      preset: 'default',
+    }),
+  ],
+};

src/lang/locale/en.ts

@@ -152,7 +152,7 @@ export default {
       },
       'lint-on-file-change': {
         'name': 'Lint on Focused File Change',
-        'description': 'When the a file is closed or a new file is swapped to, the previous file is linted.',
+        'description': 'When a file is closed or a new file is swapped to, the previous file is linted.',
       },
       'display-lint-on-file-change-message': {
         'name': 'Display Lint on File Change Message',

src/rules-runner.ts

@@ -30,6 +30,8 @@ import {LinterSettings} from './settings-data';
 import TrailingSpaces from './rules/trailing-spaces';
 import {CustomAutoCorrectContent} from './ui/linter-components/auto-correct-files-picker-option';
 import AutoCorrectCommonMisspellings from './rules/auto-correct-common-misspellings';
+import {yamlRegex} from './utils/regex';
+import AddBlankLineAfterYAML from './rules/add-blank-line-after-yaml';
 
 export type RunLinterRulesOptions = {
   oldText: string,
@@ -169,6 +171,11 @@ export class RulesRunner {
 
     [newText] = TrailingSpaces.applyIfEnabled(newText, runOptions.settings, this.disabledRules);
 
+    const yaml = newText.match(yamlRegex);
+    if (yaml != null) {
+      [newText] = AddBlankLineAfterYAML.applyIfEnabled(newText, runOptions.settings, this.disabledRules);
+    }
+
     let currentTime = runOptions.getCurrentTime();
     // run YAML timestamp at the end to help determine if something has changed
     let isYamlTimestampEnabled;
@@ -180,6 +187,10 @@ export class RulesRunner {
       locale: runOptions.momentLocale,
     });
 
+    if (yaml === null) {
+      [newText] = AddBlankLineAfterYAML.applyIfEnabled(newText, runOptions.settings, this.disabledRules);
+    }
+
     const yamlTimestampOptions = YamlTimestamp.getRuleOptions(runOptions.settings);
 
     currentTime = runOptions.getCurrentTime();
@@ -191,6 +202,7 @@ export class RulesRunner {
       yamlTimestampDateModifiedEnabled: isYamlTimestampEnabled && yamlTimestampOptions.dateModified,
       dateModifiedKey: yamlTimestampOptions.dateModifiedKey,
     });
+
     timingEnd(postRuleLogText);
     timingEnd(getTextInLanguage('logs.rule-running'));
     return newText;

src/rules/add-blank-line-after-yaml.ts

@@ -13,6 +13,8 @@ export default class AddBlankLineAfterYAML extends RuleBuilder<AddBlankLineAfter
       nameKey: 'rules.add-blank-line-after-yaml.name',
       descriptionKey: 'rules.add-blank-line-after-yaml.description',
       type: RuleType.YAML,
+      // needs to run before YAML timestamp if the YAML is present, but after it otherwise
+      hasSpecialExecutionOrder: true,
     });
   }
   get OptionsClass(): new () => AddBlankLineAfterYAMLOptions {

test-vault/yaml-rules/add-blank-line-after-yaml/no-yaml-timestamp-addition.linted.md

@@ -0,0 +1,6 @@
+---
+created: {{created_date}}
+last_modified: {{modified_date}}
+---
+
+Content here.

test-vault/yaml-rules/add-blank-line-after-yaml/no-yaml-timestamp-addition.md

@@ -0,0 +1 @@
+Content here.

test-vault/yaml-rules/add-blank-line-after-yaml/yaml-timestamp-update.linted.md

@@ -0,0 +1,5 @@
+---
+last_modified: {{modified_date}}
+---
+
+Content here.