chore: add a prepare step so that git dependencies build #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is convenient to be able to specify dependencies in package.json
which point to particular git commits. One use case is allowing
dependencies on PRs which are not yet merged and published to npm.org.
In theory this should be achievable via:
"jest-chrome": "extend-chrome/vitest-chrome#some-PR-branch-name"
https://docs.npmjs.com/cli/v8/configuring-npm/package-json#git-urls-as-dependencies
states:
> When installing from a git repository, the presence of certain fields
> in the package.json will cause npm to believe it needs to perform a
> build. To do so your repository will be cloned into a temporary
> directory, all of its deps installed, relevant scripts run, and the
> resulting directory packed and installed.
>
> This flow will occur if your git dependency uses workspaces, or if
> any of the following scripts are present:
>
> - `build`
> - `prepare`
> - `prepack`
> - `preinstall`
> - `install`
> - `postinstall`
And indeed jest-chrome already has a `build` script.
However it seems that, at least with pnpm, the presence of a `build`
script is not sufficient.
So add a `prepare` script which just dispatches to the `build` script.
This makes jest-chrome installable via a git dependency.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Community guidelines:
contributing guidelines
and
code of conduct
This PR contains:
Are tests included?
Breaking Changes?
List any relevant issue numbers: none
Description
It is convenient to be able to specify dependencies in
package.jsonwhich point to particular git commits. One use case is allowing dependencies on PRs which are not yet merged and published to npm.org.In theory this should be achievable via:
https://docs.npmjs.com/cli/v8/configuring-npm/package-json#git-urls-as-dependencies states:
And indeed jest-chrome already has a
buildscript.However it seems that, at least with pnpm, the presence of a
buildscript is not sufficient.So add a
preparescript which just dispatches to thebuildscript. This makes jest-chrome installable via a git dependency.See also probil#2