chore: build on install so a git dependency resolves - #3
Merged
Conversation
npm runs `prepare` when a package is installed from a git URL, and `main` points into `dist/`, which is not committed. Without this, a git-URL install resolves to a package with no build output and every import from it fails. `prepublishOnly` does not cover that case: it only runs on `npm publish`. Until the first release lands on npm, a git dependency is the only way to consume this package, and this is what makes that work.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
mainpoints intodist/, which is gitignored, and there is nopreparescript — onlyprepublishOnly, which runs onnpm publish, not on install.So
npm install github:kingdom-community/github-docscurrently resolves to a package with no build output, and every import from it fails. Nothing is published to npm yet, so a git dependency is the only way anyone — including this org's own sites — can consume this package today.Adding
"prepare": "npm run build"makes npm build the package at install time from a git URL. It has no effect on a published install, wheredist/is already in the tarball.