Skip to content

refactor: update jsdoc syntax #656

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

Merged
merged 1 commit into from
May 23, 2023
Merged

refactor: update jsdoc syntax #656

merged 1 commit into from
May 23, 2023

Conversation

bluwy
Copy link
Member

@bluwy bluwy commented May 23, 2023

some jsdocs nits:

  • space things up
  • use [paramName] instead of {type=} for optional params
  • use @typedef for one-off types in a file
  • fix jsdoc typecast not working in vscode

@dominikg dominikg merged commit fbfdd5c into refactor/ts2jsdoc May 23, 2023
@dominikg dominikg deleted the update-jsdoc branch May 23, 2023 14:49
dominikg added a commit that referenced this pull request May 24, 2023
* refactor: move types to .d.ts files in preparation of ts-to-jsdoc

* wip: convert ts to jsdoc

* wip: ts to jsdoc

* wip: ts to jsdoc conversion

* wip: finished jsdoc conversion, renamed .d.ts files to avoid collisions, added .js ext to imports

* test: add small wait for inspector icon to become visible to avoid flakiness in tests

* wip: move internal types into src/types, improve index.d.ts

* wip: move unit tests out of src dir and update filters

* chore: switch to eslint-plugin-n to get rid of some errors

* refactor: update jsdoc syntax (#656)

---------

Co-authored-by: Bjorn Lu <[email protected]>
dominikg added a commit that referenced this pull request May 25, 2023
* refactor: move types to .d.ts files in preparation of ts-to-jsdoc

* wip: convert ts to jsdoc

* wip: ts to jsdoc

* wip: ts to jsdoc conversion

* wip: finished jsdoc conversion, renamed .d.ts files to avoid collisions, added .js ext to imports

* test: add small wait for inspector icon to become visible to avoid flakiness in tests

* wip: move internal types into src/types, improve index.d.ts

* wip: move unit tests out of src dir and update filters

* chore: switch to eslint-plugin-n to get rid of some errors

* refactor: update jsdoc syntax (#656)

* refactor: rename prepared .ts files to .js, update scripts, add changeset

* fix: replace nullish assignment (requires node15) and enable error rules for invalid syntax that isn't downleveled anymore

* chore: fix types path

---------

Co-authored-by: Bjorn Lu <[email protected]>
dominikg added a commit that referenced this pull request May 25, 2023
* refactor: move types to .d.ts files in preparation of ts-to-jsdoc

* wip: convert ts to jsdoc

* wip: ts to jsdoc

* wip: ts to jsdoc conversion

* wip: finished jsdoc conversion, renamed .d.ts files to avoid collisions, added .js ext to imports

* test: add small wait for inspector icon to become visible to avoid flakiness in tests

* wip: move internal types into src/types, improve index.d.ts

* wip: move unit tests out of src dir and update filters

* chore: switch to eslint-plugin-n to get rid of some errors

* refactor: update jsdoc syntax (#656)

* refactor: rename prepared .ts files to .js, update scripts, add changeset

* fix: replace nullish assignment (requires node15) and enable error rules for invalid syntax that isn't downleveled anymore

* chore: fix types path

* remove tsup

* chore(types): replace rollup types with vite reexport

* chore: improve utility scripts, add publint

* chore: call check:types and check:publint in public packages via filter

* chore: disable tsc emit in inspector

* chore: remove noop build script

* chore: actually enable parallel processing for checks

---------

Co-authored-by: Bjorn Lu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants