-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
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
[WIP] feat(api/plugins): create plugins api documentation #242
Conversation
Part of me wants to separate these in to separate docs now that I'm think about the whole divide and conquer aspect of things, but in regards to the layout of the documentation, it makes sense for these things to all be on one page. @bebraw @jhnns @SpaceK33z Thoughts? |
|
Continuing on my thought dump before I move on to something else for now: I wonder, is there any way that we could generatively find all of the webpack hooks? Like do a lib search for all of the tapable.prorotype |
That sounds reasonable. recast can match the pattern if you can find a nice way to traverse the source (glob would work). |
I don't have much experience with building plugins, so can't comment on the specifics. So far I like the structure. Would it be possible to show an example of a very simple plugin and explain how it works? I think this would help many developers to actually get started quickly without scouting through the whole internet to find a piece of example code :). |
Referencing #36 here. |
sort: 2 | ||
--- | ||
|
||
**Tapable Instances** are classes in the webpack source code which have been extended or mixed in from class `Tapable`. For more information on `Tapable` visit the [tapable repository](https://github.com/webpack/tapable) or visit the [plugins overview](./plugins#tapable) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can I put in Tapable description from #36 here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes that's fine.
@TheLarkInn - Hey how do I contribute to this PR? You have this in a branch in your fork. I cloned your fork but I have no permission push to your branch. I'm not sure what git flow I should follow here. |
I agree with @bebraw 's suggestion on how to structure the content.
|
bump @TheLarkInn I would love to take this up. |
Oh hey! @pksjce Thanks for the bump. I literally just started looking into to continuing on this. |
I was thinking about having this have a sub folder structure @bebraw @jhnns:
|
The structure looks good to me. I expect you can push some specific content below how tos (or guides) and cross-reference. |
Closing in favor of #361 |
[WIP] This will be a big one, but I think we might as well get it started. I have fully scanned through the compiler calls for any
applyPlugins****()
functions, however I'm not 100% sure I have all the correct hooks.