Skip to content

Fix srcToken error #1403

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
Nov 7, 2025
Merged

Fix srcToken error #1403

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fecd57
Fix srcToken error
mdbraber Sep 24, 2025
cce4f98
Fix linting
mdbraber Sep 24, 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
4 changes: 4 additions & 0 deletions src/rules/yaml-key-sort.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,10 @@ export default class YamlKeySort extends RuleBuilder<YamlKeySortOptions> {
const doc = parseYAML(yamlText);
const startingPriorityKeys = getEmptyDocument(doc);

if (doc.contents == null) {
return text;
}

Comment on lines +66 to +69
Copy link
Collaborator

@pjkaufman pjkaufman Sep 24, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this not be before line 64 since that is where the error is happening since that allows us to exit immediately after we know there is no content in the YAML? At least, that is where the error happens for me locally.

Copy link
Contributor Author

@mdbraber mdbraber Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - you're right. Or should the code of

obsidian-linter/src/utils/yaml.ts

Line 31 in 1877e2b

if (!yaml) {
be changed to check for an empty match by changing it to if (!yaml || yaml[1] == "")

Copy link
Collaborator

@pjkaufman pjkaufman Sep 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Returning an empty YAML string is fine from my understanding since it is possible to have YAML that is just empty and I would expect the content to be an empty string in that case. I am not sure if things would break if we also returned null for empty strings for the YAML.

I think that the proposed solution just before getting an empty document makes the most sense to me at this time.

let remainingKeys = this.getYAMLKeysSorted(yamlKeys, doc, startingPriorityKeys);

const sortOrder = options.yamlSortOrderForOtherKeys;
Expand Down