Please see the EISOP Checker Framework manual (HTML, PDF).

The history of releases and changes is in file docs/CHANGELOG.md.

See below for EISOP Checker Framework development notes.

1. Clone this repository in some empty directory:

   git clone git@github.com:eisop/checker-framework.git
   cd checker-framework
   

2. Build the EISOP Checker Framework (requires JDK 8+):

   ./gradlew assemble
   

   This will clone the required eisop/jdk project to a sibling directory called jdk and build everything without running the test suite. There will be warnings about missing javadoc, but overall the build should be successful.

3. Run a simple test:

   ./checker/bin/javac -processor nullness docs/examples/NullnessExampleWithWarnings.java
   

   This will result in two errors:

   docs/examples/NullnessExampleWithWarnings.java:24: error: [assignment.type.incompatible] incompatible types in assignment.
        foo = bar;
              ^
     found   : @Nullable String
     required: @NonNull String
   docs/examples/NullnessExampleWithWarnings.java:34: error: [argument.type.incompatible] incompatible argument for parameter arg0 of List.add.
        foo.add(quux);
                ^
     found   : @Nullable String
     required: @NonNull String
   2 errors
   

There is a lot more to explore!

Please see the EISOP Checker Framework manual (HTML, PDF) to learn about all the different type systems, how to integrate them into your build system, and much more.

Developer notes are in docs/developer, including a Developer Manual.

Import the EISOP Checker Framework source folder into your IDE of choice. See the IDE configuration section for notes.

To run all test cases, run:

./gradlew alltests

There are many AI assistants that might help you navigate the source code, for example DeepWiki.

Contributions are always welcome! For guidelines, see the Contributing summary and the Contributing section in the manual.