Skip to content

Standardize/enforce code formatting on the project #2012

Closed

Description

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)
Details ~Set up [pre-commit](https://pre-commit.com/) and some [hooks](https://pre-commit.com/hooks.html) for anything which runs quickly:~

.. etc.

Activity

  1. DonJayamanne commented on Jun 20, 2018

    @DonJayamanne
  2. DonJayamanne commented on Jun 20, 2018

    @DonJayamanne
  3. brettcannon commented on Jun 20, 2018

    @brettcannon
    Author
  4. DonJayamanne commented on Jul 13, 2018

    @DonJayamanne
  5. brettcannon commented on Jul 13, 2018

    @brettcannon
    Author
  6. d3r3kk commented on Jul 14, 2018

    @d3r3kk
  7. brettcannon commented on Jul 16, 2018

    @brettcannon
    Author
  8. changed the title [-]Use pre-commit for formatters[/-] [+]Standardize/enforce code formatting on the project[/+] on Jul 16, 2018
  9. DonJayamanne commented on Jul 16, 2018

    @DonJayamanne
  10. DonJayamanne commented on Oct 19, 2018

    @DonJayamanne
  11. 2 remaining items

  12. added
    metaIssue that is tracking an overall project
    and removed
    needs proposalNeed to make some design decisions
    on Jul 9, 2019
  13. locked as resolved and limited conversation to collaborators on Feb 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

area-editor-*User-facing catch-alldebtCode quality issuesgood first issueimportantIssue identified as high-prioritymetaIssue that is tracking an overall project

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions