-
Notifications
You must be signed in to change notification settings - Fork 0
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
Install & Configure Prettier #708
Open
Bianca-Morris
wants to merge
16
commits into
master
Choose a base branch
from
bm-prettier-config
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bianca-Morris
requested review from
utku-ozturk,
alexander-veit and
dmichaels-harvard
April 12, 2023 13:31
Bianca-Morris
requested review from
crfmc
and removed request for
utku-ozturk and
dmichaels-harvard
July 10, 2023 15:31
crfmc
approved these changes
Aug 1, 2023
This reverts commit 8660282.
… bm-prettier-config
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelog:
prettier
,prettier-eslint-cli
,eslint-plugin-prettier
andeslint-config-prettier
as dev dependencies.prettierrc.json
and.prettierignore
files.eslintrc.json
to force compatibility with prettierpackage.json
repo-wide (with exceptions as specified in.prettierignore
)Related Trello Ticket:
https://trello.com/c/c9hxum2W/749-add-prettier-to-cgap-and-do-bulk-re-format-of-js-jsx-code
Deployment Notes:
This package addition mostly impacts the developer experience, so I'm not deploying anywhere. I ask that reviewers test the branch locally according to the notes below, and leave comments if they run into issues.
Testing Notes:
You MUST do
npm install
for this to work.It's possible that the eslint server in vscode won't update the rules in
.prettierrc.json
after pulling this code (leading to a bunch of red squiggilies across files). If you restart vscode, it'll restart the server and the new rules will be applied. Alternatively, you can run eslint through the terminal to see that the new rules are applied.In order to get full use of Prettier's auto-formatting capabilities, you'll need to install and enable the Prettier extension in your IDE of choice. For VSCode, it'll end up looking something like this:
.vscode/settings.json
file at the root of thecgap-portal
repo and add this to it:Note: you can also make these changes globally by editing settings via the vscode GUI.
If you use a different IDE/code editor, let me know and I can see about testing with that editor, too.
Merging notes:
Currently looking into a bunch of different ways to merge this without destroying our git history:
If you have opinions on methods for doing this, or other thoughts, let me know.