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

Switch to an excellent code formatting and linting tool #347

Open
specious opened this issue Aug 3, 2022 · 1 comment
Open

Switch to an excellent code formatting and linting tool #347

specious opened this issue Aug 3, 2022 · 1 comment
Labels
enhancement infrastructure A point concerning the public instance or general infrastructure

Comments

@specious
Copy link
Collaborator

specious commented Aug 3, 2022

Currently, prettier is being used to validate and normalize the formatting of both code and data.

It's got several issues:

  • When checking the format, it doesn't give any specific information about what is wrong with the content
  • It runs very slow and requires a lot of memory (node heap size must be increased for large files)
  • It's strongly opinionated and by its default behavior creates strange formatting results which are not configurable

You can see how slow the validation is by looking at a github workflow run or by running npm run check-data.

When a file has any issues that cause it not to pass validation, it simply prints:

[warn] Code style issues found in the above file. Forgot to run Prettier?

An efficient formatting tool that doesn't do any deep analysis of the content should be able to check or streamline a file of any length in a single pass with minimal memory overhead.

It makes sense to look at the available options and to evaluate them.

@specious specious added enhancement infrastructure A point concerning the public instance or general infrastructure labels Aug 3, 2022
@specious
Copy link
Collaborator Author

specious commented Aug 3, 2022

Perhaps #65 and #66 are related issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement infrastructure A point concerning the public instance or general infrastructure
Projects
None yet
Development

No branches or pull requests

1 participant