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

New rule: Detect syntax errors in code examples #6

Open
jfmengels opened this issue Sep 10, 2020 · 0 comments
Open

New rule: Detect syntax errors in code examples #6

jfmengels opened this issue Sep 10, 2020 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jfmengels
Copy link
Owner

jfmengels commented Sep 10, 2020

What the rule should do:

Detect syntax errors in code examples in module rules and in the README.

What problems does it solve:

If you don't use `elm-verify-examples, you have no way to know if your examples are correct. Checking that they are syntactically correct is a reasonable simple check.

I think it can be done relatively simple by using elm-syntax to parse the example.

Example of things the rule would report:

Any syntax error in code examples.

Maybe it would allow simple expressions? Behind a configuration maybe?

When (not) to enable this rule:

I am looking for:

  • A good rule name. NoSyntaxErrorInExample?
  • Someone to implement it (I can provide help and guidance)
@jfmengels jfmengels added help wanted Extra attention is needed good first issue Good for newcomers labels Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant