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

Document Node version support / add a warning to tsdx create #432

Closed
lpolito opened this issue Jan 16, 2020 · 6 comments · Fixed by #433
Closed

Document Node version support / add a warning to tsdx create #432

lpolito opened this issue Jan 16, 2020 · 6 comments · Fixed by #433
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@lpolito
Copy link
Contributor

lpolito commented Jan 16, 2020

Current Behavior

If you're on Node 8 you get errors when trying to run tsdx create, but the reason for the failures are unclear.

nvm use 8.11.3

npx tsdx create bar

Failed to install dependencies
Error: Command failed with exit code 1: yarn add @types/jest @types/react @types/react-dom husky react react-dom tsdx tslib typescript --dev

Desired Behavior

When I run tsdx create it should tell me that my current Node version is not compatible.

Suggested Solution

Add a deprecation warning for unsupported Node versions when running tsdx create, as well as add Node versions supported in the README.md, and probably add a engines attribute to the package.json describing the same limitations.

Who does this impact? Who is this for?

All users.

Additional context

I only knew this by seeing the recent releases including this PR #426

@swyxio
Copy link
Collaborator

swyxio commented Jan 16, 2020

yup, sure thing. we can add an engines field https://stackoverflow.com/questions/29349684/how-can-i-specify-the-required-node-js-version-in-package-json and use something like check-version.js in the SO reply or something like https://www.npmjs.com/package/check-node-version

@swyxio swyxio added good first issue Good for newcomers help wanted Extra attention is needed labels Jan 16, 2020
@lpolito
Copy link
Contributor Author

lpolito commented Jan 16, 2020

Attempting to resolve this myself ✋

@agilgur5
Copy link
Collaborator

agilgur5 commented Aug 30, 2020

Mentioned this in #507 (comment) :

[this is exclusively] an issue with tsdx create because it doesn't pin anything (including husky) and so it gets the most up to date versions of things, which can be breaking or have incompatible versions with TSDX core

TSDX itself does not yet require Node 10+, I've specifically batched various dependencies' upgrades to Node 10 together to go into v0.14.0, which is a breaking change

@swyxio
Copy link
Collaborator

swyxio commented Aug 30, 2020

hmmm. whats the logic for still supporting node <10?

@agilgur5
Copy link
Collaborator

agilgur5 commented Aug 30, 2020

@sw-yx I think you misinterpreted me.

It should be formally dropped in a breaking change (same as all the deps that dropped it did -- it is breaking), which is what v0.14.0 is. It was not officially dropped before and is actually still supported (v0.14.0 is the next release with several breaking changes, mostly dependencies).

@swyxio
Copy link
Collaborator

swyxio commented Aug 30, 2020

ahh, makes perfect sense 👍🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
3 participants