Skip to content

Refactor: Use TypeScript for ESLint and Jest configurations#47

Merged
238SAMIxD merged 1 commit intotypescriptfrom
ts-config-files
May 21, 2025
Merged

Refactor: Use TypeScript for ESLint and Jest configurations#47
238SAMIxD merged 1 commit intotypescriptfrom
ts-config-files

Conversation

@238SAMIxD
Copy link
Owner

@238SAMIxD 238SAMIxD commented May 21, 2025

Converts ESLint and Jest configuration files from JavaScript (.js) to TypeScript (.ts).

  • I renamed eslint.config.js to eslint.config.ts.
  • I renamed jest.config.js to jest.config.ts and updated its syntax to ES Modules.
  • I added ts-node as a dev dependency, as Jest requires it to parse TypeScript configuration files.
  • I added jiti as a dev dependency, as ESLint requires it for TypeScript configuration files.

This change allows for more consistent use of TypeScript across the project. The core application logic remains in TypeScript, and now the primary configuration files for linting and testing also leverage TypeScript's benefits.

The production start script continues to use pre-compiled JavaScript for performance, while the dev script uses ts-node for direct TypeScript execution.

Summary by Sourcery

Refactor linting and testing configurations to TypeScript and update dependencies and scripts accordingly

Enhancements:

  • Convert ESLint and Jest config files from JavaScript to TypeScript
  • Add ts-node and jiti as dev dependencies for parsing TypeScript configurations
  • Update dev script to use ts-node for direct TypeScript execution while retaining compiled JavaScript for production start

Converts ESLint and Jest configuration files from JavaScript (.js) to TypeScript (.ts).

- I renamed `eslint.config.js` to `eslint.config.ts`.
- I renamed `jest.config.js` to `jest.config.ts` and updated its syntax to ES Modules.
- I added `ts-node` as a dev dependency, as Jest requires it to parse TypeScript configuration files.
- I added `jiti` as a dev dependency, as ESLint requires it for TypeScript configuration files.

This change allows for more consistent use of TypeScript across the project. The core application logic remains in TypeScript, and now the primary configuration files for linting and testing also leverage TypeScript's benefits.

The production `start` script continues to use pre-compiled JavaScript for performance, while the `dev` script uses `ts-node` for direct TypeScript execution.
@sourcery-ai
Copy link

sourcery-ai bot commented May 21, 2025

Reviewer's Guide

This PR refactors the ESLint and Jest configurations from JavaScript to TypeScript, converts Jest config to ES Modules, and adds the necessary dev dependencies (ts-node and jiti) to enable TypeScript parsing of these config files.

File-Level Changes

Change Details Files
Migrate ESLint config to TypeScript with Jiti support
  • Renamed eslint.config.js to eslint.config.ts
  • Configured ESLint to use jiti for loading the TS config
eslint.config.ts
package.json
package-lock.json
Convert Jest config to a TypeScript ES Module
  • Renamed jest.config.js to jest.config.ts
  • Replaced module.exports with export default syntax
jest.config.ts
Add runtime dependencies for TS-based config files
  • Added ts-node as a dev dependency
  • Added jiti as a dev dependency
package.json
package-lock.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link

coderabbitai bot commented May 21, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @238SAMIxD, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello! Gemini here, providing a summary of this pull request to help everyone get up to speed quickly. This PR focuses on enhancing consistency within the project by migrating the ESLint and Jest configuration files from JavaScript (.js) to TypeScript (.ts). This change allows us to leverage TypeScript's benefits, such as type checking and improved tooling support, even for configuration. The core application logic already uses TypeScript, and this extends that practice to key development tools. To support this, the necessary dependencies (ts-node for Jest and jiti for ESLint) have been added. The production build process remains unaffected, continuing to use compiled JavaScript for optimal performance.

Highlights

  • Configuration File Migration: The primary change involves renaming eslint.config.js to eslint.config.ts and jest.config.js to jest.config.ts.
  • Jest Config Syntax Update: The Jest configuration file (jest.config.ts) has been updated to use ES Module syntax (export default) instead of CommonJS (module.exports).
  • Dependency Additions: New development dependencies, ts-node and jiti, have been added to enable running the TypeScript configuration files for Jest and ESLint, respectively.

Changelog

  • jest.config.ts
    • Renamed from jest.config.js.
    • Updated export syntax from module.exports to export default to align with ES Modules.
  • package-lock.json
    • Added jiti dependency details.
    • Updated ts-node entry (removed license field, likely due to dependency resolution changes).
  • package.json
    • Added jiti to the devDependencies list.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Config files now green,
TypeScript brings types unseen,
Tools now understand.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@238SAMIxD 238SAMIxD requested a review from Copilot May 21, 2025 14:25
Copy link

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 refactors the ESLint and Jest configuration files to TypeScript for consistency with the project’s codebase.

  • Convert ESLint and Jest config files from JavaScript to TypeScript.
  • Add jiti and ts-node as dev dependencies to support parsing TypeScript configurations.
  • Update the Jest configuration to use ES Modules via export default.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
package.json Added jiti dependency to support TypeScript ESLint configuration.
jest.config.ts Converted CommonJS export to ES Modules using export default.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request successfully refactors the ESLint and Jest configuration files from JavaScript to TypeScript, enhancing consistency across the project. The necessary dev dependencies (jiti for ESLint, ts-node for Jest's TS config) have been correctly added or accounted for. The changes are clear, well-described, and align with modern TypeScript development practices. Great job on this refactoring effort!

Summary of Findings

  • package-lock.json modification for ts-node: The 'license' field was removed for the 'ts-node' dependency in package-lock.json. This is likely an artifact of npm version differences or lockfile regeneration and is not a functional issue. This observation is of low severity and was not commented on directly due to the review settings prioritizing medium or higher severity issues.

Merge Readiness

The changes in this pull request are well-implemented and improve the project's consistency by using TypeScript for configuration files. No critical or high-severity issues were found. The code appears ready for merging. As always, ensure it passes all CI checks and consider if any other team members should review it before final approval, as I am not authorized to approve pull requests.

@238SAMIxD 238SAMIxD merged commit 32145b2 into typescript May 21, 2025
2 checks passed
@238SAMIxD 238SAMIxD deleted the ts-config-files branch May 21, 2025 14:27
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.

2 participants