Uploaded image for project: 'Docs for Red Hat Developers'
  1. Docs for Red Hat Developers
  2. RHDEVDOCS-1526

Linters for Eclipse Che / CRW

XMLWordPrintable

      Analysis on linter usage for Eclipse Che / CRW and more generally for devtools projects.

      Discussion started here: https://docs.google.com/document/d/1QZYnbsKknXAowqS1HvPjDy6QfR8r7FIbThhJoxsU4Vc/edit#heading=h.o0tyd6xjzn4x

      Tools to consider:

      1. test-adoc.sh - see https://github.com/jhradilek/check-links
      2. Emender - see https://github.com/emender/emender
      3. Vale - see https://github.com/errata-ai/vale/ https://github.com/testthedocs/vale-styles https://github.com/testthedocs/vscode-vale/
      4. Proselint - https://github.com/amperser/proselint/

      Some preliminary implementation: https://gitlab.cee.redhat.com/ffloreth/red-hat-devtools/tree/vale

      Some toughts after 2 hours of investigations:

      • test-adoc.sh works out of the box and points out all structural mistakes in the docs (missing _context in ids, etc.). It is definitively the first tool to implement and enforce everywhere for low hanging fruits.
      • proselint very easy to implement and works out of the box, but is it as confirgrable as vale and emender?
      • emender and vale need some initial configuration files before first usage
      • nice community effort to implement code styles for various environments: the IBM styleguide here one day? https://github.com/testthedocs/vale-styles

              ffloreth@redhat.com Fabrice Flore-Thébault
              ffloreth@redhat.com Fabrice Flore-Thébault
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: