Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gaul/modernizer-maven-plugin
Detect uses of legacy Java APIs
https://github.com/gaul/modernizer-maven-plugin
apache-commons guava java joda-time maven-plugin static-analysis
Last synced: about 1 month ago
JSON representation
Detect uses of legacy Java APIs
- Host: GitHub
- URL: https://github.com/gaul/modernizer-maven-plugin
- Owner: gaul
- License: apache-2.0
- Created: 2014-09-18T00:06:51.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T05:02:59.000Z (2 months ago)
- Last Synced: 2024-07-24T16:15:23.473Z (about 2 months ago)
- Topics: apache-commons, guava, java, joda-time, maven-plugin, static-analysis
- Language: Java
- Homepage:
- Size: 781 KB
- Stars: 367
- Watchers: 17
- Forks: 53
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - Modernizer - Detect uses of legacy Java APIs. (Projects / Miscellaneous)
README
Modernizer Maven Plugin
=======================
[](https://search.maven.org/#search%7Cga%7C1%7Ca%3A%22modernizer-maven-plugin%22)
Modernizer Maven Plugin detects uses of legacy APIs which modern Java versions
supersede.
These modern APIs are often more performant, safer, and idiomatic than the
legacy equivalents.
For example, Modernizer can detect uses of `Vector` instead of `ArrayList`,
`String.getBytes(String)` instead of `String.getBytes(Charset)`, and
Guava `Objects.equal` instead of Java 7 `Objects.equals`.
The default configuration detects
[over 200 legacy APIs](https://github.com/gaul/modernizer-maven-plugin/blob/master/modernizer-maven-plugin/src/main/resources/modernizer.xml),
including third-party libraries like
[Apache Commons](https://commons.apache.org/),
[Guava](https://github.com/google/guava),
and [Joda-Time](https://www.joda.org/joda-time/).
Configuration
-------------
To run Modernizer, add the following to the `` stanza in your pom.xml
then invoke `mvn modernizer:modernizer`:
```xml
org.gaul
modernizer-maven-plugin
2.7.0
8
```
The `` stanza can contain several elements:
* `` enables violations based on target Java version, e.g., 8. For example, Modernizer will detect uses of `Vector` as violations when targeting Java 1.2 but not when targeting Java 1.1. Required parameter.
* `` fail phase if Modernizer detects any violations. Defaults to true.
* `` run Modernizer on test classes. Defaults to true.
* `` user-specified violation file. Also disables standard violation checks. Can point to classpath using absolute paths, e.g. `classpath:/your/file.xml`.
* `` user-specified violations file. The latter files override violations from the former ones, including `violationsFile` and the default violations. Can point to classpath using absolute paths, e.g. `classpath:/your/file.xml`.
* `` disables user-specified violations. This is a text file with one exclusion per line in the javap format: `java/lang/String.getBytes:(Ljava/lang/String;)[B`. Empty lines and lines starting with `#` are ignored.
* `` violations to disable. Each exclusion should be in the javap format: `java/lang/String.getBytes:(Ljava/lang/String;)[B`.
* `` violation patterns to disable, specified using `` child elements. Each exclusion should be a regular expression that matches the javap format: `java/lang/.*` of a violation.
* `` package prefixes to ignore, specified using `` child elements. Specifying `foo.bar` subsequently ignores `foo.bar.*`, `foo.bar.baz.*` and so on.
* `` full qualified class names (incl. package) to ignore, specified using `` child elements. Each exclusion should be a regular expression that matches a package and/or class; the package will be / not . separated (ASM's format).
* `` classes annotated with an annotation whose retention policy is runtime or class and whose simple name contain "Generated" will be ignored. (Note: both [javax.annotation.Generated](https://docs.oracle.com/javase/8/docs/api/javax/annotation/Generated.html) and [javax.annotation.processing.Generated](https://docs.oracle.com/en/java/javase/11/docs/api/java.compiler/javax/annotation/processing/Generated.html) have [retention policy](https://docs.oracle.com/javase/8/docs/api/index.html?java/lang/annotation/RetentionPolicy.html) SOURCE (aka discarded by compiler).)
To run Modernizer during the verify phase of your build, add the following to
the modernizer `` stanza in your pom.xml:
```xml
modernizer
verify
modernizer
```
Command-line flags can override Modernizer configuration and
[ModernizerMojo](https://github.com/gaul/modernizer-maven-plugin/blob/master/modernizer-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/ModernizerMojo.java)
documents all of these. The most commonly used flags:
* `-Dmodernizer.failOnViolations` - fail phase if violations detected, defaults to true
* `-Dmodernizer.skip` - skip plugin execution, defaults to false
### Output Formats
The plugin can output Modernizer violations in one of many formats which can be configured with the ``
stanza using ``.
The currently supported formats and their respective configuration options are outlined below:
* `CONSOLE` List each violation using Maven's logger. This is the **default** format.
* `` Specify the log level of the logger: `error`, `warn`, `info` or `debug`.
Default is `error`.
* `CODE_CLIMATE` Write the violations according to [Code Climate's Spec](https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md).
GitLab uses this format for its code quality as shown [here](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool).
* `` The full path the file to output to. Default is `${project.build.directory}/code-quality.json`
* `` Severity of Modernizer violations for CodeClimate: `INFO`, `MINOR`, `MAJOR`, `CRITICAL` or `BLOCKER`.
Default is `MINOR`.
Ignoring elements
-----------------
Code can suppress violations within a class or method via an annotation. First
add the following dependency to your `pom.xml`:
```xml
org.gaul
modernizer-maven-annotations
2.7.0
```
Then add `@SuppressModernizer` to the element to ignore:
```java
import org.gaul.modernizer_maven_annotations.SuppressModernizer;
public class Example {
@SuppressModernizer
public static void method() { ... }
}
```
References
----------
* [ASM](https://asm.ow2.org/) provides Java bytecode introspection which enables Modernizer's checks
* [Checkstyle](https://checkstyle.org/) IllegalInstantiation and Regexp checks can mimic some of Modernizer's functionality
* [Google Error Prone](https://errorprone.info/) JdkObsolete can mimic some of Modernizer's functionality
* [Gradle Modernizer Plugin](https://github.com/andygoossens/gradle-modernizer-plugin) provides a Gradle interface to Modernizer
* `javac -Xlint:deprecated` detects uses of interfaces with @Deprecated annotations
* [Overstock.com library-detectors](https://github.com/overstock/library-detectors) detects uses of interfaces with @Beta annotations
* [Policeman's Forbidden API Checker](https://github.com/policeman-tools/forbidden-apis) provides similar functionality to Modernizer
License
-------
Copyright (C) 2014-2022 Andrew Gaul
Licensed under the Apache License, Version 2.0