Skip to content

Conversation

@JounQin
Copy link
Member

@JounQin JounQin commented May 16, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Improved configuration handling in the lint command for more reliable ESLint behavior, especially for TypeScript and React TypeScript files.
  • Chores

    • Updated internal configuration to align with the latest ESLint API.

@JounQin JounQin requested a review from Copilot May 16, 2025 10:07
@JounQin JounQin self-assigned this May 16, 2025
@JounQin JounQin added the bug Something isn't working label May 16, 2025
@changeset-bot
Copy link

changeset-bot bot commented May 16, 2025

🦋 Changeset detected

Latest commit: 984e232

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@alauda/doom Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@coderabbitai
Copy link

coderabbitai bot commented May 16, 2025

Walkthrough

A new changeset was added for the "@alauda/doom" package to document a patch update. The lint command's ESLint configuration was updated to use overrideConfigFile: true and overrideConfig instead of baseConfig. A TypeScript-specific ESLint configuration block was also uncommented and activated.

Changes

File(s) Change Summary
.changeset/weak-scissors-chew.md Added a changeset file documenting a patch update for "@alauda/doom" regarding configuration handling.
src/cli/lint.ts Updated ESLint usage: replaced baseConfig with overrideConfig, enabled overrideConfigFile: true, and activated a TypeScript-specific configuration block.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI (lint.ts)
    participant ESLint

    User->>CLI (lint.ts): Run lint command
    CLI (lint.ts)->>ESLint: Initialize with overrideConfigFile: true and overrideConfig
    CLI (lint.ts)->>ESLint: Provide TypeScript-specific config for ts/tsx files
    ESLint-->>CLI (lint.ts): Lint results
    CLI (lint.ts)-->>User: Output lint results
Loading

Poem

In the warren of code, a patch hops through,
With configs aligned and options anew.
TypeScript gets linted with care and delight,
As override flags set everything right.
🐇✨ The code is now neat, the warnings are few!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 32dd8d7 and 984e232.

📒 Files selected for processing (2)
  • .changeset/weak-scissors-chew.md (1 hunks)
  • src/cli/lint.ts (2 hunks)
🔇 Additional comments (3)
src/cli/lint.ts (2)

33-33: Good update to use overrideConfig instead of baseConfig

This change aligns with ESLint's current API, which uses overrideConfig instead of the older baseConfig property.


62-83: Great addition of TypeScript-specific ESLint configuration

Uncommented TypeScript configuration looks good. The TypeScript parser configuration with projectService: true enables type-aware linting which improves accuracy of linting rules that depend on type information.

.changeset/weak-scissors-chew.md (1)

1-5: Good changeset description

The changeset correctly documents the use of overrideConfigFile: true and overrideConfig instead of the previous approach. This aligns with the changes made in the code and follows proper versioning with a patch update.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the ESLint configuration in the CLI lint command to use the new options overrideConfigFile and overrideConfig instead of the deprecated baseConfig. It also restores a previously commented block with type-checked linting rules for TypeScript and React.

  • Replaces baseConfig with overrideConfig.
  • Adds overrideConfigFile: true.
  • Uncomments and restructures the TypeScript/React configuration block.
Comments suppressed due to low confidence (1)

src/cli/lint.ts:33

  • Verify that replacing baseConfig with overrideConfig is fully aligned with the latest ESLint API guidelines to avoid any unintended configuration merging or behavior changes.
overrideConfig: tseslint.config([

Signed-off-by: JounQin <admin@1stg.me>
@pkg-pr-new
Copy link

pkg-pr-new bot commented May 16, 2025

Open in StackBlitz

npm i https://pkg.pr.new/@alauda/doom@17

commit: 984e232

@JounQin JounQin merged commit e54587f into main May 16, 2025
16 checks passed
@JounQin JounQin deleted the fix/overrideConfig branch May 16, 2025 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants