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: adds checkDevEngines #116

Merged
merged 22 commits into from
Sep 11, 2024
Merged

feat: adds checkDevEngines #116

merged 22 commits into from
Sep 11, 2024

Conversation

reggi
Copy link
Contributor

@reggi reggi commented Sep 5, 2024

This PR adds the logic to check the new devEngines package.json field.

@reggi reggi requested a review from a team as a code owner September 5, 2024 14:43
@wraithgar wraithgar changed the title Adds checkDevEngines feat: Adds checkDevEngines Sep 5, 2024
@wraithgar

This comment was marked as resolved.

@wraithgar

This comment was marked as resolved.

@wraithgar wraithgar changed the title feat: Adds checkDevEngines Adds checkDevEngines Sep 5, 2024
package.json Outdated Show resolved Hide resolved
@reggi reggi changed the title Adds checkDevEngines feat: adds checkDevEngines Sep 5, 2024
@reggi reggi mentioned this pull request Sep 5, 2024
@voxpelli
Copy link

voxpelli commented Sep 6, 2024

For those wondering what devEngines is about, here's what I believe is the home of it: openjs-foundation/package-metadata-interoperability-collab-space#15

@wraithgar
Copy link
Member

Thanks @voxpelli the cli PR links there and goes into more detail

@reggi reggi changed the title feat: adds checkDevEngines feat: adds checkDevEngines Sep 6, 2024
@reggi reggi merged commit ebf9b9f into main Sep 11, 2024
21 checks passed
@reggi reggi deleted the reggi/dev-engines branch September 11, 2024 14:26
@github-actions github-actions bot mentioned this pull request Sep 11, 2024
reggi pushed a commit that referenced this pull request Sep 11, 2024
🤖 I have created a release *beep* *boop*
---


##
[7.1.0](v7.0.0...v7.1.0)
(2024-09-11)
### Features
*
[`ebf9b9f`](ebf9b9f)
[#116](#116) adds
checkDevEngines (#116) (@reggi)
### Bug Fixes
*
[`ec4066b`](ec4066b)
[#118](#118) skip network
requests in report.getReport() (#118) (@wraithgar)

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
reggi added a commit to npm/cli that referenced this pull request Oct 3, 2024
This PR adds a check for `devEngines` in the current projects
`package.json` as defined in the spec here:

openjs-foundation/package-metadata-interoperability-collab-space#15

This PR utilizes a `checkDevEngines` function defined within
`npm-install-checks` open here:
npm/npm-install-checks#116

The goal of this pr is to have a check for specific npm commands
`install`, and `run` consult the `devEngines` property before execution
and check if the current system / environment. For `npm ` the runtime
will always be `node` and the `packageManager` will always be `npm`, if
a project is defined as not those two envs and it's required we'll
throw.

> Note the current `engines` property is checked when you install your
dependencies. Each packages `engines` are checked with your environment.
However, `devEngines` operates on commands for maintainers of a package,
service, project when install and run commands are executed and is meant
to enforce / guide maintainers to all be using the same engine / env and
or versions.
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.

5 participants