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 typecheck on pre-commit hook #4472

Merged
merged 2 commits into from
Feb 2, 2024
Merged

feat: add typecheck on pre-commit hook #4472

merged 2 commits into from
Feb 2, 2024

Conversation

vikrantgupta25
Copy link
Collaborator

@vikrantgupta25 vikrantgupta25 commented Jan 31, 2024

Summary

  • added type check on pre-commit hook to avoid the delay in build time and catch it at compile time

Related Issues / PR's

Screenshots

NA

Affected Areas and Manually Tested Areas

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Introduced a type checking feature for staged files to enhance code quality and reliability.

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@github-actions github-actions bot added the enhancement New feature or request label Jan 31, 2024
Copy link

coderabbitai bot commented Jan 31, 2024

Walkthrough

This update introduces a script, typecheck-staged.sh, that enhances a TypeScript project's development workflow by enabling type checking for staged files. It dynamically generates a temporary TypeScript configuration with the staged files, runs tsc using this configuration, captures the exit code, and cleans up the temporary file. This targeted approach aids in efficient identification and resolution of type issues before committing changes.

Changes

File Change Summary
frontend/scripts/typecheck-staged.sh Added a script to concatenate and type check staged TypeScript files.

🐰✨
A script was born in the codebase vast,
To check the types, so errors won't last.
Through files it hops, with precision and grace,
Ensuring the code's in a very safe place.
🌟📜

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.

Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 3

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5c60a86 and df36a3f.
Files ignored due to path filters (1)
  • frontend/package.json is excluded by: !**/*.json
Files selected for processing (1)
  • frontend/scripts/typecheck-staged.sh (1 hunks)
Additional comments: 1
frontend/scripts/typecheck-staged.sh (1)
  • 25-25: Exiting with the captured exit code of tsc is a good practice as it forwards the success or failure status. This part of the script is correctly implemented.

frontend/scripts/typecheck-staged.sh Show resolved Hide resolved
frontend/scripts/typecheck-staged.sh Outdated Show resolved Hide resolved
frontend/scripts/typecheck-staged.sh Show resolved Hide resolved
Copy link

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0f44246 and aa9d477.
Files ignored due to path filters (1)
  • frontend/package.json is excluded by: !**/*.json
Files selected for processing (1)
  • frontend/scripts/typecheck-staged.sh (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • frontend/scripts/typecheck-staged.sh

Copy link

github-actions bot commented Feb 2, 2024

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

@vikrantgupta25 vikrantgupta25 merged commit 2cf0bb4 into develop Feb 2, 2024
11 of 12 checks passed
@srikanthccv srikanthccv deleted the lint-staged branch April 11, 2024 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants