Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A formatter/linter and style guide #10

Open
eliassjogreen opened this issue Mar 19, 2022 · 0 comments
Open

A formatter/linter and style guide #10

eliassjogreen opened this issue Mar 19, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@eliassjogreen
Copy link
Member

eliassjogreen commented Mar 19, 2022

A simple formatter and linter, like clippy using the whistle lexer, parser and AST would be nice to have. In my opinion it should be opinionated, and be able to also only check for formatting errors instead of always fixing them. Along with the formatter we should also provide a standard style guide.

Here's my proposal for a minimal style guide we can start with:

  • 2 spaces instead of tabs
  • snake_case for everything but types which should be PascalCase
  • docs should always start with ///
@eliassjogreen eliassjogreen added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 19, 2022
@eliassjogreen eliassjogreen changed the title A formatter and style guide A formatter/linter and style guide Mar 19, 2022
@eliassjogreen eliassjogreen added this to the Release of 0.1.0 milestone Mar 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant