Package.json updates: Windows & yarn #240
No reviewers
Labels
No labels
area: devops
area: discovery
area: docs
area: livestream
area: proposal
campaign-blocker
consider soon
Content
dependencies
Epic
good first issue
hacktoberfest
help wanted
icebox
level: 1
level: 2
level: 3
level: 4
needs: exploration
needs: grooming
needs: priority
needs: repro
needs: tech design
on hold
priority: blocker
priority: high
priority: low
priority: medium
resilience
Tom's Wishlist
type: bug
type: discussion
type: improvement
type: new feature
type: refactor
type: task
type: testing
unplanned
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference: LBRYCommunity/lbry.tech#240
Loading…
Reference in a new issue
No description provided.
Delete branch "package.json-updates"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Some improvements (mostly) for Windows developers:
Expanded list of supported engines to include versions up to the latest version of node (gives better support for yarn package manager as a bonus).
Escape quotes in the
npm run format
command. This will make the command run without error in Windows environments (should be fine for other OSes as well I think?) .Added lockfile for yarn to get consistent installs across machines. Reference: https://yarnpkg.com/lang/en/docs/yarn-lock/
@Wick Could you update the Installation section of the README with yarn instructions? I don't personally use it.
@ -71,3 +71,3 @@
"engines": {
"node": "10.2.x"
"node": ">=10.2 <10.15.1"
},
This looks confusing, what does it do?
Does the second command in this line need to escaped too?
Not needed, runs just fine after escaping only the eslint command. :)
@ -71,3 +71,3 @@
"engines": {
"node": "10.2.x"
"node": ">=10.2 <10.15.1"
},
For regular users using npm this is just an indicator on which versions of node that can run this project fine.
If you use an alternative dependency manager, like Yarn, you'll get an error if your node version doesn't match the ones listed under "engines".
My change only extends the list of working node versions to include the versions of node between the last set version(10.2.x) and the latest recommended version listed on https://nodejs.org/en/ (which I use and it works without problems).
Not really an important change, want me to revert it?
@ -71,3 +71,3 @@
"engines": {
"node": "10.2.x"
"node": ">=10.2 <10.15.1"
},
No it's fine, since yarn is being added anyway.
Updated the readme in my latest commit, let me know if I can improve it in any way. :)
I know npm supports lock-files as well nowadays, but noticed it is explicitly set to not generate one in .npmrc. So I only mentioned the lock-file for Yarn for now.
That's cool. I've had more negative than positive experiences with lockfiles so I disabled them.