Differential D3639 Diff 16481 ps/trunk/build/arclint/README.md

Changeset View

Standalone View

Property	Old Value	New Value
svn:eol-style	null	native \ No newline at end of property

				# Linting

				This folder 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.