Giter VIP home page Giter VIP logo

spotbugs-jspecify-plugin's Introduction

SpotBugs

Build Status Documentation Status Coverage Status Maven Central Javadocs

SpotBugs is the spiritual successor of FindBugs, carrying on from the point where it left off with support of its community.

SpotBugs is licensed under the GNU LESSER GENERAL PUBLIC LICENSE.

More information at the official website. A lot of things can still be found at the old FindBugs website.

Build

SpotBugs is built using Gradle. The recommended way to obtain it is to simply run the gradlew (or gradlew.bat) wrapper, which will automatically download and run the correct version as needed (using the settings in gradle/wrapper/gradle-wrapper.properties).

Building SpotBugs requires JDK 21 to run all the tests (using SpotBugs requires JDK 8 or above).

To see a list of build options, run gradle tasks (or gradlew tasks). The build task will perform a full build and test.

To build the SpotBugs plugin for Eclipse, you'll need to create the file eclipsePlugin/local.properties, containing a property eclipseRoot.dir that points to an Eclipse installation's root directory (see .github/workflows/release.yml for an example), then run the build. To prepare Eclipse environment only, run ./gradlew eclipse. See also detailed steps.

Using SpotBugs

SpotBugs can be used standalone and through several integrations, including:

Questions?

You can contact us using GitHub Discussions.

spotbugs-jspecify-plugin's People

Contributors

dependabot[bot] avatar kengotoda avatar

Stargazers

avatar avatar

Watchers

avatar avatar avatar avatar

spotbugs-jspecify-plugin's Issues

memo

Basic Implementation

  • An EngineRegistrar that implements IAnalysisEngineRegistrar and specified in /FindbugsPlugin/EngineRegistrar of findbugs.xml
    • see FindBugs2#registerPluginAnalysisEngines() that registers analysis engine in plugin
  • An DatabaseFactory that implements IDatabaseFactory and calls databaseFactory.registerWith(analysisCache) in #registerAnalysisEngines(IAnalysisCache)
  • An Database that is accessible via analysisCache#getDatabase(Class), and stores nullness info (module, package, class, field and other types) on memory
  • Detectors to report potential problems based on the data in database
  • (optional) build data in batch for class files in classpath (not aux classpath) before the analysis

Document how to use spotbugs-jspecify-plugin

Hi,

I don't understand how to use spotbugs-jspecify-plugin instead of standard spotbugs-maven-plugin or spotbugs-gradle-
plugin.
Now I use jspecify instead of dormant jsr-305 and it should be very useful to use it in spotbugs.
Can you document it how to do it, please?
I'm not sure why it is not integrate in spotbugs-maven-plugin or spotbugs-gradle-
plugin and there is a need to have another plugin.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.