chore: update eslint type

[coderwyd]

Description

Eslint.FlatConfig is deprecated.

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• Bug Fixes

  • Improved TypeScript type enforcement by removing an error suppression comment in the linting configuration.

• Changes

  • Updated return types of key functions and configuration variables to enhance consistency with the latest linting standards.
  • Adjusted type aliasing to reflect a shift in the linting configuration structure.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 13c0663

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[coderabbitai]

Walkthrough

The recent changes in the linting configuration code mainly revolve around type modifications. Functions and variables have transitioned from returning or defining Linter.FlatConfig to Linter.Config. Additionally, a TypeScript error suppression comment has been removed, promoting stricter type checking. These adjustments aim to align the linting processes with a more standardized configuration structure, enhancing type safety and potentially broadening the capabilities of the linting system.

Changes

Files	Change Summary
internal/lint-configs/eslint-config/src/configs/jsonc.ts, internal/lint-configs/eslint-config/src/configs/test.ts, internal/lint-configs/eslint-config/src/custom-config.ts, internal/lint-configs/eslint-config/src/index.ts	Functions and variables have been updated to return or define Linter.Config instead of Linter.FlatConfig, indicating a shift in the expected configuration structure. The comment suppressing TypeScript errors was removed from the test function, enforcing stricter type checks.

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as Linter
    participant C as Config

    A->>B: Request linting with custom config
    B->>C: Validate config type
    C-->>B: Return validated config
    B-->>A: Lint results

Loading

Poem

In the meadow where bunnies play,
Type changes hop in a joyful way.
Linter's tune now sings more clear,
With config shifts, we have no fear!
Hoppity hop, let the errors be few,
A brighter linting path for us to pursue! 🐇✨

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ccaa321 and 13c0663.

Files selected for processing (4)

• internal/lint-configs/eslint-config/src/configs/jsonc.ts (2 hunks)
• internal/lint-configs/eslint-config/src/configs/test.ts (1 hunks)
• internal/lint-configs/eslint-config/src/custom-config.ts (1 hunks)
• internal/lint-configs/eslint-config/src/index.ts (1 hunks)

Additional comments not posted (5)

internal/lint-configs/eslint-config/src/index.ts (1)

24-24: Update type alias to Linter.Config.

The type alias FlatConfig has been updated from Linter.FlatConfig to Linter.Config. Ensure that this change is compatible with the rest of the codebase and that all references to FlatConfig are correctly updated.

internal/lint-configs/eslint-config/src/configs/test.ts (1)

Line range hint 8-8:
Removal of TypeScript error suppression comment.

The // @ts-expect-error - no types comment has been removed, promoting stricter type checking. Ensure that the merged rules from pluginTest and pluginNoOnlyTests do not introduce type errors.

internal/lint-configs/eslint-config/src/custom-config.ts (1)

9-9: Update type definition to Linter.Config[].

The type definition of the customConfig variable has been updated from Linter.FlatConfig[] to Linter.Config[]. Ensure that this change is compatible with the rest of the codebase and that all references to customConfig are correctly updated.

internal/lint-configs/eslint-config/src/configs/jsonc.ts (2)

Line range hint 54-80:
LGTM! Verify compatibility with the new return type.

The return type has been updated from Linter.FlatConfig to Linter.Config to align with the deprecation. Ensure that the new return type is compatible with the rest of the codebase.

---

Line range hint 133-193:
LGTM! Verify compatibility with the new return type.

The return type has been updated from Linter.FlatConfig to Linter.Config to align with the deprecation. Ensure that the new return type is compatible with the rest of the codebase.