Skip to content

1.0-M01 - Release "Anders Nawroth"

Compare
Choose a tag to compare
@fbiville fbiville released this 17 Jun 20:01
· 83 commits to master since this release

Anders Nawroth

Neo4j manual has been the first Living Documentation example I ever encountered, before I even heard of the term.

Most (if not all) of Neo4j manual quality is due to Anders Nawroth work. I did not know Anders personally, although his work has inspired me a lot in general and for this project, in particular.

The best documentation is the one that is readable to the target audience and the easiest/cheapest to maintain by its authors.

Where is the best documentation you can get as a developer from? The one that comes from the compiler!

neo4j-sproc-compiler is a compile-time annotation processor that implements exhaustive checks on @org.neo4j.procedure.Procedure and @org.neo4j.procedure.Context usage.

The main advantage is that most of the checks are now caught immediately (rather than being checked by custom integration tests or Neo4j runtime)!

neo4j-sproc-compiler implements the following controls:

  • [#1][#12] Check that procedure declared parameter types are supported
  • Check that the declared return type is a java.util.stream.Stream
  • [#2][#13] Check that declared record field types are supported and public
  • [#3] Check that procedure class fields annotated with @Context are public, nonstatic and nonfinal
  • [#4] Check that the processed packages do not contain duplicate procedure names

🔥 1.0-M01 is on Maven Central, grab it while it is hot 🔥
📖 README.md will help you set everything up 📖