chore: format all files

[mdjermanovic]

This PR:

• Checks in formatted versions of all files in the repo (I ran npm run fmt) so that unrelated formatting changes no longer appear in PRs.
• Adds Verify Files CI job that checks if all files are lint-free (eslint) and properly formatted (prettier).
• Adds a lint-staged task to format non-js files.

Question: I assumed we want to format all files that prettier knows to handle. Are there some files we'd like to ignore or format differently? I only ignored CHANGELOG.md files because those are autogenerated.

[mdjermanovic]

Prettier runs on all files, but separate "*.js" and "!(*.js)" tasks are needed to make sure that eslint runs before prettier on .js files.

https://github.com/lint-staged/lint-staged?tab=readme-ov-file#task-concurrency

[harish-sethuraman]

this should rather be fmt:fix and the check should be fmt?

[mdjermanovic]

Formatting is currently not covered by our package-json-conventions.

@nzakas what do you think about script names?

[harish-sethuraman]

I'd suggest lets keep the script name to be format for analysing formatting problems. and format:fix for the write formatted changes. I can send a PR to add it to package conventions as well.

[mdjermanovic]

format & format:fix would be aligned with lint & lint:fix, which looks good for consistency, but in the context of the word "format" it might be surprising that format only checks the format, so maybe format:check & format:fix?

[mdjermanovic]

Since this PR has a high potential of running into merge conflicts with any future PRs, what do you think about merging this now as-is, and continuing this discussion on a PR that updates package conventions? Then, we could get back to this repo and update the script names if needed.

[harish-sethuraman]

Yea lets merge this PR and then pick this as a separate issue.

[harish-sethuraman]

prettier uses tabs by default? Seems like too much space from the existing one?

[mdjermanovic]

Yes, tabs are default in Prettier. - wrong

This is only 1 tab, but GitHub by default renders tabs as 8 spaces so it looks huge.

[mdjermanovic]

GitHub by default renders tabs as 8 spaces

It's configurable:

https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference

I've just changed my Tab size preference to 4 and this looks the same as before on my screen:

[mdjermanovic]

Actually, prettier's default indentation is 2 spaces. But we configured it in this project to use tabs:

rewrite/prettier.config.js

Line 2 in 3e9eb67

useTabs: true,

[nzakas]

Question: I assumed we want to format all files that prettier knows to handle. Are there some files we'd like to ignore or format differently?

I think just CHANGELOG.md we should leave alone. Otherwise, I'm 👍 to formatting everything. We can always adjust later if we don't like something.

[nzakas]

LGTM. Just leaving open until @harish-sethuraman's questions are answered.

[harish-sethuraman]

LGTM