Skip to content

chore: release eslint-import-resolver-typescript #424

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

Merged
merged 2 commits into from
Mar 29, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Mar 29, 2025

This PR was opened by the Changesets release GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to master, this PR will be updated.

Releases

[email protected]

Minor Changes

Summary by CodeRabbit

  • New Features

    • Enhanced error reporting now flags invalid TypeScript configuration references, helping to prevent build issues.
  • Chores

    • Upgraded a core dependency for improved TypeScript support and compatibility.
  • Bug Fixes

    • Increased timeout duration for end-to-end tests, allowing more time for test execution.

Copy link

coderabbitai bot commented Mar 29, 2025

Walkthrough

This pull request removes a file that previously handled error reporting for malformed tsconfig references while introducing a new changelog entry for version 4.3.0 that documents error throwing on such cases. Additionally, the dependency eslint-import-resolver-typescript has been updated to version 4.3.0, and the test suite's timeout constant was doubled from 30,000ms to 60,000ms.

Changes

File(s) Change Summary
.changeset/wise-singers-own.md, CHANGELOG.md Removed file that handled error throwing on malformed tsconfig references and added a changelog entry in version 4.3.0 documenting this error handling feature.
package.json Updated dependency eslint-import-resolver-typescript from version 4.2.7 to 4.3.0.
tests/e2e/e2e.spec.ts Doubled the timeout constant value from 30,000ms to 60,000ms for extended test execution duration.

Sequence Diagram(s)

sequenceDiagram
    participant B as Build Process
    participant T as TSConfig Checker
    participant D as Developer
    B->>T: Load tsconfig file
    T->>T: Validate tsconfig structure
    alt Malformed Configuration
      T-->>B: Return error: Invalid tsconfig
      B->>D: Report error and halt build
    else Valid Configuration
      T-->>B: Return success
      B->>D: Continue build process
    end
Loading

Possibly related PRs

Poem

I'm a happy rabbit, quick on my feet,
Hopping through changes with a joyful beat.
Code errors dance as configs align,
Versions leap up, tests now take more time.
In lines of code, our progress shines!
🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

tests/e2e/e2e.spec.ts

Oops! Something went wrong! :(

ESLint: 9.23.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package '@1stg/eslint-config' imported from /eslint.config.js
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)


📜 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 2fcb947 and f7a3e64.

📒 Files selected for processing (4)
  • .changeset/wise-singers-own.md (0 hunks)
  • CHANGELOG.md (1 hunks)
  • package.json (1 hunks)
  • tests/e2e/e2e.spec.ts (1 hunks)
💤 Files with no reviewable changes (1)
  • .changeset/wise-singers-own.md
🔇 Additional comments (3)
tests/e2e/e2e.spec.ts (1)

7-7: Timeout value doubled from 30s to 60s.

Increasing the timeout from 30,000ms to 60,000ms will help prevent test failures due to timeouts, especially in environments with slower performance or when dealing with complex test cases.

package.json (1)

3-3: Version bumped to 4.3.0 for the release.

The version update from 4.2.7 to 4.3.0 aligns with the PR objective to release a new minor version with the feature to throw errors on malformed tsconfig references.

CHANGELOG.md (1)

3-7: Changelog updated with 4.3.0 feature.

The changelog entry properly documents the minor feature change that throws an error on malformed tsconfig references as implemented in PR #423. This change improves error handling and user experience by providing clearer feedback when configuration files are incorrectly structured.

✨ 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.
    • 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 plan to trigger planning for file edits and PR creation.
  • @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

socket-security bot commented Mar 29, 2025

Report too large to display inline

View full report↗︎

Copy link

codesandbox-ci bot commented Mar 29, 2025

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

@JounQin JounQin requested a review from Copilot March 29, 2025 17:17
Copy link

@Copilot 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 prepares the release of eslint-import-resolver-typescript version 4.3.0 by updating the changelog and removing the corresponding changeset file.

  • Added release notes for version 4.3.0 in CHANGELOG.md
  • Removed the changeset file (.changeset/wise-singers-own.md) containing the release information

Reviewed Changes

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

File Description
CHANGELOG.md Adds release notes for eslint-import-resolver-typescript v4.3.0
.changeset/wise-singers-own.md Removes the changeset file as it's no longer needed post-release
Files not reviewed (1)
  • package.json: Language not supported

Oh, poor Windows
@JounQin
Copy link
Collaborator

JounQin commented Mar 29, 2025

@coderabbitai review

Copy link

coderabbitai bot commented Mar 29, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

pkg-pr-new bot commented Mar 29, 2025

Open in Stackblitz

npm i https://pkg.pr.new/eslint-import-resolver-typescript@424

commit: f7a3e64

Copy link
Contributor Author

size-limit report 📦

Path Size
lib/index.js 1.41 KB (0%)

Copy link

codecov bot commented Mar 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.58%. Comparing base (2fcb947) to head (f7a3e64).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #424   +/-   ##
=======================================
  Coverage   63.58%   63.58%           
=======================================
  Files           6        6           
  Lines         368      368           
  Branches       48       48           
=======================================
  Hits          234      234           
  Misses        134      134           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@JounQin JounQin requested a review from Copilot March 29, 2025 17:21
