@codacy/tools-checkstyle-13 0.22.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Codacy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+# @codacy/tools-checkstyle-13
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Updating patterns](#updating-patterns)
+- [Updating the Checkstyle version](#updating-the-checkstyle-version)
+- [Development](#development)
+- [Notes for maintainers](#notes-for-maintainers)
+
+---
+
+## Overview
+
+Java style checker and static analysis tool using the [Checkstyle](https://checkstyle.org) fat JAR. Uses the CLI execution strategy -- spawns `java -jar checkstyle-all.jar` via `spawnTool()` and parses its XML output.
+
+| Property      | Value                                  |
+| ------------- | -------------------------------------- |
+| Tool ID       | `Checkstyle`                           |
+| Codacy UUID   | `f4a54ce0-1fe1-4bc7-a9ed-9f91f675c409` |
+| Strategy      | CLI                                    |
+| Languages     | Java                                   |
+| Binary        | `java -jar checkstyle-13.9.0-all.jar`  |
+| File patterns | `**/*.java`                            |
+
+## Updating patterns
+
+```bash
+# Re-fetch pattern metadata from the Codacy API
+pnpm prefetch
+
+# Commit the result
+git add src/patterns.json
+```
+
+Pattern IDs follow the format `Checkstyle_AvoidStarImport`, `Checkstyle_WhitespaceAround`, etc. The check name is extracted from the FQCN source attribute (e.g. `com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck` becomes `AvoidStarImport`).
+
+## Updating the Checkstyle version
+
+1. Update `CHECKSTYLE_VERSION` in `src/adapter.ts`
+2. Update `JAR_NAME` and `JAR_URL` constants accordingly
+3. Run `pnpm prefetch` to check for new/removed rules
+4. Run `pnpm test` to verify compatibility
+5. If the major version changes, create a new adapter package (`checkstyle-11/`)
+
+## Development
+
+```bash
+pnpm build    # Build with tsup
+pnpm test     # Run tests (requires java in PATH + JAR in tools dir)
+```
+
+To install the Checkstyle JAR locally for testing:
+
+```bash
+mkdir -p /tmp/codacy-checkstyle-test-tools
+curl -L -o /tmp/codacy-checkstyle-test-tools/checkstyle-13.9.0-all.jar \
+  https://github.com/checkstyle/checkstyle/releases/download/checkstyle-13.9.0/checkstyle-13.9.0-all.jar
+```
+
+## Notes for maintainers
+
+- Checkstyle requires Java 11+ as a runtime. The adapter uses `ensureJre()` to download Adoptium Temurin JDK 21 if no system Java is found.
+- The fat JAR is downloaded from GitHub releases via `downloadJar()` to `~/.codacy/tools/checkstyle-13/`.
+- Exit code 0 = no violations, >0 = violations found (parse XML), negative = error.
+- XML output is on stdout (unlike cppcheck which uses stderr).
+- `error/@source` is an FQCN like `com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck`. The adapter strips the package prefix and `Check` suffix to derive the check name.
+- `error/@column` may be absent; defaults to 1 when missing.
+- Line/column numbers in Checkstyle XML are already 1-based; no conversion needed.
+- Some modules (Header, FileLength, LineLength, etc.) are global and must be placed under `<module name="Checker">` rather than inside `<module name="TreeWalker">`. The adapter handles this split when generating config from patterns.
+- Config file detection looks for `checkstyle.xml` in the repository root.
+- When no local config and no patterns are specified, the adapter uses Checkstyle's built-in `sun_checks.xml`.
+- Checkstyle prints `Starting audit...` and `Audit done.` to stderr; these are filtered out from the error output.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as _codacy_tooling from '@codacy/tooling';
+
+declare const _default: Readonly<_codacy_tooling.ToolAdapter>;
+
+export { _default as default };