@codacy/tools-scalastyle-1 0.3.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,82 @@
+# @codacy/tools-scalastyle-1
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Updating patterns](#updating-patterns)
+- [Updating the Scalastyle version](#updating-the-scalastyle-version)
+- [Development](#development)
+- [Notes for maintainers](#notes-for-maintainers)
+
+---
+
+## Overview
+
+Scala style checker and static analysis tool using the [Scalastyle](http://www.scalastyle.org/) assembly JAR. Uses the CLI execution strategy -- spawns `java -cp scalastyle.jar org.scalastyle.Main` via `spawnTool()` and parses its Checkstyle-format XML output.
+
+| Property      | Value                                         |
+| ------------- | --------------------------------------------- |
+| Tool ID       | `ScalaStyle`                                  |
+| Codacy UUID   | `21586cd3-3eaa-4454-878e-ac0211a833c2`        |
+| Strategy      | CLI                                           |
+| Languages     | Scala                                         |
+| Binary        | `java -cp scalastyle.jar org.scalastyle.Main` |
+| File patterns | `**/*.scala`                                  |
+| Pattern count | 74                                            |
+
+Scalastyle is primarily a Scala 2 tool. It parses Scala source files and checks for style violations, complexity issues, and potential bugs. The assembly JAR is hosted on Maven Central.
+
+## 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 `ScalaStyle_MagicNumberChecker`, `ScalaStyle_FileLengthChecker`, etc. Note the capital S in `ScalaStyle` and that the `Checker` suffix is retained (unlike Checkstyle which strips `Check`).
+
+## Updating the Scalastyle version
+
+1. Update `SCALASTYLE_VERSION` in `src/adapter.ts`
+2. Update `JAR_URL` to point to the new assembly JAR on Maven Central
+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 (`scalastyle-2/`)
+
+The Maven Central artifact coordinates are:
+
+```
+com.beautiful-scala:scalastyle_2.13:{version}:assembly
+```
+
+## Development
+
+```bash
+pnpm build    # Build with tsup
+pnpm test     # Run tests (unit tests always run; integration tests require java + JAR)
+```
+
+To install the Scalastyle JAR locally for integration testing:
+
+```bash
+mkdir -p /tmp/codacy-scalastyle-test-tools
+curl -L -o /tmp/codacy-scalastyle-test-tools/scalastyle.jar \
+  https://repo1.maven.org/maven2/com/beautiful-scala/scalastyle_2.13/1.5.1/scalastyle_2.13-1.5.1-assembly.jar
+```
+
+## Notes for maintainers
+
+- Scalastyle requires Java 8+ as a runtime. The adapter uses `ensureJre()` to download Adoptium Temurin JDK 17 if no system Java is found.
+- The assembly JAR (~9 MB) is downloaded from Maven Central via `downloadJar()` to `~/.codacy/tools/scalastyle-1/`.
+- Scalastyle takes **directories** as input, not individual file lists. The adapter passes the repository root and then filters the XML output by `ctx.targetFiles`.
+- XML output is written to a temp file via `--xmlOutput`, not to stdout. The adapter reads and parses the temp file after execution.
+- The `source` attribute in XML output is an FQCN like `org.scalastyle.scalariform.MagicNumberChecker`. The adapter extracts the last segment to derive the pattern ID.
+- Checker namespace mapping: checkers in the static `FILE_LEVEL_CHECKERS` set map to `org.scalastyle.file.*`; all others map to `org.scalastyle.scalariform.*`.
+- Exit code 0 = clean, 1 = findings found or error. The adapter reads the XML output regardless of exit code (0 or 1).
+- Config file detection looks for `scalastyle_config.xml` or `scalastyle-config.xml` in the repository root (underscore variant preferred).
+- When generating config from patterns, each check is emitted with `level="warning"` and includes default parameters from `patterns.json`.
+- The `column` attribute may be absent in Scalastyle output; it is omitted from the issue when not present.
+- `fast-xml-parser` is configured with `ignoreAttributes: false` and `isArray` for `file`/`error` elements to handle single-element cases.

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 };