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

Update tsconfig.json to extend a standard one #1700

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alexeyr-ci
Copy link
Collaborator

@alexeyr-ci alexeyr-ci commented Feb 26, 2025

Summary

Extracted tsconfig.json changes equivalent from #1697 (except lib is set to ["es2020"] without "dom", but we don't use any DOM APIs).

Effectively:

  • Updates module and moduleResolution to node16 (strictly superior to commonjs);
  • Updates lib and target to es2020.

Pull Request checklist

  • [ ] Add/update test to cover these changes
  • [ ] Update documentation
  • Update CHANGELOG file

This change is Reviewable

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores
    • Enhanced the development configuration by adding a new dependency for Node.js version 14.
    • Updated TypeScript configuration for improved compatibility.
    • Documented changes in the changelog to reflect updates in the TypeScript configuration.

Copy link
Contributor

coderabbitai bot commented Feb 26, 2025

Walkthrough

This update introduces configuration clarifications and dependency enhancements. In package.json, a new development dependency @tsconfig/node14 (version ^14.1.2) is added. In tsconfig.json, the configuration now extends @tsconfig/node14, and several compiler options (lib, module, and target) have been removed, streamlining the setup for Node.js version 14. Additionally, a new entry is added to CHANGELOG.md to document the update to the TypeScript configuration.

Changes

File Change Summary
package.json Added @tsconfig/node14 (version ^14.1.2) to devDependencies.
tsconfig.json Added "extends": "@tsconfig/node14"; removed compiler options: lib, module, and target.
CHANGELOG.md Added new section #### Changed documenting the update to TypeScript configuration referencing PR 1700.

Suggested reviewers

  • Judahmeek
  • justin808

Poem

In the code garden, I hop with delight,
A new config blooms, everything feels right.
Dependencies added, the path is now clear,
Compiler options trimmed, no clutter to fear.
Let’s celebrate changes, with joy we convey,
A hop and a skip in our coding ballet! 🐇✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b4beb7 and 0dbb3de.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • package.json (1 hunks)
  • tsconfig.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • tsconfig.json
  • package.json
  • CHANGELOG.md
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: dummy-app-integration-tests (newest)
  • GitHub Check: dummy-app-integration-tests (oldest)

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
🪧 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.
  • @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.

@alexeyr-ci alexeyr-ci force-pushed the alexeyr/update-tsconfig branch 2 times, most recently from d5a2a71 to 7499919 Compare February 26, 2025 11:41
@alexeyr-ci alexeyr-ci changed the title Update tsconfig.json to extend the Node 16 tsconfig Update tsconfig.json to extend the Node 14 tsconfig Feb 26, 2025
@alexeyr-ci alexeyr-ci force-pushed the alexeyr/update-tsconfig branch 2 times, most recently from 80c51c7 to 21c5744 Compare February 26, 2025 11:45
@alexeyr-ci alexeyr-ci changed the title Update tsconfig.json to extend the Node 14 tsconfig Update tsconfig.json to extend a standard one Feb 26, 2025
@alexeyr-ci alexeyr-ci force-pushed the alexeyr/update-tsconfig branch from 21c5744 to e78c5db Compare February 26, 2025 11:48
@alexeyr-ci alexeyr-ci force-pushed the alexeyr/update-tsconfig branch from e78c5db to 7b4beb7 Compare February 26, 2025 12:55
Copy link
Contributor

@Judahmeek Judahmeek left a comment

Choose a reason for hiding this comment

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

Your changes no longer match the PR description.

@alexeyr-ci
Copy link
Collaborator Author

@Judahmeek #1697 currently has
image
and this is the same as extending @tsconfig/node14 provides. Added a parenthetical comment about the only difference.

@alexeyr-ci alexeyr-ci force-pushed the alexeyr/update-tsconfig branch from 7b4beb7 to 0dbb3de Compare February 26, 2025 18:58
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.

3 participants