platers / obsidian-linter

An Obsidian plugin that formats and styles your notes with a focus on configurability and extensibility.
https://platers.github.io/obsidian-linter/
MIT License
1.21k stars 82 forks source link

FR: Add Lint Reminder to File in Obsidian #128

Open sampokantola opened 2 years ago

sampokantola commented 2 years ago

Add indicator to show if note has been edited after last lint

With autosave, there's no natural point when to run the linter, making it easy to forget. This leads to eg. inaccurate "last modified" time stamps on files.

Description: Once an edit has been made since the previous time running the linter, display an indicator to act as a visual reminder to run it.

This could be similar to the "unsaved edits" -indicators seen in many programs, like the *-symbol prepended to the window title in Paint.NET, Notepad++, MS Notepad, etc; or the dot/circle in VSCode that's shown next to file and folder names.

I suggest adding indicators to:

Especially in the file explorer, the indicator could be a unique symbol or letter, perhaps L for Lint (this would be somewhat descriptive and potentially leave room for other plugins to add their own letters/symbols for similar purposes). Perhaps also change the color of the filenames. This would be similar to the git status indicators and colors (decorations) in VSCode.

sampokantola commented 2 years ago

Additional suggestion: Add an automatically appearing button to run the linter on mobile more easily

Interpause commented 2 years ago

bumping this feature request

pjkaufman commented 2 years ago

Additional suggestion: Add an automatically appearing button to run the linter on mobile more easily

I think you can do this by adding the lint file command to the mobile toolbar. Is that not the case for you?

sampokantola commented 2 years ago

Additional suggestion: Add an automatically appearing button to run the linter on mobile more easily

I think you can do this by adding the lint file command to the mobile toolbar. Is that not the case for you?

Good point; forgot about the toolbar while making that comment

sampokantola commented 2 years ago

I imagine the way to do the note title indicator might be to add a css class to the note, and make the visual change with css?

(I'm slightly more aware of the constraints of the API now. I'm guessing the file explorer indicators might not be so easy to implement? I don't think they're that important.)

pjkaufman commented 2 years ago

I think the indicator may be feasible, but I will have to see what all that would entail. But that would have to come after what is currently in the queue. For the Linter Roadmap.