generate jsdoc/typescript/flow

[mxab]

Hi,
would it be possible to produce jsdoc on the generated code so it could be minified with closure compilers advanced mode?

[Rich-Harris]

That's an interesting idea. I don't see any reason in principle why that couldn't happen, though it's not something I'm particularly familiar with

[mxab]

I extended a simple output:
https://github.com/mxab/svelte-sample/blob/master/bundle.js

with jsdocs
https://github.com/mxab/svelte-sample/blob/master/bundle_withdocs.js

the first one (bundle.js) can be compile with the SIMPLE mode
the second (bundle_withdocs.js) can be compiled with ADVANCE
https://closure-compiler.appspot.com

Simple:
Compiled Size: 694 bytes gzipped (1.38KB uncompressed)
Advanced:
Compiled Size: 646 bytes gzipped (1.18KB uncompressed)

as you can see a tremendous slim down ;)
but I guess it can be tuned better, I'm not an expert on the cc

[PaulBGD]

+1 for making this work better on closure compiler, thanks for putting in the work @mxab

[mxab]

an maybe very experimental thought would be that if it contains proper jsdocs closure compiler's refasterJS feature could refactor the code and put in some short methods for common not minifiable calls

let's say for all x.appendChild(y) (in the todomvc part 48 times) to something like

function aC(x,y){
 x.appendChild(y)
}

aC(i,l) ... aC(a,b) ... aC(foo,bar) //all 48 times

[Rich-Harris]

@mxab thanks for the sample code, it's very helpful. It's likely that the internals will change a bit due to e.g. #9, so it's probably best for us to hold off on adding jsdoc stuff for the moment, but I'm definitely keen to explore this in future (maybe adding e.g. TypeScript annotations or Flow types would be another option – annotations: 'jsdoc'/annotations: 'flow' etc, though it's not an area I'm particularly familiar with). Adding the 'one day' milestone 😀

For things like repeated appendChild calls, we do plan to add helper functions (see e.g. #50).

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[benmccann]

We have TypeScript types now