https://github.com/vshaxe/vscode-checkstyle
Haxe Checkstyle extension for Visual Studio Code
https://github.com/vshaxe/vscode-checkstyle
checkstyle code-style haxe static-analysis vscode vscode-extension
Last synced: 3 months ago
JSON representation
Haxe Checkstyle extension for Visual Studio Code
- Host: GitHub
- URL: https://github.com/vshaxe/vscode-checkstyle
- Owner: vshaxe
- License: mit
- Created: 2016-05-03T12:26:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-22T14:06:27.000Z (almost 3 years ago)
- Last Synced: 2025-09-18T13:20:57.966Z (3 months ago)
- Topics: checkstyle, code-style, haxe, static-analysis, vscode, vscode-extension
- Language: Haxe
- Homepage: http://haxecheckstyle.github.io/docs/haxe-checkstyle/home.html
- Size: 467 KB
- Stars: 28
- Watchers: 6
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Haxe Checkstyle for Visual Studio Code
[](https://github.com/vshaxe/vscode-checkstyle/actions?query=workflow%3ACI)
[](https://marketplace.visualstudio.com/items?itemName=vshaxe.haxe-checkstyle)
[](https://marketplace.visualstudio.com/items?itemName=vshaxe.haxe-checkstyle)
## Features
* Runs haxe-checkstyle when opening and saving documents
* Displays results as VS Code diagnostics
* Supports quickfixes for a small selection of checks
* Includes json schema definitions for both `checkstyle.json` and `checkstyle-excludes.json`
* Uses [haxe-checkstyle](https://github.com/HaxeCheckstyle/haxe-checkstyle) engine
* Works with your existing haxe-checkstyle configuration
## Configuration
A configuration key named `haxecheckstyle.sourceFolders` holds an array of folder names where checkstyle should run. It defaults to `["src", "Source"]`, which is the equivalent to passing `-s -s ` to haxe-checkstyle CLI. Checkstyle will ignore any file not included in `sourceFolders`.
vscode-checkstyle accepts your regular haxe-checkstyle configuration files (`checkstyle.json` and `checkstyle-excludes.json`).
Unlike the CLI version vscode-checkstyle will search a file's path for a `checkstyle.json` configuration that is closest to it. Searching moves upwards and stops at (but includes) your workspace root.
That way you can have a library folder inside your workspace provide its own `checkstyle.json` (which might be different from your personal coding style).
If there is no `checkstyle.json` in any folders up to your workspace root, vscode-checkstyle tries to learn its location by reading key `haxecheckstyle.configurationFile` from your VS Code settings.
`haxecheckstyle.codeSimilarityBufferSize` sets a limit to how many files will be kept for CodeSimilarity check (Defaults to 100).
## Quickfixes
You can apply quickfixes one at a time or by selecting a range including multiple checkstyle violations.
The following checks provide quickfixes:
* Dynamic
* EmptyPackage
* Final
* Indentation
* ModifierOrder
* RedundantModifier
* StringLiteral
* Trace
* UnusedImport
## JSON Schema Definitions
vscode-checkstyle comes with JSON schemas for `checkstyle.json` and `checkstyle-excludes.json`, which will help you through autocomplete and tooltips when editing both file types. e.g.:
## Documentation
See [Haxe-Checkstyle docs](http://haxecheckstyle.github.io/docs) or use JSON Schema tooltips for documentation on checks.
## Limitations
* it doesn't see violations in your project files until you open them
* CodeSimilarity check uses a ringbuffer to limit the number of files in similarity cache (configure via `haxecheckstyle.codeSimilarityBufferSize` - defaults to 100)
## TODO
* Check on all the workspace
* And more :)