Skip to content

Commit bd219a9

Browse files
author
Quintin Willison
committed
Document our use of CodeNarc and improve the wording around Checkstyle.
1 parent 401adc6 commit bd219a9

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,14 +489,29 @@ The Android-specific library AAR is built with:
489489

490490
## Code Standard
491491

492-
We are introducing [Checkstyle](https://checkstyle.org/) to enforce code style and spot for transgressions and illogical constructs.
492+
### Checkstyle
493+
494+
We use [Checkstyle](https://checkstyle.org/) to enforce code style and spot for transgressions and illogical constructs
495+
in our Java source files.
493496
The Gradle build has been configured to run these on `java:assembleRelease`.
494497
It does not run for the Android build yet.
495498

496499
You can run just the Checkstyle rules on their own using:
497500

498501
./gradlew checkstyleMain
499502

503+
### CodeNarc
504+
505+
We use [CodeNarc](https://codenarc.org/) to enforce code style in our Gradle build scripts, which are all written in Groovy.
506+
507+
You can run CodeNarc over all build scripts in this repository using:
508+
509+
./gradlew checkWithCodenarc
510+
511+
For more details see the [`gradle-lint`](gradle-lint) project.
512+
513+
### IDE Support
514+
500515
We have a root [`.editorconfig`](.editorconfig) file, supporting [EditorConfig](https://editorconfig.org/), which should be of assistance within most IDEs. e.g.:
501516

502517
- [VS Code](https://code.visualstudio.com/) using the [EditorConfig plugin](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig)

0 commit comments

Comments
 (0)