Linting

[lukem12345]

We should add some linting rules to this and other AJ repos. Possible rules include:

• 2-space indentation
• Consistent naming conventions for schemas (Sch...)
• Docstrings for exported functions and objects
• Examples in such docstrings where applicable
• Scheme and Lisp style trailing parentheses (on the last line) rather than C-style (closing braces on following lines)

[quffaro]

There is a julia-action called julia-format that looks promising!

It uses JuliaFormatter, which offers OOTB:

• two-space indentation, set ident=2

does not offer OOTB:

• consistent naming conventions for schemas
• docstrings for exported functions and objects
• examples in docstrings
• scheme/lisp style trailing parentheses

However the Custom Styles page suggests that it is possible to overload style functions to enforce these patterns.

The julia-format action either creates changes in the code or creates PRs (noisy, but safe; no direct changes to code). Should we add it to our github actions?

The roadmap for implementation:

• implementing AlgebraicJulia-wide style into the .github repo
• investigating if we can include repo specific styles (e.g., "Consistent naming conventions for schemas")

[lukem12345]

We should also see what rules from the official AJ style guide that would be easy to mechanize.