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

Commit lockfile please #1506

Open
ryoppippi opened this issue Feb 20, 2025 · 0 comments
Open

Commit lockfile please #1506

ryoppippi opened this issue Feb 20, 2025 · 0 comments

Comments

@ryoppippi
Copy link
Contributor

ryoppippi commented Feb 20, 2025

Hi @samchon

Include lock files in your projects.

It has been pointed out previously in this project that lockfiles should not be included in a library project. As for myself, I had my doubts. I was wondering, because the majority of JS/TS library projects out there include lockfiles.

I did some research on this to be sure, and it seems that in the old node.js it was better not to include it. However, modern practice is that lock files should be managed even in library projects. This is to ensure that developers share the same dependencies. You mentioned that you were concerned that the behaviour might break when the dependent library versioned up, in which case the problem should be solved if we specify the appropriate version in package.json and make the fix!

Here are some sources I found:

Also, without a lockfile, we do not know which package manager (npm?yarn?pnpm?bun?) you are using for your project. This is very important to ensure reproducibility. Once we have experienced that different pnpm and npm have different build outputs, I think it is important to know which package manager you are using to build your project. You can use like npx only-allow pnpm in prepare script in package.json, but still lockfile is important for contributors.

Make no mistake, this issue is a proposal to improve the project and our collaboration. I'm excited to get the project going with you.

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

No branches or pull requests

1 participant