How we used JSDoc & Webpack to write some custom JavaScript decorators & annotations

1

Webpack

You could write a pre-build script to write the docs into a file and then read that in at compile time, but where's the fun in that? We use Webpack for our bundling needs, which means we can write a custom loader. This will run JSDoc over the file for us, play around with the data a little bit and give us a nice output. We can use this output to configure which data comes out the model.

#Web Application Bundler #JS Build Tools #Module Bundler 220 social mentions

2

JSDoc

We encapsulate a lot of our data in JavaScript classes/models, this means we can store sparse data and access it through the models, with the models automatically substituting defaults and creating more complex getters for us. As part of a new feature, we want to be able to share of some this data, but not all of it... And this is where we came up with an interesting solution that involves JSDoc decorators & annotations...

#Documentation #Documentation As A Service & Tools #Developer Tools 48 social mentions