Skip to content

README.md

Latest commit

 

History

History
28 lines (21 loc) · 1.05 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.05 KB

Arc Lint

Arc Lint is used in Freelancer to provide a consistent linting experience across different repositories.

Usage

Config

Navigate to the project root directory and update .arclint to update lint rules.

Run

Navigate to the project root directory and run:

arc lint

Development

Adding a New Linter

Linters act as adapters between the linting engine and the actual linting tool. They invoke the linting tool and parse the results into a format that Arcanist can understand. To add a new linter, follow these steps:

  1. Create a New Linter Class:
  • Add a class that extends ArcanistLinter in the src/lint/linter directory.
  1. Add Unit Tests:
  • Write unit tests for the new linter in the src/lint/__tests__/ directory.
  1. Generate Library Map:
  • Run arc liberate to generate the src/__phutil_library_map__.php file.
  1. Bump flarc version (recommended):
  • Update the flarc version a new version. see README.md.