Skip to content

API - Plugins #37

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

Closed
TheLarkInn opened this issue Jul 10, 2016 · 8 comments
Closed

API - Plugins #37

TheLarkInn opened this issue Jul 10, 2016 · 8 comments

Comments

@TheLarkInn
Copy link
Member

TheLarkInn commented Jul 10, 2016

Stub.

Overview Page: Give Overview of what this section will cover.

  • Explain Schema and Type notation used in guide.
  • Tapable
  • Compiler instance
  • Compilation instance
  • Module
    • Module vs ModuleFactory
    • NormalModuleFactory
    • ContextModuleFactory
  • NMF instance
  • CMF instance
  • Maintemplate instance
  • Parser instance
  • Resolver instance
  • Recommended Reading
  • Implementing Custom Plugin Hooks (like html-webpack-plugin)

WIP

@TheLarkInn
Copy link
Member Author

Can use this to link to individual issues I will create for each of these bullet points.

@mxstbr
Copy link
Collaborator

mxstbr commented Jul 10, 2016

Implementing Custom Plugin Hooks (like html-webpack-plugin)

We use those in Carte Blanche too (@jantimon helped us build it, so that's why 😁) so I can document that!

@jantimon
Copy link
Contributor

Well webpack is very modular - the custom plugin hooks are exactly the same as the "standard" hooks.

@TheLarkInn
Copy link
Member Author

TheLarkInn commented Jul 10, 2016

@jantimon Exactly. I think one we start educating developers about Tapabale etc. Plugins and how they work will be way easier.

Does anyone have a really good understanding of Tapable besides @sokra

@jantimon
Copy link
Contributor

jantimon commented Jul 10, 2016

Tapable is very simple - you can just read the source it contains only very small helper functions.

It is similar to event emitter however it allows plugins to queue up and modify the given value.
Unfortunately it doesn't allow to listen to an event only once or to unbind events.

@TheLarkInn
Copy link
Member Author

@jantimon would you be willing to tackle the Tapable page? Like explain how it works, even though it's pretty simple code we want to explain it to somone in a clear and consice way. I was thinking about writing the schema/typescript definition for it as well.

@jantimon
Copy link
Contributor

I am on vacation for the next 3 weeks but maybe afterwards.

@bebraw bebraw changed the title Develop - Plugin API API - Plugins Jul 24, 2016
@bebraw bebraw added the API label Jul 24, 2016
@bebraw bebraw mentioned this issue Jul 24, 2016
dear-lizhihua added a commit to docschina/webpack.js.org that referenced this issue Jan 8, 2017
@skipjack
Copy link
Collaborator

Closing for the same reason mentioned in #36. Let's open more targeted issues/prs if there's still work left to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants