Document Node version support / add a warning to tsdx create
See original GitHub issueCurrent 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 https://github.com/jaredpalmer/tsdx/pull/426
Issue Analytics
- State:
- Created 4 years ago
- Comments:6 (1 by maintainers)
Top Results From Across the Web
Change Log
Updated the required Node version from 8 to 10. While previous versions of TSDX began deprecating support for Node 8, it was not...
Read more >johnrom/tsdx
Latest version: 0.14.2-noclean3, last published: a year ago. ... tsdx build will output an ES module file and 3 CommonJS files (dev, prod, ......
Read more >Setting up a monorepo with Lerna for a TypeScript project
This command will create a lerna.json file with a default folder structure ... As Lerna is intended to be used with Node.js, not...
Read more >npm publish only publish index.js and excluding everything ...
tl;dr: When a .npmignore file is not specified, npm will use your .gitignore file setting, where dist and the files in it are...
Read more >Getting Started with TSDX and Storybook | by Yoav Ganbar
Out of the box, TSDX has created one component for us, ... like me, (or any other Typescript supporting IDE) you will notice...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
@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).
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