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: updated configs #320

Merged
merged 1 commit into from
Feb 24, 2025
Merged

chore: updated configs #320

merged 1 commit into from
Feb 24, 2025

Conversation

hmbanan666
Copy link
Contributor

@hmbanan666 hmbanan666 commented Feb 24, 2025

Summary by CodeRabbit

  • New Features

    • Introduced a comprehensive validation command that runs linting, type checking, and tests as a single operation.
  • Chores

    • Enhanced development configurations by refining version control tracking to include key task files.
    • Streamlined the development environment by removing outdated editor settings and task configurations.

Copy link

coderabbitai bot commented Feb 24, 2025

Walkthrough

The changes modify version control and task configuration. A new exception rule in the .gitignore enables tracking of the VSCode tasks.json file. A new VSCode task configuration file is added to run a "Full check" combining linting, type checking, and tests. Outdated configuration files in the .zed directory have been removed. Additionally, the package.json file now includes a check:full script that executes multiple commands sequentially.

Changes

File(s) Change Summary
.gitignore Added exception rule (!.vscode/tasks.json) to allow tracking of the VSCode tasks file.
.vscode/tasks.json New task configuration defining a "Full check" (npm task) that runs the check:full script.
.zed/settings.json, .zed/tasks.json Deleted outdated configuration files for editor settings and task definitions.
package.json Added script "check:full": "pnpm run lint:fix && pnpm run typecheck && pnpm vitest run" to run linting, type checking, and tests sequentially.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant VSCode as VSCode
    participant Script as check:full Script
    participant Lint as Lint (pnpm run lint:fix)
    participant TypeCheck as TypeCheck (pnpm run typecheck)
    participant Test as Tests (pnpm vitest run)

    Dev->>VSCode: Run "Full check" task
    VSCode->>Script: Invoke "check:full" script
    Script->>Lint: Run lint:fix
    Lint-->>Script: Return lint results
    Script->>TypeCheck: Run typecheck
    TypeCheck-->>Script: Return type check results
    Script->>Test: Run vitest run
    Test-->>Script: Return test results
    Script-->>VSCode: Return overall results
    VSCode-->>Dev: Display results
Loading

Poem

I’m a bunny happily coding away,
Skipping ignored files to brighten my day!
Tasks now hop in a neat, timed line,
Lint, typecheck, and test all combine.
With every command, my joy will grow—
A leap in code with every rhythmic flow! 🐇✨


🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
package.json (1)

42-42: Clarify Consistency in Script Invocation

The newly added "check:full" script effectively consolidates linting, type checking, and testing into a single command. One minor observation: while the preceding scripts use pnpm run <script>, the testing part here is invoked as pnpm vitest run instead of pnpm run vitest run. For consistency, you might consider aligning the invocation method.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f5ad188 and 62b7a24.

📒 Files selected for processing (5)
  • .gitignore (1 hunks)
  • .vscode/tasks.json (1 hunks)
  • .zed/settings.json (0 hunks)
  • .zed/tasks.json (0 hunks)
  • package.json (1 hunks)
💤 Files with no reviewable changes (2)
  • .zed/settings.json
  • .zed/tasks.json
✅ Files skipped from review due to trivial changes (2)
  • .vscode/tasks.json
  • .gitignore
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build

@hmbanan666 hmbanan666 merged commit 15d22f9 into main Feb 24, 2025
6 checks passed
@hmbanan666 hmbanan666 deleted the vscode branch February 24, 2025 17:03
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.

1 participant