Skip to content

Switch to an excellent code formatting and linting tool #347

@specious

Description

@specious

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementinfrastructureA point concerning the public instance or general infrastructure

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions