Skip to content

feat(fmt): Improve & speedup code formatting#2375

Merged
swift1337 merged 5 commits intodevelopfrom
feat/improve-fmt
Jun 24, 2024
Merged

feat(fmt): Improve & speedup code formatting#2375
swift1337 merged 5 commits intodevelopfrom
feat/improve-fmt

Conversation

@swift1337
Copy link
Contributor

@swift1337 swift1337 commented Jun 24, 2024

Description

Previously, make fmt-import fmt-golines was really slow. I took a look and improved this because I was a bit upset waiting for minutes each time I want to format the code 😅 . Now it's x45 times faster (2.5 minutes vs 3.5 seconds on M3 Pro)

  • Remove usage of goimports-reviser
  • Update golangcli-lint in CI
  • Implement efficient make fmt
  • Add a couple of helpful linters
  • Fix/Lint the codebase

Main changes are in scripts/fmt.sh and .golangcli.yml

Before

$ time make fmt-import fmt-golines
# ....
make fmt-import fmt-golines  167.77s user 838.34s system 676% cpu 2:28.62 total

After

$ time make fmt
# ...
make fmt  3.45s user 0.63s system 297% cpu 1.370 total

@swift1337 swift1337 self-assigned this Jun 24, 2024
@github-actions github-actions bot added ci Changes to CI pipeline or github actions breaking:cli nosec labels Jun 24, 2024
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Important

Review skipped

More than 25% of the files skipped due to max files limit. The review is being skipped to prevent a low-quality review.

23 files out of 79 files are above the max files limit of 50. Please upgrade to Pro plan to get higher limits.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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 testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 testing code 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 and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@zeta-chain zeta-chain deleted a comment from github-actions bot Jun 24, 2024
Copy link
Contributor

@ws4charlie ws4charlie left a comment

Choose a reason for hiding this comment

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

cool

@github-actions
Copy link

!!!WARNING!!!
nosec detected in the following files: .github/workflows/sast-linters.yml

Be very careful about using #nosec in code. It can be a quick way to suppress security warnings and move forward with development, it should be employed with caution. Suppressing warnings with #nosec can hide potentially serious vulnerabilities. Only use #nosec when you're absolutely certain that the security issue is either a false positive or has been mitigated in another way.

Only suppress a single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the #nosec annotation, e.g: /* #nosec G401 */ or //#nosec G201 G202 G203
Broad #nosec annotations should be avoided, as they can hide other vulnerabilities. The CI will block you from merging this PR until you remove #nosec annotations that do not target specific rules.

Pay extra attention to the way #nosec is being used in the files listed above.

@swift1337 swift1337 merged commit 91886ba into develop Jun 24, 2024
@swift1337 swift1337 deleted the feat/improve-fmt branch June 24, 2024 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking:cli ci Changes to CI pipeline or github actions nosec

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants