SearXNG JavaScript Style Guide #538
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dalf
reviewed
Nov 23, 2021
return42
changed the title
|
FYI: in commit 4c159f7 I added the SearXNG JavaScript Style Guide as one quality gate in the build chain. This ensures that we have a consistent quality of JS sources (simple theme), similar to what we do with pylint for python. See github CI: https://github.com/searxng/searxng/runs/4326586917?check_suite_focus=true#step:5:461 |
|
@dalf what do you think, can we force this "SearXNG JavaScript Style Guide"? If so I will rebase this PR. |
we can merge this PR once rebased, and indent with 2 spaces are fine. |
In JS + JSON we use indentation of 4. Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
The SearXNG JavaScript Style Guide is a set of eslint rules [1] based on the
eslint:recommended [2] rules.
"extends": "eslint:recommended"
The additional rules adopted from the JavaScript Standard Style [3][4].
[1] https://eslint.org/docs/rules/
[2] https://github.com/kunalgolani/eslint-config/tree/master/packages/recommended
[3] https://standardjs.com/rules.html#javascript-standard-style
[4] https://github.com/standard/eslint-config-standard/blob/master/.eslintrc.json
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
automatically fix some of the problems reported by eslint rules::
$ ./manage nvm.bash
nvm-env$ npm --prefix searx/static/themes/simple run eslint-fix
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Add the 'SearXNG JavaScript Style Guide' as one quality gate in the build chain
of the simple theme::
make themes.simple
make themes.simple.test
In the github CI the `themes.all` target enforce a `themes.simple`.
BTW: Remove 'jshint' left overs from 0ee316f
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
done .. thanks for taking the time to review! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Define a SearXNG JavaScript Style Guide
The SearXNG JavaScript Style Guide is a set of eslint rules [1] based on the
eslint:recommended [2] rules.
The additional rules adopted from the JavaScript Standard Style [3][4].
[1] https://eslint.org/docs/rules/
[2] https://github.com/kunalgolani/eslint-config/tree/master/packages/recommended
[3] https://standardjs.com/rules.html#javascript-standard-style
[4] https://github.com/standard/eslint-config-standard/blob/master/.eslintrc.json
The first three commits do fix small issues in preparation
Why is this change important?
consistent code quality