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

Standardize/enforce code formatting on the project #2012

Closed
10 of 14 tasks
brettcannon opened this issue Jun 20, 2018 · 9 comments
Closed
10 of 14 tasks

Standardize/enforce code formatting on the project #2012

brettcannon opened this issue Jun 20, 2018 · 9 comments
Assignees
Labels
area-editor-* User-facing catch-all debt Covers everything internal: CI, testing, refactoring of the codebase, etc. good first issue important Issue identified as high-priority meta Issue that is tracking an overall project

Comments

@brettcannon
Copy link
Member

brettcannon commented Jun 20, 2018

Prescribed Solution:

  • Format all of the extension code
    • Python (using black)
    • js, jsx, ts, tsx, json, css, less, sass (using prettier)
  • Format on commit
  • Format on save (user settings, opt in using)
    • Use prettier extension
    • Use python extension with black
  • Recommend prettier extension in .vscode/extensions.json
    • Use prettier extension
    • Use python extension with black
  • Prettier Config settings
    • Prettier rc config (editor agnostic, also picked by CI)
    • .vscode/settings
  • CI check for all pipelines (black & prettier)
    • PR pipeline
    • CI Pipeline
  • Update contributing guide
  • Configure prettier to use tslint (ensure this works on CI)
    • TIP - Look for prettier plugins (plenty good ones)
~Set up [pre-commit](https://pre-commit.com/) and some [hooks](https://pre-commit.com/hooks.html) for anything which runs quickly:~

.. etc.

@brettcannon brettcannon added debt Covers everything internal: CI, testing, refactoring of the codebase, etc. feature-* labels Jun 20, 2018
@DonJayamanne

This comment has been minimized.

@DonJayamanne

This comment has been minimized.

@brettcannon

This comment has been minimized.

@DonJayamanne

This comment has been minimized.

@brettcannon

This comment has been minimized.

@d3r3kk

This comment has been minimized.

@brettcannon

This comment has been minimized.

@brettcannon brettcannon changed the title Use pre-commit for formatters Standardize/enforce code formatting on the project Jul 16, 2018
@DonJayamanne

This comment has been minimized.

@brettcannon brettcannon added the needs proposal Need to make some design decisions label Sep 24, 2018
@DonJayamanne

This comment has been minimized.

@kimadeline kimadeline self-assigned this Jan 22, 2020
@karthiknadig karthiknadig self-assigned this Jan 30, 2020
@ghost ghost removed the needs PR label Jan 30, 2020
@lock lock bot locked as resolved and limited conversation to collaborators Feb 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-editor-* User-facing catch-all debt Covers everything internal: CI, testing, refactoring of the codebase, etc. good first issue important Issue identified as high-priority meta Issue that is tracking an overall project
Projects
None yet
Development

No branches or pull requests

7 participants