Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation on adding a starterkit needs amending #11

Closed
moda-schneij opened this issue Feb 16, 2018 · 4 comments
Closed

Documentation on adding a starterkit needs amending #11

moda-schneij opened this issue Feb 16, 2018 · 4 comments
Assignees
Labels

Comments

@moda-schneij
Copy link
Contributor

moda-schneij commented Feb 16, 2018

I found the following issue:

The documentation on adding a starter kit seems a little off.

I've added the starterkit-mustache-demo, but that's inserted scripts in my source/js file that aren't being picked up during development.

I think I'll need to expose them as modules and either append to my entry js or expose as new entries. Or figure out how to update the copy plugin to catch non-modular JS and copy from source to public.

This may be an issue of using non-webpack starterkits with the webpack wrapper.

In any case, the documentation says

To install a specific StarterKit from GitHub type:

npm run add [starterkit-vendor/starterkit-name]

npm run patternlab:loadstarterkit --kit=[starterkit-name]

But there is no add script in package.json

Recommendations on Solutions:

Amend documentation to explain how to do this, and/or how to deal with problems with available starter kits. Thanks.

@mbulfair
Copy link
Member

Yup you are correct, it's a typo the first line should be npm install [starterkit-name] then the second. I will get that corrected.

@Josh68
Copy link
Contributor

Josh68 commented Feb 16, 2018

Thanks. Still working out how to customize this wrapper in certain ways (like adding the html-webpack-plugin to my webpack.app.js, as it seems to blow away the patternlab iframe wrapper), but thanks for making it. I hope it eventually becomes a new standard approach for the node version.

@mbulfair
Copy link
Member

Have you seen this: https://github.com/Comcast/patternlab-edition-node-webpack#setting-the-webpack-merge-options there's a link there to a readme that goes over the webpack merge options.

@Josh68
Copy link
Contributor

Josh68 commented Feb 16, 2018

Yes, I did read that and the merge docs for webpack. Just experimenting to see how things work. Patternlab adds a layer of indirection (or that's how I'm seeing it) with the wrapper around the iframe that contains your actual bundles. That said, I have gotten some customizations to work, and merging options seem sensible.

@mbulfair mbulfair added the bug label Feb 16, 2018
@mbulfair mbulfair self-assigned this Feb 16, 2018
Josh68 added a commit to Josh68/patternlab-edition-node-webpack that referenced this issue Feb 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants