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

Apply Prettier formatting #1593

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Apply Prettier formatting #1593

wants to merge 4 commits into from

Conversation

akx
Copy link

@akx akx commented Jan 27, 2025

What kind of change does this PR introduce?

  • Bugfix of sorts.

Even if Prettier had technically been configured for the repo, it was never enforced, so various contributions had caused the repo to drift from Prettier style.

This PR:

  • adds prettier --check to the GitHub Actions CI workflow
  • adjusts the prettier settings so files in sub-subdirectories are properly formatted too, while ignoring (for the time being anyway) some files that would have made the diff here >10k lines.
  • reformats files using prettier --write.

If this PR is merged, the resulting commit hash should probably be added to .git-blame-ignore-revs.

Refs #1587, 6603d6a.

Checklist:

  • Unit Tests
    • Yes, in that CI now actually enforces Prettier style
  • Documentation (N/A)
  • Update CHANGELOG.md (N/A)
  • Ready to be merged

@akx akx marked this pull request as draft January 27, 2025 09:20
@akx akx force-pushed the apply-prettier branch 2 times, most recently from c934648 to 1fe0f7e Compare January 27, 2025 09:25
@akx akx marked this pull request as ready for review January 27, 2025 09:27
@blikblum
Copy link
Member

Please remove the examples folder. Prettier makes harder to understand some code there

@akx
Copy link
Author

akx commented Jan 28, 2025

Please remove the examples folder. Prettier makes harder to understand some code there

Yeah, I see what you mean with the chained calls. I added a commit that peppers // prettier-ignore comments around them (as had been done with other code elsewhere).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants