Enforce coding style rules
Configure the coding style rules to align with the rules defined by the Antora project. (See https://gitlab.com/antora/antora-direct/issues/5).
Acceptance criteria:
-
Add the library (or libraries) needed to enforce coding style rules -
Configure ESLint to apply StandardJS to JavaScript files -
Add prettier -
Evaluate whether to activate CSSLintstylelint
-
-
Add an .eslintrc rule file to tunes coding style rules according to Antora conventions -
Add an .editorconfig file that provides formatting hints to the text editor / IDE -
Add a task to the Gulp build that enforces the coding style rules when the project is built -
The build should fail if there are violations -
Only needs to run when the pack task is called (so as not to slow down development)
-
-
Document the coding style policy in contributing.adoc (namely that a MR cannot have any violations)
Edited by Dan Allen