| <!--- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| # Name |
| |
| checkstyle |
| |
| ## Category |
| |
| Test |
| |
| ## Description |
| |
| [checkstyle](https://checkstyle.sourceforge.net/) is a style linter for Java and many Java-adjacent languages. This plugin requires |
| support from the [Build Tool](../../buildtools) in order to work correctly. At present, support for `ant`, `maven`, and `gradle` are |
| built-in. |
| |
| ## Environment Variables |
| |
| None |
| |
| ## Options |
| |
| | Option | Notes | |
| | :------------------------- | :----------------------------------------------------------------------------- | |
| | `--checkstyle-goal=<goal>` | Choose between `check` or `checkstyle` Maven goals. Defaults to `checkstyle`. | |
| |
| ## Docker Notes |
| |
| None |
| |
| ## Developer Notes |
| |
| None |
