phosit/0ad
1
0
Fork 0
forked from 0ad/0ad
Code Pull Requests Activity
more_promises
0ad/build/arclint
History
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
..
configs Update eslintrc.json to allow for class properties in JavaScript. 2024-05-10 10:10:49 +00:00
dummies Remove unnecessary executable bits 2024-08-26 07:46:34 +02:00
pyrolint Add hook for non-breaking space in 0 A.D. 2024-08-24 13:08:42 +02:00
LICENCE.txt Lint update: use arclint, remove JSHint, remove coala on CI. 2021-03-15 15:14:28 +00:00
README.md Add a markdownlint pre-commit hook 2024-08-27 10:06:31 +02:00

README.md

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.