https://github.com/basepom/basepom-policy

Minimum policy files for the basepoms
https://github.com/basepom/basepom-policy

Last synced: 11 months ago
JSON representation

Minimum policy files for the basepoms

• Host: GitHub
• URL: https://github.com/basepom/basepom-policy
• Owner: basepom
• Created: 2013-12-20T03:10:13.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2024-09-15T00:11:01.000Z (almost 2 years ago)
• Last Synced: 2024-09-16T06:36:25.002Z (almost 2 years ago)
• Language: Java
• Homepage:
• Size: 166 KB
• Stars: 3
• Watchers: 3
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md

Awesome Lists containing this project

README

          
[![CI Build with tests](https://github.com/basepom/basepom-policy/actions/workflows/ci.yml/badge.svg)](https://github.com/basepom/basepom-policy/actions/workflows/ci.yml) [![Latest Release](https://maven-badges.herokuapp.com/maven-central/org.basepom/basepom-policy/badge.svg?style=flat)](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.basepom%22%20AND%20a%3A%22basepom-policy%22)

# basepom-policy - A minimal policy jar for BasePOM

This is a policy jar that contains configuration and code

## Checker configuration

### checkstyle

Defines a very minimal code style:

- Do not check any generated sources (in `/generated-sources/` folders)

- Support Warning suppression with Annotations and comments (`SuppressWarningsFilter`, `SuppressWithNearbyCommentFilter`)

- require newline at end of file (`NewlineAtEndOfFile`)

- no spaces at end of line (`RegexpSingleline`)

- no hard tabs (`FileTabCharacter`)

- no wildcard imports (`AvoidStartImports`)

- no redundant imports (`AvoidRedundantImports`)

- java modifiers in JLS order (`ModifierOrder`)

- no dangeling statements for if()..., for()..., while()... (`NeedBraces`)

- no lowercase 'L' for long constants. (`UpperEll`)

### spotbugs

- suppress `THROWS_METHOD_THROWS_RUNTIMEEXCEPTION`, `THROWS_METHOD_THROWS_CLAUSE_THROWABLE` and `THROWS_METHOD_THROWS_CLAUSE_BASIC_EXCEPTION`; those were added in version 4.7 of spotbugs and cause a lot of noise in existing code bases that use this policy jar.

### license

- Add Apache license header without copyright line.

### shade

- contains the `CollectingManifestResourceTransformer`. It collects all the additional sections in shaded jars and includes them in the final fat jar.

----