Skip to content

Fix Escaped Characters in Timestamp Format Resulting in Forced Update Even when It Should Not #1415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 17, 2025
Merged

Fix Escaped Characters in Timestamp Format Resulting in Forced Update Even when It Should Not #1415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b3db429
handle edge case for YAML timestamp values where escaped characters w…
pjkaufman Oct 15, 2025
39361a0
Merge branch 'platers:master' into master
pjkaufman Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions __tests__/yaml-timestamp.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,5 +551,28 @@ ruleTest({
dateModifiedSourceOfTruth: 'user or Linter edits',
},
},
{ // accounts for https://github.com/platers/obsidian-linter/issues/1411
testName: 'When the format for the file has escaped characters, if it matches the original format and the source of truth is not filesystem, then it should not update the date modified',
before: dedent`
---
modified_on: "[[2025-10-11]]"
---
`,
after: dedent`
---
modified_on: "[[2025-10-11]]"
---
`,
options: {
dateCreated: false,
format: '"[[[]YYYY-MM-DD[]]]"',
dateModifiedKey: 'modified_on',
fileCreatedTime: '2020-01-01T00:00:00-00:00',
fileModifiedTime: '2020-02-05T18:00:00-00:00',
currentTime: moment('Tuesday, February 5th 2026, 6:00:07 pm', 'dddd, MMMM Do YYYY, h:mm:ss a'),
alreadyModified: false,
dateModifiedSourceOfTruth: 'user or Linter edits',
},
},
],
});
16 changes: 12 additions & 4 deletions src/rules/yaml-timestamp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,12 @@ export default class YamlTimestamp extends RuleBuilder<YamlTimestampOptions> {
textModified = true;
}
} else if (options.dateCreatedSourceOfTruth != 'frontmatter') {
const createdDateTime = moment(createdDateString, options.format, options.locale, true);
if (createdDateTime == undefined || !createdDateTime.isValid()) {
// due to how moment validation works for formats, we must check if the output string is the same for the provided value since
// parsing when it has escaped characters in it does not result in a valid value
// see https://github.com/platers/obsidian-linter/issues/1411
const createdDateTime = moment(createdDateString, options.format, options.locale);
// to keep backwards compatibility, we will just go ahead and say that the format output must be equal if the format is not blank
if (createdDateTime == undefined || !createdDateTime.isValid() || (options.format !== '' && createdDateTime.format(options.format) != createdDateString)) {
text = text.replace(
created_match,
escapeDollarSigns(created_date_line) + '\n',
Expand Down Expand Up @@ -161,14 +165,18 @@ export default class YamlTimestamp extends RuleBuilder<YamlTimestampOptions> {

const keyWithValueFound = modified_match.test(text);
if (keyWithValueFound) {
const modifiedDateTime = moment(this.getYAMLTimestampString(text, modified_match, options.dateModifiedKey), options.format, options.locale, true);
// due to how moment validation works for formats, we must check if the output string is the same for the provided value since
// parsing when it has escaped characters in it does not result in a valid value
// see https://github.com/platers/obsidian-linter/issues/1411
const originalString = this.getYAMLTimestampString(text, modified_match, options.dateModifiedKey);
const modifiedDateTime = moment(originalString, options.format, options.locale);
// conditions when update happens for date modified if the key already exists:
// 1. the text has been modified
// 2. the modified date in the frontmatter is not the same locale or format as the settings
// 3. the source of truth is not when a user or the Linter makes a change to the file and
// there is a more than 5 second difference between the date modified in the frontmatter and
// the filesystem
if (textModified || modifiedDateTime == undefined || !modifiedDateTime.isValid() ||
if (textModified || modifiedDateTime == undefined || !modifiedDateTime.isValid() || modifiedDateTime.format(options.format) != originalString ||
(options.dateModifiedSourceOfTruth != 'user or Linter edits' && this.getTimeDifferenceInSeconds(modifiedDateTime, modified_date, options) > 5)
) {
text = text.replace(
Expand Down