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

chore: prettier action #2993

Closed
wants to merge 1 commit into from
Closed

chore: prettier action #2993

wants to merge 1 commit into from

Conversation

chandumlg
Copy link
Member

@chandumlg chandumlg commented Jan 16, 2024

What are the changes introduced in this PR?

Introduces prettier github action. The action will fail if there are any unprettified files. Commit the prettified files and see the action go green.

What is the related Linear task?

Resolves INT-1238

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • Is the PR limited to 10 file changes?

  • Is the PR limited to one linear task?

  • Are relevant unit and component test-cases added?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

@chandumlg chandumlg requested review from sivashanmukh and a team as code owners January 16, 2024 06:42
Copy link
Contributor

coderabbitai bot commented Jan 16, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@chandumlg chandumlg marked this pull request as draft January 16, 2024 06:42
@chandumlg chandumlg closed this Jan 16, 2024
@chandumlg chandumlg force-pushed the chore.prettier_action branch from e4e0343 to 65c79a8 Compare January 16, 2024 06:47
@chandumlg chandumlg reopened this Jan 16, 2024
Copy link

codecov bot commented Jan 16, 2024

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (f6652b5) 87.18% compared to head (26c9a78) 87.18%.
Report is 4 commits behind head on develop.

Files Patch % Lines
src/util/stats.js 33.33% 2 Missing ⚠️
src/controllers/obs.delivery.js 0.00% 1 Missing ⚠️
src/util/customTransformer-v1.js 66.66% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #2993   +/-   ##
========================================
  Coverage    87.18%   87.18%           
========================================
  Files          529      529           
  Lines        28659    28659           
  Branches      6824     6824           
========================================
  Hits         24985    24985           
  Misses        3340     3340           
  Partials       334      334           

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

Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@chandumlg chandumlg force-pushed the chore.prettier_action branch from b0ec3e6 to 2c73b37 Compare January 16, 2024 07:03
ref: ${{ github.head_ref }}

- name: Prettify code
uses: creyD/[email protected]
Copy link
Contributor

Choose a reason for hiding this comment

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

@saikumarrs I remember we had a pre-commit hook as well right?

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, we still do.

Copy link
Member

Choose a reason for hiding this comment

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

@chandumlg, it's better we configure this action to run for only the changed files.
Additionally, we can run a scheduled cleanup action to create baseline.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah. Either run only for changed filed or fix all and then run on all.

Copy link
Contributor

Choose a reason for hiding this comment

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

Want to confirm one thing. This only checks if my source-code is not formatted along the lines that prettier has defined. Right ?!
What if there are lint failures & they somehow got committed ? They wouldn't be considered in this action right ?!

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, we need another action for it. However, we can only flag but not automatically fix them.

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually there is a way in which you can run only one command(eslint) with rules from eslint & prettier(ofcourse by disabling eslint-formatter rules) & flag if you find some changes. I tried it in one of our repositories. It is working well

Copy link
Member

Choose a reason for hiding this comment

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

Does it also update the files with corrected formatting? If yes, great!

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes. It did

Copy link
Member Author

Choose a reason for hiding this comment

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

Closing this pr then @sanpj2292 . Let's have eslint do the formatting and linting.

@chandumlg chandumlg marked this pull request as ready for review January 17, 2024 00:31
@chandumlg chandumlg requested review from a team as code owners January 17, 2024 00:31
@chandumlg chandumlg force-pushed the chore.prettier_action branch from dad52e5 to 26c9a78 Compare January 17, 2024 22:43
Copy link

@chandumlg chandumlg closed this Jan 19, 2024
@chandumlg chandumlg deleted the chore.prettier_action branch January 19, 2024 00:34
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.

4 participants