Schema

Linter & Autocomplete

The best option of linter for now is YAML Language Support by Red Hat.

They have extensions for the most famous code editors:

To configure the LSP, you must specify a JSON schema that we provide:

https://github.com/henriqueleite42/anvil/cli/blob/master/schemas/domain/v1.0.0.json

Heres an example of how to configure it in VSCode and Zed, at the begging of your .anv file, add this:

# yaml-language-server: $schema=https://github.com/henriqueleite42/anvil/cli/blob/master/schemas/domain/v1.0.0.json

danger

Be sure to replace the schema version to the latest version.

Domain: Name of the domain being documented
Types: Generic types to be used as Input or Output for Repository and Usecase methods
Enums: Enums to be used as types for Entity, Events and Repository and Usecase methods
Entities: Tables on your database
Repository: The way that you communicate with the tables on your database
Events: Events emitted by this domain
Usecase: Where all the business logic stays, has the methods to be used by the consumers through delivery methods
Delivery: General config for delivery methods

Low: Can be accessed by anyone with access to the service, can be logged and send in events
Medium: Can only be accessed by services with special permission, cannot be logged or send in events
High: Can only be accessed inside the domain, cannot be accessed by other services, logged or send in events