This repository was archived by the owner on Jun 30, 2024. It is now read-only.
npm script postinstall -> prepare #203
Merged
Conversation
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
|
Thank you for the clear explanation and the fix! |
|
@julienp Thanks for the quick merge! |
tmr08c
added a commit
to tmr08c/vscode-elixir
that referenced
this pull request
Nov 21, 2020
The npm `postinstall` script runs both on local npm install as well as after being installed as a dependency of someone else’s project. The `prepare` script only runs on local npm install (and before publishing). [npm-scripts](https://docs.npmjs.com/cli/v6/using-npm/scripts) `vscode` is a `devDependency`, not a `dependency`, so if someone tries to install this package as a dependency of their own, the installation fails because `./node_modules/vscode` does not exist. One example of where it may be useful to install the package directly would be when using something like [andrewbranch/gatsby-remark-vscode](https://github.com/andrewbranch/gatsby-remark-vscode) which uses VS Code syntax highlighting and themes to generate the syntax highlighting in Gatsby sites. The `postinstall` to `prepare` change is [suggested](andrewbranch/gatsby-remark-vscode#129) by the author of the Gatsby plugin as a way to work with languates that aren't supported by VS Code out-of-the-box. This change seems to have works successfully in the past for other VS Code extensions as well: * juanfranblanco/vscode-solidity#186 * styled-components/vscode-styled-components#203
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What
The npm
postinstallscript runs both on localnpm installas well as after being installed as a dependency of someone else’s project. Thepreparescript only runs on localnpm install(and before publishing). [npm-scripts]Why
vscodeis a devDependency, not a dependency, so if someone tries to install this package as a dependency of their own, the installation fails because./node_modules/vscodedoes not exist.Wait, what?
I’m the maintainer of gatsby-remark-vscode, a plugin for the Gatsby static site system that lets blog authors harness VS Code’s syntax highlighting engine to style their code blocks. In the plugin’s v2, currently under development and released in alpha, I’m encouraging users to
npm installany language and theme packages they need directly from GitHub, provided the source is licensed appropriately. One user (@janosh) tried this method on this package (yarn add styled-components/vscode-styled-components), only to find that it can’t be installed since it tries unsuccessfully to set itself up for development/testing (andrewbranch/gatsby-remark-vscode#69).