paczek/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Activity
main
0ad/build/arclint/README.md
Dunedan ae3fad73ce
Add a markdownlint pre-commit hook 
This adds a pre-commit hook to link Markdown files and fixes all
reported findings.
2024-08-27 10:06:31 +02:00

1.3 KiB
Raw Permalink Blame History

Linting

This folder contains tools for linting 0 A.D. code Linting is done via Arcanist: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/

Linters

  • text is configured to detect whitespace issues.
  • json detects JSON syntax errors.
  • licence-year detects Copyright header years and compares against modification time.
  • eslint, if installed, will run on javascript files.
  • cppcheck, if installed, will run on C++ files.

Installation

This assumes you have arcanist already installed. If not, consult https://trac.wildfiregames.com/wiki/Phabricator#UsingArcanist .

The linting is done via custom PHP scripts, residing in pyrolint/. Configuration is at the root of the project, under .arclint.

Installing linters

We provide dummy replacement for external linters, so that they are not required.

eslint

Installation via npm is recommended. The linter assumes a global installation of both eslint and the "brace-rules" plugin.

npm install -g eslint@latest eslint-plugin-brace-rules`

See also https://eslint.org/docs/user-guide/getting-started

cppcheck

Cppcheck is available on various package managers, including HomeBrew on macOS. An installer is available on windows. See http://cppcheck.sourceforge.net for details.