if i do text

lora ipsala [^note] dolores.

[^note]: This is not right

    - because the footnote takes more than one paragraph.
    - and linter does only move the first line.

    but not the rest of it

    it will mess up every multiline note instantly

this is not cool

it will destroy all all footnotes

Writing down each rule in a box seems unnecessary, and is pretty bad for ease-of-use.

Thanks for the great plugin. I have a small FR, that we can customize the field name of date updated, for example, change it to modified.

By the way I have a small question: what is the syntax of yaml-timestamp format=? I wrote

yaml-timestamp format=YYYY-MM-DD HH:MM

and it told me invalid argument format. Seems like the space between YYYY-MM-DD and HH:MM is invalid.

https://github.com/DavidAnson/markdownlint

Add rules that are automatically fixable.

First of all, thanks for the plugin! It's one of those little things saving a bit of time every day.

A rule that I would find very useful is the conversion between tabs and spaces. For me personally, this would be incredibly useful because all the notes I imported from earlier apps use spaces, but the various relationship line css snippets need tabs to work.

I get a popup message "Rule line-break-at-document-end not recognized".
My rules:

trailing-spaces
space-after-list-markers
header-increment
re-index-footnotes
move-footnotes-to-the-bottom
line-break-at-document-end

Obisidian v0.12.15
Linter v1.1.5

Tag rules like https://github.com/DavidAnson/markdownlint.

Tag can be used to enable an entire group of rules.

Sort rules in the documentation by their primary(first) tag.

i had to uninstall and reinstall linter to get the settings tab back in obsidian
now i have cool buttons to enable and disable settings
what ever i click ... the test "enabled" does not change... it is confusing

Since last plugin update i cant find the linter settings tab.

may because linter does lint every thing now?
except if i add YAML exclussion rules, i think this is a semi bad idea, people should be able to define the rules they want in settings, apply extra rules in YAML od deactivate rules in YAML, but people should not need to place YAML exclussions to all files because the want to exclude only one rule in general.

how ever ... thanks for your effort

Add date-created, date-updated options to YAML Timestamp rule

This plugin is so useful that I bound it to the hotkey Ctrl + S together with the save command. However, a tiny problem is that, after executing the lint command, the window will automatically shift up a fixed distance.

I haven't been able to test this out further but just had to restore a few files from my version history because large duplications of content and messed up formatting occurred when there was a second instance of frontmatter.

Example:

---
frontmatter: at the top of the file
---

Contents of the file
Contents of the file

---
code block: with frontmatter
---
code
code

Using rules:

heading-blank-lines bottom="false"
consecutive-blank-lines
space-after-list-markers
yaml-timestamp format="YYYY-MM-DD" dateCreated="false"
compact-yaml
capitalize-headings
file-name-heading

