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

Add vscode settings + format on commit #872

Merged
merged 6 commits into from May 14, 2024
Merged

Conversation

annarhughes
Copy link
Member

What changes did you make?

Added vscode settings for autoformatting code on save. Added pre-commit/husky setup to run prettier formatter on commit. This should be working as a pre-commit action but husky is adding the changes after the commit is pushed. This means a second commit can then be pushed for lint changes.

Why did you make the changes?

To keep code formatting in sync

Copy link

vercel bot commented Apr 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
bloom-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 13, 2024 10:14am

@kyleecodes
Copy link
Member

kyleecodes commented Apr 10, 2024

Nice @annarhughes!
Two things:

  • Can you add documentation for how this behaves in the README? No worries about perfect phrasing & formatting, a basic explanation is fine. I'll edit after.
  • You mentioned this requiring VSCode. Can we document how these settings could be removed for use with other IDEs? VSCode is by far the most popular, but I'd be concerned about excluding Jetbrains which is the second leading IDE.

@kyleecodes kyleecodes self-assigned this May 9, 2024
@annarhughes
Copy link
Member Author

@kyleecodes I've added notes to the readme now! Ah and it's not that VSCode is required for this to work, it's that we have extra settings/automation for formatting and linting on VSCode. Developers using alternative IDE's should be able to replicate or follow the settings on their IDE

@annarhughes annarhughes merged commit 0eb0665 into develop May 14, 2024
5 checks passed
@annarhughes annarhughes deleted the pre-commit-lint-format branch May 14, 2024 20:15
@cypress cypress bot mentioned this pull request May 14, 2024
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.

None yet

2 participants