forked from mirrors/gecko-dev
48271d5db0
Differential Revision: https://phabricator.services.mozilla.com/D63543 --HG-- extra : moz-landing-system : lando
149 lines
2.7 KiB
ReStructuredText
149 lines
2.7 KiB
ReStructuredText
Code quality
|
|
============
|
|
|
|
Because Firefox is a complex piece of software, a lot of tools are
|
|
executed to identify issues at development phase.
|
|
In this document, we try to list these all tools.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:glob:
|
|
|
|
static-analysis.rst
|
|
lint/index.rst
|
|
coding-style/index.rst
|
|
|
|
.. list-table:: C/C++
|
|
:widths: 25 25 25 20
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - Custom clang checker
|
|
-
|
|
- `Source <https://searchfox.org/mozilla-central/source/build/clang-plugin>`_
|
|
-
|
|
* - Clang-Tidy
|
|
- Yes
|
|
- :ref:`Static analysis <Mach static analysis>`
|
|
- https://clang.llvm.org/extra/clang-tidy/checks/list.html
|
|
* - Clang analyzer
|
|
-
|
|
-
|
|
- https://clang-analyzer.llvm.org/
|
|
* - Coverity
|
|
-
|
|
-
|
|
-
|
|
* - cpp virtual final
|
|
-
|
|
- :ref:`cpp virtual final`
|
|
-
|
|
* - Semmle/LGTM
|
|
-
|
|
-
|
|
-
|
|
* - clang-format
|
|
- Yes
|
|
- :ref:`Formatting C++ Code With clang-format`
|
|
- https://clang.llvm.org/docs/ClangFormat.html
|
|
|
|
.. list-table:: JavaScript
|
|
:widths: 25 25 25 25
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - Eslint
|
|
- Yes
|
|
- :ref:`ESLint`
|
|
- https://eslint.org/
|
|
* - Mozilla ESLint
|
|
-
|
|
- :ref:`Mozilla ESLint Plugin`
|
|
-
|
|
* - Prettier
|
|
- Yes
|
|
- :ref:`JavaScript Coding style`
|
|
- https://prettier.io/
|
|
|
|
|
|
|
|
.. list-table:: Python
|
|
:widths: 25 25 25 25
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - Flake8
|
|
- Yes (with `autopep8 <https://github.com/hhatto/autopep8>`_)
|
|
- :ref:`Flake8`
|
|
- http://flake8.pycqa.org/
|
|
* - Python 2/3 compatibility check
|
|
-
|
|
- :ref:`Python 2/3 compatibility check`
|
|
-
|
|
|
|
|
|
.. list-table:: Rust
|
|
:widths: 25 25 25 25
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - Rustfmt
|
|
- Yes
|
|
- :ref:`Rustfmt`
|
|
- https://github.com/rust-lang/rustfmt
|
|
* - Clippy
|
|
-
|
|
- :ref:`clippy`
|
|
- https://github.com/rust-lang/rust-clippy
|
|
|
|
.. list-table:: Java
|
|
:widths: 25 25 25 25
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - Infer
|
|
-
|
|
-
|
|
- https://github.com/facebook/infer
|
|
|
|
.. list-table:: Others
|
|
:widths: 25 25 25 25
|
|
:header-rows: 1
|
|
|
|
* - Tools
|
|
- Has autofixes
|
|
- More info
|
|
- Upstream
|
|
* - shellcheck
|
|
-
|
|
-
|
|
- https://www.shellcheck.net/
|
|
* - rstchecker
|
|
-
|
|
- :ref:`RST Linter`
|
|
- https://github.com/myint/rstcheck
|
|
* - Typo detection
|
|
- Yes
|
|
- :ref:`Codespell`
|
|
- https://github.com/codespell-project/codespell
|
|
* - YAML linter
|
|
-
|
|
-
|
|
- https://github.com/adrienverge/yamllint
|
|
|