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

feat: add .editorconfig and .prettierrc.js #4748

Merged
merged 1 commit into from
May 3, 2024

Conversation

yuki0410-dev
Copy link
Contributor

Description

Linked issue: #(issue number)

Problem
When creating a new file in VSCode, indentation and other settings are not set correctly and must be changed manually.

Changes
add .editorconfig file

Screenshots

To reviewers

Contribution checklist

  • I have followed the contributing guidelines.
  • I have added sufficient test coverage for my changes.
  • I have formatted my code with Prettier and checked for linting issues with ESLint for code readability.

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

✅ This pull request was sent to the PullRequest network for review. Expert reviewers are now being matched to your request based on the code's requirements. Stay tuned!

What to expect from this code review:
  • Comments posted to any areas of potential concern or improvement.
  • Detailed feedback or actions needed to resolve issues that are found.
  • Turnaround times vary, but we aim to be swift.

@yuki0410-dev you can click here to see the review status or cancel the code review job.

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

PullRequest Breakdown

Reviewable lines of change

+ 42
- 0

62% JavaScript
36% EditorConfig
2% Ignore List

Type of change

Feature - These changes are adding a new feature or improvement to existing code.

@yuki0410-dev
Copy link
Contributor Author

Test suite failures will be resolved when #4747 is merged or CI is run on another day.

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

.editorconfig is super helpful! Be sure to direct everyone to install an extension if their editor does not natively support it — I know from personal experience that VS Code does not natively.

Overall, having consistent formatting is incredibly helpful, not the least because it makes things easier to read and eliminates a number of potential merge conflicts in the future.

Image of Jacob Jacob


Reviewed with ❤️ by PullRequest

Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

Overall, the changes look good to me and I am in favor of tools such as EditorConfig and Prettier for code style consistency and cleanliness. I added a suggestions for expanding upon the Prettier config to match the EditorConfig settings. That's optional but could be nice to implement at some point. Thank you!

Image of Jonah S Jonah S


Reviewed with ❤️ by PullRequest

@@ -0,0 +1,15 @@
# http://editorconfig.org
Copy link

Choose a reason for hiding this comment

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

Reviewing the project's existing code, this EditorConfig appears to match the existing code style of the project and I recommend adopting this. EditorConfig is very helpful!

◽ Compliment

Image of Jonah S Jonah S

.prettierrc.js Show resolved Hide resolved
Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

PullRequest reviewed the updates made to #4748 up until the latest commit (db21628). No further issues were found.

Reviewed by:

Image of Jacob Jacob

@yuki0410-dev yuki0410-dev changed the title feat: add .editorconfig & .prettierrc.js feat: add .editorconfig and .prettierrc.js May 1, 2024
Copy link

@pullrequest pullrequest bot left a comment

Choose a reason for hiding this comment

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

PullRequest reviewed the updates made to #4748 up until the latest commit (8072e18). No further issues were found.

Reviewed by:

Image of Jonah S Jonah S

Copy link

codecov bot commented May 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.26%. Comparing base (0cb6f84) to head (8072e18).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4748   +/-   ##
=======================================
  Coverage   97.26%   97.26%           
=======================================
  Files          11       11           
  Lines        1462     1462           
  Branches      642      650    +8     
=======================================
  Hits         1422     1422           
  Misses         40       40           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@martijnrusschen martijnrusschen merged commit 711de89 into Hacker0x01:main May 3, 2024
6 checks passed
@yuki0410-dev yuki0410-dev deleted the feat/editorconfig branch May 3, 2024 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants