Implement `.d.ts` generation from jsdoc comments#662

Merged

kewisch merged 19 commits intokewisch:mainfrom jannikac:main

Jun 13, 2024

+596-500

Commits on Jun 13, 2024

add barebones typescript config

jannikac
authored and
kewisch
committed
updated component to work correctly with generated d.ts

jannikac
authored and
kewisch
committed
replace typescript with @rollup/plugin-typescript, integrate into build and add types to package.json

jannikac
authored and
kewisch
committed
Augment generated jsdoc to make modules more explicit
kewisch
committed
JSDoc improvements for typescript
kewisch
committed
Use long name in jsdoc links
kewisch
committed
move tsconfig to rollup typescript plugin config

jannikac
authored and
kewisch
committed
fix incorrect parameter name

jannikac
authored and
kewisch
committed
improve jsdoc types to allow for generation of .d.ts files

jannikac
authored and
kewisch
committed
improve ts generation for everything that uses @types and complex @params or @returns

jannikac
authored and
kewisch
committed
move @typedefs to types.d.js to allow for importing and resolving via ts

jannikac
authored and
kewisch
committed
drop prefix for typdef'd types and hack plugin to allow links to work

jannikac
authored and
kewisch
committed
changed bare import to import type syntax and added plugin to fix jsdoc compatibility

jannikac
authored and
kewisch
committed
added @ignore to imports so they are not documented in the generated docs

jannikac
authored and
kewisch
committed
removed last ICAL. reference for consistency

jannikac
authored and
kewisch
committed
added jsdoc-collect-types.cjs plugin to collect classnames and typedefs for the jsdoc-ical.cjs plugin

jannikac
authored and
kewisch
committed
update plugin to handle @properties and move parserState typedef to types.d.js for consistency

jannikac
authored and
kewisch
committed
added MPL headers, comments and newlines

jannikac
authored and
kewisch
committed
updated plugins to work correctly by calling jsdoc twice, once to collect symbols, once to generate docs

jannikac
authored and
kewisch
committed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `.d.ts` generation from jsdoc comments#662

Commits on Jun 13, 2024

add barebones typescript config

updated component to work correctly with generated d.ts

replace typescript with @rollup/plugin-typescript, integrate into build and add types to package.json

Augment generated jsdoc to make modules more explicit

JSDoc improvements for typescript

Use long name in jsdoc links

move tsconfig to rollup typescript plugin config

fix incorrect parameter name

improve jsdoc types to allow for generation of .d.ts files

improve ts generation for everything that uses @types and complex @params or @returns

move `@typedefs` to types.d.js to allow for importing and resolving via ts

drop prefix for typdef'd types and hack plugin to allow links to work

changed bare import to import type syntax and added plugin to fix jsdoc compatibility

added `@ignore` to imports so they are not documented in the generated docs

removed last `ICAL.` reference for consistency

added `jsdoc-collect-types.cjs` plugin to collect classnames and typedefs for the `jsdoc-ical.cjs` plugin

update plugin to handle `@properties` and move `parserState` typedef to `types.d.js` for consistency

added MPL headers, comments and newlines

updated plugins to work correctly by calling jsdoc twice, once to collect symbols, once to generate docs