Chore: Automatically install example dependencies #164
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
Previously, CI was explicitly running the `install-examples` script as its own step. This was also necessary but not documented locally, so `git clone; npm install; npm test` would show a couple failures when the examples inherited the wrong ESLint dependency. The examples' dependencies should now be installed automatically when running `npm install` locally without any arguments. Originally reported in #163.
nzakas
approved these changes
Nov 24, 2020
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.
Previously, CI was explicitly running the
install-examplesscript as its own step. This was also necessary but not documented locally, sogit clone; npm install; npm testwould show a couple failures when the examples inherited the wrong ESLint dependency. The examples' dependencies should now be installed automatically when runningnpm installlocally without any arguments.Originally reported in #163.
For reviewers: Based on my reading of https://docs.npmjs.com/cli/v6/using-npm/scripts, this is a safe usage of the
preparescript, but I'd appreciate a second set of eyes on that. The goal is to run as part ofnpm installlocally but not when the plugin is a dependency. The additional runs before packing and publishing are unnecessary but I don't think they should cause a problem. I'll do arc.1release after merging this just to make sure there aren't any unexpected kinks. The fallback plan is just to document the second step.