razziel89 / mdslw

Prepare your markdown for easy diff'ing!
GNU General Public License v3.0
14 stars 1 forks source link

Provide more details about diff #19

Closed razziel89 closed 2 months ago

razziel89 commented 4 months ago

In case a file differs from the desired state, it could be useful to provide more information about the deviation. That way, mdslw could possibly even serve as a linter that could be hooked into a general purpose language server such as efm-langserver. The similar crate could be used to compute a diff. Since such a computation can be costly, it should only be done if explicitly requested.

realJohnDoe commented 3 months ago

I also noticed that some more output would be helpful regarding the specific file and line that caused a failure.

razziel89 commented 2 months ago

The recently added --report flag lets users request varying degrees of detail about the actions done by mdslw. There is also a set of options that cause the computation of diffs. That information can be used to determine which changes mdslw has done or would do. Since mdslw is an auto-formatter and not a linter, that is considered sufficient. Closing.

Comments on this issue discussing the above are welcome.