8000 Docs: Explain why we disable lock files (refs eslint/tsc-meetings#234… · eslint/eslint@f7ca481 · GitHub
[go: up one dir, main page]

Skip to content

Commit f7ca481

Browse files
authored
Docs: Explain why we disable lock files (refs eslint/tsc-meetings#234) (#14006)
1 parent 6509705 commit f7ca481

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,16 @@ Once a language feature has been adopted into the ECMAScript standard (stage 4 a
136136

137137
Join our [Mailing List](https://groups.google.com/group/eslint) or [Chatroom](https://eslint.org/chat).
138138

139+
### Why doesn't ESLint lock dependency versions?
140+
141+
Lock files like `package-lock.json` are helpful for deployed applications. They ensure that dependencies are consistent between environments and across deployments.
142+
143+
Packages like `eslint` that get published to the npm registry do not include lock files. `npm install eslint` as a user will respect version constraints in ESLint's `package.json`. ESLint and its dependencies will be included in the user's lock file if one exists, but ESLint's own lock file would not be used.
144+
145+
We intentionally don't lock dependency versions so that we have the latest compatible dependency versions in development and CI that our users get when installing ESLint in a project.
146+
147+
The Twilio blog has a [deeper dive](https://www.twilio.com/blog/lockfiles-nodejs) to learn more.
148+
139149
## <a name="releases"></a>Releases
140150

141151
We have scheduled releases every two weeks on Friday or Saturday. You can follow a [release issue](https://github.com/eslint/eslint/issues?q=is%3Aopen+is%3Aissue+label%3Arelease) for updates about the scheduling of any particular release.

0 commit comments

Comments
 (0)
0