Skip to content
This repository was archived by the owner on Dec 23, 2021. It is now read-only.

Using a formatter and editing linting/formatting rules - #176

Merged
Kevin Nguyen (xnkevinnguyen) merged 5 commits into
devfrom
users/t-vali/formatting-linting
Jan 24, 2020
Merged

Kevin Nguyen (xnkevinnguyen) merged 5 commits into
devfrom
users/t-vali/formatting-linting

Conversation

@vandyliu

Copy link
Copy Markdown
Contributor

Description:

Using a formatter to make our code look more clean: prettier for typescript and black for python. The code stylings were quite inconsistent and there were many linting errors (and still are), but hopefully using formatters can help us with our code quality. Also, the formatting checks will be added to CI if this is merged. All the src code files that are changed were changed by the formatters.

New commands:
npm run lint
npm run check
npm run format

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

Testing:

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B
  • Manual tests

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

@isadorasophia Isa (isadorasophia) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I would just suggest adding the commands for formatting in the documentation.

@vandyliu
Vandy Liu (vandyliu) deleted the users/t-vali/formatting-linting branch January 24, 2020 18:13
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants