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.

Sign up for GitHub

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

Jump to bottom

Fix references to eslint-plugin-i in README.md, npm alias #283

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

Fix references to eslint-plugin-i in README.md, npm alias #283

wants to merge 1 commit into from
+3 −3

Conversation

jrnail23
Copy link

@jrnail23 jrnail23 commented May 9, 2024

fixes #253 (corrects the aliased npm install command)
fixes #281

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented May 9, 2024

⚠️ No Changeset found

Latest commit: 9fb254a

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

@codesandbox-ci CodeSandbox CI
Copy link

codesandbox-ci bot commented May 9, 2024

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.

@SunsetTechuila SunsetTechuila mentioned this pull request Jul 5, 2024
Closed
@JounQin
Copy link
Collaborator

JounQin commented Jul 14, 2024

eslint-plugin-import-x is not an alias anymore, so the alias installation is only for eslint-plugin-i.

SukkaW
SukkaW reviewed Jul 15, 2024
View reviewed changes
README.md
@@ -58,7 +58,7 @@ pnpm i -D eslint-plugin-import eslint-import-resolver-typescript
yarn add -D eslint-plugin-import eslint-import-resolver-typescript
```

**Important when using `eslint-plugin-i` and `npm`**: Use `npm i -D eslint-plugin-import@eslint-plugin-i@latest eslint-import-resolver-typescript`, or you will end up with both `eslint-plugin-import` and `eslint-plugin-i` in your node_modules.
**Important when using `eslint-plugin-import-x` and `npm`**: Use `npm i -D eslint-plugin-import@npm:eslint-plugin-import-x@latest eslint-import-resolver-typescript`, or you will end up with both `eslint-plugin-import` and `eslint-plugin-import-x` in your node_modules.
Copy link
Collaborator

Choose a reason for hiding this comment

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

It might be impossible to use eslint-plugin-import-x as an alias of eslint-plugin-import now. Might possibly just remove the tip.

Copy link
Collaborator

@JounQin JounQin Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, the settings prefix is hardcoded as import-x, so aliasing will not work as expected.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JounQin JounQin JounQin left review comments

@SukkaW SukkaW SukkaW left review comments

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

eslint-plugin-x's old name eslint-plugin-i is still used in docs Cannot use with eslint-plugin-i
3 participants
@jrnail23 @JounQin @SukkaW