fix: [SIG-528]: precommit typescript check for md files #4596

vikrantgupta25 · 2024-02-26T09:20:58Z

Summary

the type declarations of the **.md files were not added in the tmp tsconfig files, causing it to fail for onboarding containers

Related Issues / PR's

#SIG-528

Screenshots

BEFORE

Screen.Recording.2024-02-26.at.2.52.22.PM.mov

AFTER

Screen.Recording.2024-02-26.at.2.51.18.PM.mov

Affected Areas and Manually Tested Areas

Summary by CodeRabbit

Chores
- Improved type checking by including a new definitions file in the temporary TypeScript configuration setup.

coderabbitai · 2024-02-26T09:21:03Z

Walkthrough

This update introduces a modification to the project's type checking setup. Specifically, it adds a new TypeScript declaration file, typings.d.ts, to the assortment of files considered during the temporary TypeScript configuration process for staged type checking. This adjustment ensures that custom type definitions are acknowledged and incorporated into the type checking routine, enhancing the project's type safety and developer experience.

Changes

Files	Summary
`frontend/scripts/.../typecheck-staged.sh`	Added `typings.d.ts` to the list of files in the temporary tsconfig for type checking.

🐇✨
In a burrow, deep and wide,
A rabbit worked, with code as its guide.
"A new file," it said, "shall join our quest,
To make our types the very best!"
With a hop and a skip, it made the change,
Ensuring the code felt fresh and strange.
🌟📜✨

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