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

Integrade code formatting specifications into the GRNsight repo #882

Open
dondi opened this issue Oct 2, 2020 · 2 comments
Open

Integrade code formatting specifications into the GRNsight repo #882

dondi opened this issue Oct 2, 2020 · 2 comments

Comments

@dondi
Copy link
Owner

dondi commented Oct 2, 2020

The latest code formatters are getting better at formatting code in a reliable and consistent manner. Some implications in case we adopt this for GRNsight:

  1. We will want to configure the code formatter in a manner that use a style that the team agrees upon
  2. There will be a “formatting-only” transition phase where the code formatter may need to make a wide array of edits in order to sync up the code to the latest style

Formatter for consideration: https://prettier.io

@kdahlquist
Copy link
Collaborator

kdahlquist commented Feb 6, 2025

Set up repo so that independently of the code editor being used. Might need to reckon with 4 spaces of indenting vs new standard for javascript which is 2 spaces of indenting. Could be implemented in the GitHub Actions workflow.

@kdahlquist kdahlquist changed the title Consider adopting a late-generation code formatter for GRNsight Integrade code formatting specifications into the GRNsight repo Feb 6, 2025
@dondi
Copy link
Owner Author

dondi commented Feb 6, 2025

Prettier has established itself as the de facto code-formatter for many repos, so we will just go with that. We will need a .prettierrc file (or similar mechanism) on the repo, and make sure that our editors are configured to use it

If we change format, step (2) in the original description may still need to take place

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

No branches or pull requests

3 participants