search

diggsweden / open-source-project-template

Open Source project helper and getting started template(s)
Creative Commons Zero v1.0 Universal
18 stars 4 forks source link

Linter does not cover ASCIIdoc files #13

Open ericherman opened 9 months ago

ericherman commented 9 months ago

Contact Details

eric@publiccode.net

What happened?

Several files are .adoc, however these files are not covered by the linter

Steps To Reproduce

Look at the MegaLinter config.

What did you expect?

I expected all docs to be covered.

Version

No response

Optional Screenshots

No response

Relevant log output

No response

janderssonse commented 9 months ago

Had a brief look around, I guess we will have to wait for a real solution to this one, as the AsciiDoc-people are busy finishing their specification, and only then it will be possible to create a real linter it is a long featured request. https://github.com/asciidoctor/asciidoctor-extensions-lab/issues/6.

However the author of asciidoc in the same mentions vale as a half-measure (it will lint the html-output of asciidoc) https://github.com/vshn/vale. And combining that with the proposal here, (just run asciidoctor in the docs https://stackoverflow.com/questions/73556861/basic-asciidoc-linter) I think we would get as good as linting we can get currently.. That is, if that take works satisfactory.

ericherman commented 9 months ago

Use a "half-measure" as an incremental step is still progress. I recommend adding something about the trajectory of it on the roadmap.