Support templates in scoped packages#7991
Merged
mrmckeb merged 4 commits intofacebook:masterfrom Nov 18, 2019
Merged
Conversation
|
Hi klasbj! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
Contributor
|
Thanks @klasbj, this looks great. |
Contributor
|
Thanks again! |
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 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.
Fixing issue #7985.
I learned a bit about some... interesting... NPM behavior while testing. With only a regex check that the package name started with
cra-template-, it still fell back tocra-template-@scope/package. Ifscope/packagehappened to be an accessible Github project, npm would download and install some version (I'm not quite sure how it decided which version...) of that repository as the template.The solution I came up with was adding the prefix to the package name, while leaving the scope part unchanged. Maybe not 100% intuitive, but consistent with the behaviour of non-scoped packages.
Test cases
Plain, uses
cra-templateTemplate without prefix (
typescript), usescra-template-typescriptTemplate with prefix (
cra-template-typescript)Template in scoped npm package with prefix (
@klasbj/cra-template-scoped)Template in scoped npm package without prefix (
@klasbj/scoped), uses@klasbj/cra-template-scopedScoped template with matching Github project, attempts to use
@klasbj/cra-template-scoped-cra-template, and not my Github projectklasbj/scoped-cra-template