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.17k stars 81 forks source link

FR: add a CLI version of this linter #987

Open tnthi115 opened 8 months ago

tnthi115 commented 8 months ago

Is Your Feature Request Related to a Problem? Please Describe.

Currently there is no way to run the obsidian-linter outside of Obsidian.

Describe the Solution You'd Like

I would like a CLI version of the linter that can be used as such:

obsidian-linter temp.md

temp.md would then be linted as per usual.

As an example, see mdformat.

This would provide lots of flexibility in how we are able to format our files. For my specific use case, I would like to run obsidian-linter as a formatter in Neovim.

Please include an example where applicable:

N/A

Describe Alternatives You've Considered

N/A

Additional Context

Examples of Markdown formatters:

Using formatters in Neovim:

pjkaufman commented 8 months ago

Hey @tnthi115 , is this request just to make obsidian Linter available to run from the CLI or is it asking that it also have NeoVim support added? I want to clarify to make sure I understand the scope of this request.

My feelings on the matter are that a Go or Rust version of Linter would work better since it would actually be more performant for CLI usage. But that is just me as a developer talking.

tnthi115 commented 8 months ago

Hi @pjkaufman, I apologize for any confusion. I am just requesting Obsidian Linter to be made available to run from the CLI. This would enable my ultimate goal of using it from within Neovim, but Neovim is unrelated to this request.

A Go or Rust version seems like a good choice!