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

Pin dep versions to retain compatibility with ESLint 8, TSLint 7 #2

Merged
merged 4 commits into from
Aug 8, 2024

Conversation

xml
Copy link
Contributor

@xml xml commented Aug 7, 2024

Hi, and thanks for this great, opinionated config. It should be adopted en masse!

While installing and configuring, I ran into some problems because of the new version of ESLint, which changes A LOT. Similarly ESTSLint also has a new, matching version.

But, AirBnB hasn't yet updated their configs to be compatible. (See: Issue) So, that means users of this config will need to consciously stick with ESLint v8 and ESTSLint v7 for now, at least until AirBnB finishes adding support.

So, I propose these related changes (each is a separate commit):

  • The ESLint changes aren't mentioned in the README and will no doubt confuse some users, so I've added some lines clarifying
  • Further, we can solve the peer-deps conflict by just pinning ESTSLint to v7.
  • And, there's just a glitch seemingly caused by a copy-paste in the example 'npm install' command, which I fixed

xml added 3 commits August 7, 2024 16:33
Was seemingly using the install-peerdeps syntax of `--dev` for an npm command, rather than either `--save-dev` or `-D`. For consistency with the example yarn command, went with `-D`.
…ts with TSESLint 8

At the current time, attempting to install using the previous peer-dev of v4 throws a version mis-match that npm cannot resolve, as the latest is v8, but AirBnB requires v7 and is NOT compatible with v8. This is because of the ongoing transition to ESLint 9 (and TSESLint 8), which AirBnB does not yet support.

Simply pinning to v7 solves it.
Copy link
Owner

@Tim-W-James Tim-W-James left a comment

Choose a reason for hiding this comment

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

Thanks for bringing this to my attention - the migration to ESLint v9 is definitely a tricky situation. I'll continue to keep an eye on the AirBnB config, etc. and update this to the new structure once possible.

I'm somewhat considering dropping AirBnB and cherry-picking the rules I'd like to keep from it. This config has diverged a fair bit from it since inception.

package.json Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@xml
Copy link
Contributor Author

xml commented Aug 8, 2024

That would totally make sense. FWIW, in no way would this PR preempt that. It just gets everything working as intended again, until whenever that happens. It's basically just a bug-fix, while creating some awareness of the ESLint migration.

Copy link
Owner

@Tim-W-James Tim-W-James left a comment

Choose a reason for hiding this comment

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

That would totally make sense. FWIW, in no way would this PR preempt that. It just gets everything working as intended again, until whenever that happens. It's basically just a bug-fix, while creating some awareness of the ESLint migration.

Sounds reasonable.

LGTM, I'll get this merged and push a new version to npm

@Tim-W-James Tim-W-James merged commit 9cf3f3a into Tim-W-James:main Aug 8, 2024
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