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

Docs: NoResolution: Hint at how to ignore the issue #235

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

tordans
Copy link
Contributor

@tordans tordans commented Dec 28, 2024

I am running in to https://github.com/arethetypeswrong/arethetypeswrong.github.io/blob/main/docs/problems/NoResolution.md and the current docs don't help much in cases when I don't care about the issue.

I think the new feature introduced in #112 should be documented on this error page so users have a quick way find the docs on how to skip the error.

Copy link

changeset-bot bot commented Dec 28, 2024

⚠️ No Changeset found

Latest commit: f66f316

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

Comment on lines 41 to 43
## Ignore issue

You can use the `profile` `node16` to ignore this issue. It will be reported as `node10: (ignored) 💀 Resolution failed` with a red export path but it the check will not exit with an error anymore. [Learn more in the CLI Readme](https://github.com/arethetypeswrong/arethetypeswrong.github.io/tree/main/packages/cli#profiles).
Copy link
Collaborator

Choose a reason for hiding this comment

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

I’m fine with this addition if it’s rolled into the previous section rather than a new h2. The suggestion isn’t applicable to the problem generally; it’s specific to the "exports" cause spelled out above.

Suggested change
## Ignore issue
You can use the `profile` `node16` to ignore this issue. It will be reported as `node10: (ignored) 💀 Resolution failed` with a red export path but it the check will not exit with an error anymore. [Learn more in the CLI Readme](https://github.com/arethetypeswrong/arethetypeswrong.github.io/tree/main/packages/cli#profiles).
> You can use the [`--profile node16` option on the CLI](https://github.com/arethetypeswrong/arethetypeswrong.github.io/tree/main/packages/cli#profiles) to ignore issues that only affect `--moduleResolution node10`.

@andrewbranch
Copy link
Collaborator

Thank you!

@andrewbranch andrewbranch merged commit 10bb023 into arethetypeswrong:main Jan 13, 2025
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