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

feat: add package-lock.json and add CI check #40

Merged
merged 6 commits into from
Oct 9, 2024

Conversation

SamVerschueren
Copy link
Contributor

This PR adds package-lock.json back. This PR addresses the cons that are discussed in #14.

  1. We don't want a package-lock.json in EngineBlock projects, so we'd have to check that we don't end up adding those.
  • There are no starters here that get loaded into EB projects, so this is not an issue anymore.
  1. They can grow stale if we someone updates the package.json but not the package-lock.json, and we don't have any CI checking that.
  • This PR adds a check for CI.
  1. If the project has a stale package-lock.json, then installing dependencies becomes slower on StackBlitz that if we didn't have one (and were generating a new one on import).
  • Fixed because of the CI check.

},
"devDependencies": {
"npm": "10.2.3",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I install [email protected] (which is the one we use in WebContainer) so you don't have to install that version on your machine if you want to run the package:* scripts.

Copy link
Member

@Nemikolh Nemikolh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really nice! Some questions but we probably should do as follow-ups.

_scripts/package-lock-sync.mjs Show resolved Hide resolved
Comment on lines +85 to +87
new Error(
`The \`package-lock.json\` is not in sync with the \`package.json\` for starter \`${name}\`.`
)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍

@SamVerschueren SamVerschueren merged commit 293beeb into main Oct 9, 2024
2 checks passed
@SamVerschueren SamVerschueren deleted the chore/add-package-lock branch October 9, 2024 12:59
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

Successfully merging this pull request may close these issues.

3 participants