uber / NullAway / #615
93%

DEFAULT BRANCH: master
Ran
Jobs 1
Files 47
Run time 6s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
#615

push

github-actions

web-flow 
Adds custom Nullable Annotation via Error Prone CLI flags (#522)

This PR adds the ability to configure additional custom `@Nullable/@Nonnull` annotations.

In particular, this adds the following configuration options to NullAway:

```
-XepOpt:NullAway:CustomNullableAnnotations=[...]
-XepOpt:NullAway:CustomNonnullAnnotations=[...]
```

Each of these options takes a comma-separated list of fully qualified annotation names, which NullAway should regard as nullable and non-null annotations (respectively), in *addition* to those it looks for by default. Neither configuration option is required when all relevant nullability annotations follow the conventions NullAway already expects (e.g. simple name `@Nullable` or `@NonNull` or any of our default supported annotations such as `@CheckForNull`).

During auto-annotation testing, we have encountered a few projects which are partially annotated with nullability annotations with different simple names than the conventional `@Nullable` or `@NonNull` (and recognized variations, such as `@NotNull`). For example, [LibGdx](https://github.com/libgdx/libgdx) uses [@com.badlogic.gdx.utils.Null](https://github.com/libgdx/libgdx/blob/master/gdx/src/com/badlogic/gdx/utils/Null.java). This is a custom nullability annotation which lives within the project itself and doesn't use the `@Nullable` simple name convention. Rather than explicitly encoding every such annotation in existence into our defaults, this PR allows supporting such cases with a simple configuration change.

3608 of 4040 relevant lines covered (89.31%)

0.89 hits per line

Uncovered Existing Lines

Lines Coverage ∆ File
3
95.59
 0.13% src/main/java/com/uber/nullaway/ErrorProneCLIFlagsConfig.java
5
92.42
 0.24% src/main/java/com/uber/nullaway/AbstractConfig.java
6
6.67
 -0.48% src/main/java/com/uber/nullaway/DummyOptionsConfig.java
Jobs
ID Job ID Ran Files Coverage
1 #615.1 47
89.31
Source Files on build #615