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

bump eslint v9 #962

Merged
merged 3 commits into from
Aug 13, 2024
Merged

bump eslint v9 #962

merged 3 commits into from
Aug 13, 2024

Conversation

shogo82148
Copy link
Owner

@shogo82148 shogo82148 commented Aug 13, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new ESLint configuration file to enhance TypeScript support and code quality.
    • Updated GitHub Actions workflows to improve linting processes and dependency management.
  • Bug Fixes

    • Added annotations for areas needing attention in the installer file to prompt further review.
  • Chores

    • Upgraded several development dependencies for improved linting and TypeScript support.
    • Simplified type definitions in the installer file for consistency and clarity.

Copy link

coderabbitai bot commented Aug 13, 2024

Walkthrough

The modifications enhance the GitHub Actions workflow for linting and type-checking JavaScript and TypeScript code. Job roles were clarified through renaming, and additional steps were introduced for better Node.js dependency management. A new ESLint configuration file was added, integrating TypeScript support. The package.json was updated with newer versions of various linting tools, aiming to improve code quality and maintainability.

Changes

Files Change Summary
.github/workflows/reviewdog.yml Jobs renamed for clarity; actionlint now uses reviewdog/action-actionlint@v1, while eslint job enhanced with Node.js setup and caching.
eslint.config.mjs New file added for ESLint configuration, integrating TypeScript support and using recommended rules with strict and stylistic extensions.
package.json Updated devDependencies: eslint upgraded to ^9.9.0, added @eslint/js, @types/eslint__js, and typescript-eslint, enhancing linting and TypeScript support.
src/installer.ts Changed Matrix from an interface to a type alias using Record<string, string[]>; updated minorVersions to use the same type for consistency.

Poem

In the garden where code does bloom,
A rabbit hops to chase away gloom.
With linting tools now shining bright,
Our TypeScript hops take flight!
Dependencies fresh, our paths align,
Hooray for changes, all is fine! 🐇✨


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.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 280c430 and 93a65bd.

Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (4)
  • .github/workflows/reviewdog.yml (1 hunks)
  • eslint.config.mjs (1 hunks)
  • package.json (1 hunks)
  • src/installer.ts (2 hunks)
Files skipped from review due to trivial changes (2)
  • eslint.config.mjs
  • src/installer.ts
Additional comments not posted (6)
.github/workflows/reviewdog.yml (2)

7-11: LGTM!

The actionlint job setup appears correct for linting GitHub Actions workflows.


13-27: Well-structured ESLint job configuration.

The eslint job is well-configured with Node.js setup, npm caching, and appropriate ESLint flags for TypeScript files.

package.json (4)

37-37: Appropriate addition of @eslint/js.

The addition of @eslint/js aligns with the use of official ESLint configurations and rules.


38-38: Enhancement with @types/eslint__js.

The addition of @types/eslint__js enhances TypeScript support for ESLint.


43-43: Update to ESLint version ^9.9.0.

The update to ESLint introduces new rules and enhancements, aligning with modern standards.


48-48: Improved TypeScript integration with typescript-eslint.

The addition of typescript-eslint improves TypeScript integration with ESLint, enhancing code quality.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 93a65bd and 39e5915.

Files selected for processing (1)
  • src/installer.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/installer.ts

@shogo82148 shogo82148 merged commit 6ca623e into main Aug 13, 2024
53 checks passed
@shogo82148 shogo82148 deleted the bump-eslint-v9 branch August 13, 2024 03:29
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