jossmoff / chickpea

🫘 Chickpea is an extension of the Java Bean Validation Specification providing useful annotations for common validation formats

Chickpea

Extension of the Java Bean Validation Specification providing useful annotations for common validation formats.

🥳 Creating new @Annotation

The best way to getting started with creating a new annotation for chickpea is to use the create_new_annotation.py script. This does require python3, but following the prompts when running:

  python scripts/create_new_annotation.py

You can create the base files for a new annotation! Below is an example of the script in action:

python script/create_new_annotation.py 
🫘 Annotation name: MyNewAnnotation
🫘 Package offset from dev.joss.chickpea.constraints (e.g. str, aws, or something new): new.package
🫘 Author name: Your Name Here
🥳 Successfully Created @MyNewAnnotation