Skip to content

Add Eclipse Checkstyle auto-configuration #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+31 −1
Draft

Add Eclipse Checkstyle auto-configuration #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d10e13f
Initial plan
Copilot Feb 1, 2026
737aa4b
Add Eclipse Checkstyle configuration for automatic pickup
Copilot Feb 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .checkstyle
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">
<local-check-config name="HtmlUnit CSP Checkstyle" location="checkstyle.xml" type="project" description="HtmlUnit CSP Checkstyle Configuration">
<property name="checkstyle.suppressions.file" value="${project_loc}/checkstyle_suppressions.xml"/>
<additional-data name="protect-config-file" value="false"/>
</local-check-config>
<fileset name="all" enabled="true" check-config-name="HtmlUnit CSP Checkstyle" local="true">
<file-match-pattern match-pattern="^src/.*\.java$" include-pattern="true"/>
</fileset>
<filter name="NonSrcDirs" enabled="true"/>
</fileset-config>
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/target/
/.checkstyle
/.classpath
/.project
/.settings/
Expand Down
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,26 @@ Open a command line window from the root folder of the project and call
mvn compile
```

### Eclipse IDE Setup

To work with this project in Eclipse:

1. Install the **Eclipse Checkstyle Plugin** from the Eclipse Marketplace (Help > Eclipse Marketplace)
- Search for "Checkstyle Plug-in" and install it

2. Import the project as a Maven project:
- File > Import > Maven > Existing Maven Projects
- Select the repository root directory
- Click Finish

3. The Checkstyle configuration will be automatically picked up from the `.checkstyle` file in the repository root
- The configuration uses `checkstyle.xml` and `checkstyle_suppressions.xml` from the project
- All Java files under `src/` will be checked automatically

4. To verify Checkstyle is working:
- Right-click the project > Properties > Checkstyle
- You should see "HtmlUnit CSP Checkstyle" as the active configuration

### Running the tests

```
Expand Down