Enforce file formatting across monorepo

[mmarchetti]

Had a spaces / tab mixing issue.

Formatting

• Prettier

[dotNomad]

Noting that ESLint v9.0.0 (which is currently in beta.1) will make the eslint.config.js configuration format the default. If we are setting up ESLint we should use this to avoid migration work.

Sources

• https://eslint.org/blog/2024/02/eslint-v9.0.0-beta.1-released/
• https://eslint.org/docs/next/use/migrate-to-9.0.0

[dotNomad]

Note that we cannot use ESLint v9 directly because the TypeScript @typescript-eslint/eslint-plug will not work with v9 just yet, but can use the configuration format.

[dotNomad]

Formatting using ESLint is not recommended according to their blog: https://eslint.org/blog/2023/10/deprecating-formatting-rules/#what-you-should-do-instead

We recommend using a source code formatter instead of ESLint for formatting your code. Source code formatters are built to understand the entire file and apply consistent formatting throughout. While you might not have as much control over exceptions as with ESLint, the tradeoff is the simplicity and speed you’ll get vs. configuring ESLint with dozens of individual rules. There are two formatters that we recommend:

• Prettier - a JavaScript-based formatter with support for formatting a large number of languages
• dprint - a Rust-based formatter with support for a smaller set of languages

[dotNomad]

Looking into this further ESLint and and typescript-eslint support the new flat config format, but the two other plugins we are using: eslint-plugin-cypress and eslint-plugin-vue do not yet.

It looks like the Cypress plugin may not get support, it is unclear. That does inform us that we have to use the current format, and migrate when our dependencies allow us to or reconsider when the RC file format is deprecated by ESLint.

References

• Upgrade to new ESLint Flat configuration files cypress-io/eslint-plugin-cypress#146
• Eliminate the need for an internal & public ESLint package cypress-io/cypress#24251
• Support for "Flat Config" vuejs/eslint-plugin-vue#1291

[dotNomad]

Ran into a weird CI run that cached files that caused formatting checking to fail on some OSes and not others. As part of this work we should re-visit our CI to ensure that linting and formatting checks run once, before the heavy jobs, and not per OS.

[dotNomad]

Updating this issue to represent the formatting work that was accomplished in Alpha 5.