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

(maint) Set syntax and format style guidelines #745

Merged
merged 1 commit into from
Aug 31, 2021
Merged

Conversation

jpogran
Copy link
Contributor

@jpogran jpogran commented Aug 27, 2021

Update eslint and prettier packages and add style and format guidelines to editorconfig and VS Code worskpace settings file.

This aligns to company standards for code style and formatting and ensures consistent spacing, line endings, and file encodings. This does not enable any new eslint rules, as that is out of scope for this line of work.

This also configures VS Code to use prettier and eslint for all typescript, javascript and json formatting and use eslint and prettier to enforce guidelines.

@jpogran jpogran marked this pull request as ready for review August 27, 2021 16:21
@jpogran jpogran force-pushed the m-style-guide branch 2 times, most recently from 5a73d95 to 3b10c91 Compare August 27, 2021 19:06
Update eslint and prettier packages and add style and format guidelines to editorconfig and VS Code worskpace settings file.

This aligns to company standards for code style and formatting and ensures consistent spacing, line endings, and file encodings. This does not enable any new eslint rules, as that is out of scope for this line of work.

This also configures VS Code to use prettier and eslint for all typescript, javascript and json formatting and use eslint and prettier to enforce guidelines.
@jpogran jpogran requested a review from ansgarm August 30, 2021 20:10
@jpogran jpogran self-assigned this Aug 30, 2021
Copy link
Member

@ansgarm ansgarm left a comment

Choose a reason for hiding this comment

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

For the CDK for Terraform we chosed to use the Prettier defaults without any adjustments to leave discussions about preferred code style to those working on Prettier.

I personally am happy with most things as long as they're consistent in the codebase, so me mentioning this is more of a sidenote 😄 If you e.g. like ' more than " go for it – you will have to read that code daily 😄

@jpogran
Copy link
Contributor Author

jpogran commented Aug 31, 2021

Thanks @ansgarm for the review!

@jpogran jpogran merged commit 6a1ab93 into main Aug 31, 2021
@jpogran jpogran deleted the m-style-guide branch August 31, 2021 13:42
@github-actions
Copy link

github-actions bot commented Oct 1, 2021

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 1, 2021
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.

2 participants