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

chore/formatting workspace with prettier #1382

Merged
merged 11 commits into from
Feb 7, 2025

Conversation

thescientist13
Copy link
Member

@thescientist13 thescientist13 commented Jan 13, 2025

Related Issue

N / A

Documentation

N / A

Summary of Changes

  1. Add Prettier and format the entire project
  2. Add formatting check to GitHub Actions

TODO

  1. Getting syntax errors that mostly can be fixed, however not for certain cases where are intentionally trying to break formatting, e.g. HUD test cases
  2. Apply formatting to entire project
  3. Add to GitHub Action(s)
  4. Add pre-commit hooks for linting and format checking only
  5. Document formatting in Contributing workflow

Question

  1. Use pre-commit hooks?

@thescientist13 thescientist13 added question Further information is requested chore unit testing, maintenance, etc alpha.5 v0.31.0 and removed alpha.5 labels Jan 13, 2025
@thescientist13 thescientist13 changed the title chore/formatting with prettier chore/formatting workspace with prettier Jan 13, 2025
@thescientist13 thescientist13 force-pushed the chore/prettier-formatting branch from 424f54b to 0fc6bd5 Compare February 2, 2025 20:43
@thescientist13 thescientist13 marked this pull request as ready for review February 2, 2025 20:58
Copy link
Member Author

@thescientist13 thescientist13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested feedback is to run lint and npm run format:check on pre-commit hooks to allow the contributor to doctor it up before finalizing their commit.

In the CONTRIBUTING.md we can call out the scripts to run that would also run in CI so they can double check.

@thescientist13 thescientist13 removed the question Further information is requested label Feb 7, 2025
@thescientist13 thescientist13 force-pushed the chore/prettier-formatting branch from 0fc6bd5 to efacfa1 Compare February 7, 2025 20:38
@thescientist13 thescientist13 self-assigned this Feb 7, 2025
@thescientist13 thescientist13 merged commit f22a261 into master Feb 7, 2025
10 checks passed
@thescientist13 thescientist13 deleted the chore/prettier-formatting branch February 7, 2025 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore unit testing, maintenance, etc
Projects
Development

Successfully merging this pull request may close these issues.

1 participant