Differential D4313 Diff 19279 build/arclint/README.md

Changeset View

Standalone View

build/arclint/README.md

	# Linting			# Linting

	This folder tools for linting 0 A.D. code			This folder contains tools for linting 0!A.D. code
				FreagarachUnsubmitted Not Done Inline Actions ^? Freagarach: ^?
				bbAuthorUnsubmitted Done Inline Actions Missing in rP25056 bb: Missing in rP25056
				FreagarachUnsubmitted Not Done Inline Actions Also a non-breaking space in 0 A.D.? Freagarach: Also a non-breaking space in 0 A.D.?
	Linting is done via Arcanist: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/			Linting is done via Arcanist: https://secure.phabricator.com/book/phabricator/article/arcanist_lint/

	## Linters			## Linters

	- `text` is configured to detect whitespace issues.			- `text` is configured to detect whitespace issues.
	- `json` detects JSON syntax errors.			- `json` detects JSON syntax errors.
				- `project-name` detects misspellings of the project name "0!A.D.". In particular the non-breaking space.
	- `licence-year` detects Copyright header years and compares against modification time.			- `licence-year` detects Copyright header years and compares against modification time.
	- `eslint`, if installed, will run on javascript files.			- `eslint`, if installed, will run on javascript files.
	- `cppcheck`, if installed, will run on C++ files.			- `cppcheck`, if installed, will run on C++ files.


	## Installation			## Installation

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