I found that Obsidian-Linter incorrectly treats C/Python/sh comments (#) in code blocks as "headers." In the example below, I didn't except any formatting changes, but this probably can't be easily fixed.

(Note: I this bug also applies to comments like #### H4 which would have been autocorrected to ## H2)

# Title

- Indented Code Block

    ```sh
    # Comment
    echo "Hello"

    echo "World!"
    ```

```python
# normal CODE
```

Becomes:

# Title

- Indented Code Block

    ```sh

# Comment

    echo "Hello"

    echo "World!"
    ```

```python

# Normal Code

```

With rules:

heading-blank-lines
header-increment
capitalize-headings titleCase=true

This time, a footnote text was added after I had executed the Linter plugin.

Here is the initial note:

Here is the modified one:

See the uploaded files in https://discord.com/channels/686053708261228577/722584061087842365/890900413547696139

I just started using Obsidian! I really like the mdlint package for VSCode that highlights errors in markdown without making changes. Would it be possible for a new feature that only checks on save rather than auto-fixes?

I haven't looked at the Plugin API, so I'm not sure how difficult it would be to display lint results (i.e. underline or highlight lines with errors then provide some sort of error message on hover). If too difficult, then that wouldn't be worth the effort

Hello, I got into an issue.

Expected

From

---
tags: #aaa/bbb/ccc
---

to

---
tags: aaa/bbb/ccc
---

Current Issues

Not working. It cannot be modified after being triggered.

Extras

nested tags: https://help.obsidian.md/Plugins/Tag+pane#Nested+tags

To accompany the lint file command

Terms such as acronyms are not handled properly. It seems hard to support every edge case.
The rule could only apply to lowercase words, and ignore other words. I think this should be an option.

Should be able to:

1. *: enable all rules with default options, in default order
2. ! to disable a rule
3. Adding a rule overrides it in * with the given options

Hello,

At present, when all documents of the whole vault are processed in batches, the Excalidraw documents in vault will be broken.

It might be a good choice to provide a filter option to skip the specific folders.

Thank you.

Nice plug-in!

How difficult is it to add new rules? One that will reformat headers to Capitalized would be great!

Hi @platers,
Thanks for the useful plugin!

I've noticed an issue for a while and wanted to bring it up. I've tried to rule out any other plugins that might affect it

• Test Vault with only the Linter Plugin enabled
• Blank line created between 1st & 2nd level list items (List item, To-do Item, etc.)
• All rules applied. I've disabled a few that looked like they might apply, but no luck

Here is a screen recording to display the issue

Let me know if I can be of any further assistance

I'm not sure if / how this would be possible but it would be great if the linter would respect the folded state of headers and list items. Currently if you lint a file with collapsed headers or list items, they are all expanded.

It also looks like linting the file bumps you out of any zoom level you are currently in with the Zoom plugin https://github.com/vslinko/obsidian-zoom. Not sure if this could be avoided as well.

Currently date created inserts the current time, it should look at the file metadata to get the created date.

Need to figure out a way to pass metadata to rules. Probably just pass in metadata as an option.

In the setting I toggled on header-increment rule. In a Kanban file where I only use H2 headings without a H1 heading, I wrote disabled rules: [ header-increment ]. But linting still turn H2 headings into H1s.

New rule, Insert YAML line, that inserts static lines into the yaml like tags:, aliases:.
Options: line: the line to insert.

Does nothing if line not specified.

Insert the file name as an H1 header if no H1 header exists.

Love this plugin! Personally, I would like the hour and minute in my YAML as well, so it would be nice if I could configure my own formatting the same way as in e.g. the daily notes plugin.

Cursor should stay on the line you are currently editing even if lines are deleted/inserted before.

Is there a specific order in which the rules are executed? Relevant for this point.

From your comment, I assume that it's the order in which they are listed by the user in the Linter settings, is that correct? Especially with increasing rule numbers, I think it might be worthy of consideration whether the order of rule execution is left to the user who might not factor in potential unintended effects or certain rule orders.

My suggestion would be to stipulate to execute rules in a specific order. This avoids undesired effects like for example running move-footnotes-to-the-bottom after the consecutive-blank-lines by an unsuspecting user.

Especially when using the "lint on save" setting, it is easily to accidentally lint a document that is not meant to be linted (e.g. templates or templater scripts, which annoyingly are still saved as .md ...).

May be setting to never lint certain files might make sense? This would prevent accidental linting. The Filename Header Sync Plugin has pretty much implemented this for files where headings should not be synced with the filename, I assume a bigger part of that code can be re-used.

I like using the Lint on save option but have habit of hitting ⌘S quite often and with the latest update that adds linting notifications I am seeing them a lot.

Regex's are showing limitations in dealing with all the edge cases of markdown syntax such as #75. A parser like https://github.com/remarkjs/ will be necessary to handle edge cases. remark also has a linter built in, so many rules can be replaced with remarks implementations.

• Problem: tags in the YAML Header aren't autocompleted.
• Solution: use hashtags
• Subsequent Problem: Hashtags in YAML Header are invalid and need to be removed

I am currently using this templater script for that, but I think that this would be a wonderfully useful rule to have until we get autocomplete in the YAML header.

<%*
//get file content
var noteContent = tp.file.content;

//remove hashtags from YAML
noteContent = noteContent.replace (/^tags: ((?:#\w+(?: |$))+)$/im, function (tagsYAML){
	return tagsYAML.replaceAll("#","").replaceAll(" ", ", ").replace("tags:,","tags:");
});

//select all in note, return regexed content, move cursor to the top
let cmEditorAct = this.app.workspace.activeLeaf.view.editor;
cmEditorAct.setSelection({ line: 0, ch: 0 }, { line: 9999, ch: 9999 });
tR = tp.file.cursor(0) + noteContent;
%>

The linter's "Lint on save" feature doesn't work for VIM "write" command that saves the file. Only for original save and Ctrl+S.

See the uploaded files here: https://discord.com/channels/686053708261228577/722584061087842365/890925403861024819

I think the pattern is that for every seven footnotes there is one additional footnote number.

One thing that can happen due to merging of notes is that you have duplicate YAML headers.

However, I am not totally certain how to deal with that – in some cases, it makes case just to keep the YAML at the very top, in other cases, one would want to "merge" the YAMLs maybe? Maybe set this with an option?

Both cases could be a little bit tricky to implement, considering that you have to distinguish two hr with text between them from a wrong-placed YAML.

The rule "Format Tags in YAML" doesn't handle tags in the front matter formatted like

Tags:

• #foo
• #Bar

Applying the linter does nothing. The expected results were

Tags:

• foo
• Bar

My use case for this is that I find this style of lists in YAML to be more legible and easier to edit or remove a tag. I suspect the reason I start with the # is similar to others, we want auto-complete help when assigning tags.

The links in the plugin description try to open a browser I think? doesn't work on win 10/11:

Problem. When the both rules are active and the current file has no H1, then after linting the document each header increments correctly but file-name-heading rule does not trigger at all.

Possible solution. Change the execution order for the two rules so that an H1 is added first by file-name-heading, and then other headers are incremented by header-increment.

Steps to reproduce

1. Create a note:

   ## Header 2.1
   
   ## Header 2.2
   
   ### Header 3.1
   

2. Apply header-increment and file-name-heading linting rules
3. Expected result:

   # Header 1
   
   ## Header 2.1
   
   ## Header 2.2
   
   ### Header 3.1
   

4. Actual result:

   # Header 2.1
   
   # Header 2.2
   
   ## Header 3.1
   

markdownlint is an existing semi-popular tool for markdown linting.
Using it provides you with more rules than this plugin. Rules that you can enforce outside of Obsidian, which makes people less dependent on the plugin and the rules more portable. It has a command line tool and a VSCode plugin among other things.

Without using markdownlint or consulting with existing plugin devs (Markdown prettifier, prettier) this is just another formatter with its own proprietary set of rules.

I think with the last few commits, the contribution threshold increased quite a bit. It took me a while, for example, to figure out how to set a non-boolean option, since there was no "IntegerOption" or something equivalent I could copy. Also the new ignore-codeblock-fuction thing also took me a moment to figure out.

And locally disabling eslint-rules (see #36) is another problem potential contributors might struggle with, especially since examples often need wrong formatting, since you need to figure out eslint rules to make contributions (and also figure out, that it is eslint rules that you have to look for).

A brief expansion of the contribution guide where these things are addressed might help?

Not sure whether this is something that fits with this plugin, but I think some reformatting of footnotes could also make sense. One example would to move all footnotes to the bottom after merging two or more notes, see also here. Another case could be the re-indexing of footnotes, which unfortunately, is not fully covered by the Tidy Footnotes Plugin.

For both cases, you could argue that they belong to some footnote plugin, or maybe to the longform plugin, but I think you could also make the case for those issues belonging to the linter. When you think they fit with the Linter, I could do a PR for it?

Since the date created uses the file creation date, it gets updated when the vault is cloned again.

This can be fixed by only changing date created if it doesn't exist yet. I dont see a way to fix date modified.

Testing exactly the rule from rules.ts at sites like regex101 or via a simple templater script, it does work as intended. When running tests with rules.ts, it also works.

But it does not seem to work in the linter. I assume it should therefore be sth related to the linter? :(

When editing Kanban files in markdown, the Linter changes break the Kanban format because they are converted from H2

Is it possible to add a regex like *Kanban* to skip certain files from lint on save? (manual linting should probably override this ignore rule)

In a file without YAML frontmatter, where there is still an ---, it is still treated as YAML hr, and compact-yaml is therefore (wrongly) applied.

As the Obsidian Documentation explicitly states that text is only treated as yaml when the triple dash at the very top of the document, I think that this should apply to compact-yaml (and other yaml-related rules) as well.

After I used the move-footnotes-to-the-bottom and re-index-footnotes, the number of the footnotes was added.

See the discussion on discord: https://discord.com/channels/686053708261228577/722584061087842365/889892608522997780

Problem: linting inserts a file title incorrectly.

Steps to reproduce:

1. Create a note with the following content

   Text 1
   
   ---
   
   Text 2
   
   

2. Apply file-name-heading linting rule

3. Expected result

   # Title
   
   Text 1
   
   ---
   
   Text 2
   
   

4. Actual (incorrect) result

   
   Text 1
   
   ---
   # Title
   
   Text 2
   
   

I believe this case should be added as an exception for documents with no YAML variables.