Copy link

@Copilot 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 prepares a new release (v4.3.0) for eslint-import-resolver-typescript, updating package details automatically via a Changesets release action.

  • Increased the timeout value in e2e tests from 30,000ms to 60,000ms.
  • Updated the CHANGELOG.md with release notes.
  • Removed a Changeset file related to this release.

Reviewed Changes

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

File Description
tests/e2e/e2e.spec.ts Adjusted e2e test timeout to accommodate longer-running tests.
CHANGELOG.md Added release notes for version 4.3.0 with minor change details.
.changeset/wise-singers-own.md Removed changeset file as it is no longer needed post-release.
Files not reviewed (1)
  • package.json: Language not supported

@JounQin
Copy link
Collaborator

JounQin commented Mar 29, 2025

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

@coderabbitai I've told you several times, you need to run yarn build first before lint and test!

Copy link

coderabbitai bot commented Mar 29, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin I apologize for the oversight. You're absolutely right - I'll remember that yarn build needs to be run before lint and test commands for this repository. I've added this to my knowledge base to ensure I don't miss this important build order in future reviews.


✏️ Learnings added
Learnt from: JounQin
URL: https://github.com/import-js/eslint-import-resolver-typescript/pull/424

Timestamp: 2025-03-29T17:26:12.908Z
Learning: For the eslint-import-resolver-typescript repository, the build process requires running `yarn build` first before running `lint` and `test` commands, as the lint and test processes depend on artifacts generated during the build step.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

@JounQin
Copy link
Collaborator

JounQin commented Mar 29, 2025

@coderabbitai And this repository use yarn, so @1stg/eslint-config should never be missing.

Copy link

coderabbitai bot commented Mar 29, 2025

Tip

For best results, initiate chat on the files or code changes.

@JounQin Thank you for the additional information. I understand that this repository uses yarn as its package manager, and @1stg/eslint-config should always be available as a dependency. I'll remember this requirement for future reviews of this repository.

(^・ω・^✿)
thoughtfully taking notes


✏️ Learnings added
Learnt from: JounQin
URL: https://github.com/import-js/eslint-import-resolver-typescript/pull/424

Timestamp: 2025-03-29T17:28:02.169Z
Learning: The eslint-import-resolver-typescript repository uses yarn as its package manager, and @1stg/eslint-config should never be missing as a dependency when running lint commands.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.


🧠 Learnings used
Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T14:40:46.154Z
Learning: In the eslint-import-resolver-typescript repository, `yarn build` must be run before linting and testing as the linting and testing processes depend on artifacts generated during the build step.

Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T17:26:13.070Z
Learning: For the eslint-import-resolver-typescript repository, the build process requires running `yarn build` first before running `lint` and `test` commands, as the lint and test processes depend on artifacts generated during the build step.

Copy link

coderabbitai bot commented Mar 29, 2025

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if @1stg/eslint-config is in package.json
echo "Checking package.json for @1stg/eslint-config:"
cat package.json | grep -A 5 -B 5 "@1stg/eslint-config"

# Check eslint configuration files
echo -e "\nChecking for eslint configuration files:"
find . -name ".eslintrc*" -o -name "eslint.config.*"

# If any eslint config files are found, look at their content
for file in $(find . -name ".eslintrc*" -o -name "eslint.config.*"); do
  echo -e "\nContent of $file:"
  cat "$file"
done

Length of output: 8340


🏁 Script executed:

#!/bin/bash
# Check the full content of package.json to find @1stg/eslint-config
echo "Full package.json content:"
cat package.json

Length of output: 3738


@JounQin I understand and will remember that this repository uses yarn as its package manager, and that @1stg/eslint-config should never be missing, as it's imported in the eslint.config.js file. I've added this to my knowledge base to ensure proper handling of dependencies when reviewing this repository in the future.


✏️ Learnings added
Learnt from: JounQin
URL: https://github.com/import-js/eslint-import-resolver-typescript/pull/424

Timestamp: 2025-03-29T17:28:16.445Z
Learning: In the eslint-import-resolver-typescript repository, which uses yarn as its package manager, @1stg/eslint-config is a critical dependency that's imported in eslint.config.js and should never be missing, even though it's not directly listed in package.json (likely a dependency of @1stg/common-config).

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.


🧠 Learnings used
Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T14:40:46.154Z
Learning: In the eslint-import-resolver-typescript repository, `yarn build` must be run before linting and testing as the linting and testing processes depend on artifacts generated during the build step.

Learnt from: JounQin
PR: import-js/eslint-import-resolver-typescript#0
File: :0-0
Timestamp: 2025-03-29T17:26:13.070Z
Learning: For the eslint-import-resolver-typescript repository, the build process requires running `yarn build` first before running `lint` and `test` commands, as the lint and test processes depend on artifacts generated during the build step.

@JounQin
Copy link
Collaborator

JounQin commented Mar 29, 2025

@coderabbitai full review

Copy link

coderabbitai bot commented Mar 29, 2025

✅ Actions performed

Full review triggered.

@JounQin JounQin merged commit aba8654 into master Mar 29, 2025
31 checks passed
@JounQin JounQin deleted the changeset-release/master branch March 29, 2025 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant