(Plugin) API Rewrite by skipjack · Pull Request #1754 · webpack/webpack.js.org (original) (raw)

@TheLarkInn @sokra I could really use some help with finishing the documentation on this branch soon (mostly just need to know the missing hook descriptions). I also think we need to update the following utility READMEs as such:

tapable

The updated docs were actually pretty solid and easy to follow. I think all that's missing is a description for each available hook.

enhanced-resolve

It seems the README for this package is totally out of date with the current code (though I could be wrong). I think the following needs to be documented:

• Each available hook (preferably using the same format we use here)
  • Type of underlying tapable hook
  • Brief description and optionally a small example
  • Any parameters passed
• A description of each available class method and their parameters (e.g. doResolve)

@mlcohen, seeing as you dug into this a bit in #1458, would you be willing to help out with updating the enhanced-resolve README? You may want to collaborate with @sokra and @TheLarkInn as I think the API changed a bit recently.

As for the documentation of both these utilities (tapable and enhanced-resolve) in this site, I'm tightening up the existing documentation in this pull request and linking out to each package for details. IMHO the public-facing APIs of those packages should be documented in only one place: their respective READMEs. The only thing that should be noted on this site is how the core of webpack uses their APIs internally. As I've mentioned elsewhere, once those READMEs are updated, we can pull them into a new "Utilities" section in this site (similar to Loaders and Plugins).

Trying to have this PR in a good place for review within the next 24 - 48 hours. Hoping we can then work together to knock this stuff out as this should solidify the API section of our site significantly and hopefully clarify a lot for our readers/users.