Skip to content
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

DOCS: add typehints #220

Closed
jkowalleck opened this issue Dec 8, 2021 · 0 comments · Fixed by #321
Closed

DOCS: add typehints #220

jkowalleck opened this issue Dec 8, 2021 · 0 comments · Fixed by #321
Labels
documentation QA Quality Assurance
Milestone

Comments

@jkowalleck
Copy link
Member

jkowalleck commented Dec 8, 2021

current implementation is untyped undocumented javascript

as a user of this library i want type docs, so that i know expected parameter types.
as a user of this library i want type docs, so that i know possible throws.
as a user of this library i want type docs, so that i know possible return types.
as a user of this library i want type docs, so that tools/IDE assistance is improved.

options:

  • rewrite the whole thing in typescript.
  • add jsdoc to methods, properties, classes,
  • add type definition files (*.d.ts) to the project

enforce typehints via eslint rules: https://github.com/gajus/eslint-plugin-jsdoc

@jkowalleck jkowalleck added this to the v4 milestone Dec 8, 2021
@jkowalleck jkowalleck added QA Quality Assurance documentation labels Dec 8, 2021
jkowalleck added a commit that referenced this issue Jan 27, 2022
part of #233
part of #220
jkowalleck added a commit that referenced this issue Jan 28, 2022
fixes #246
fixes #248
part of #233
part of #220

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
jkowalleck added a commit that referenced this issue Jan 28, 2022
fixes #246
fixes #248
part of #233
part of #220

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
jkowalleck added a commit that referenced this issue Jan 28, 2022
detect component.author - fixes #246
normalize empty component.version - fixes #248
add JSDoc - #220
use private properties - #233

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
jkowalleck added a commit that referenced this issue Jan 29, 2022
detect component.author - fixes #246
normalize empty component.version - fixes #248
add JSDoc - #220
use private properties - #233

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
jkowalleck added a commit that referenced this issue Feb 2, 2022
…ormalize optional `version` (#247)

* Changed
  * Private/protected properties of Component models are no longer directly accessible. ([#233] via [#247])  
    Access via public getter/setter.
* Fixed
  * Normalization guarantees `component.version`. ([#248] via [#247])
  * Component's constructor may detect & set `autor` based on package info. ([#246] via [#247])
* Added
  * JSDoc for Component model. ([#220] via [#247])

[#220]: #220
[#233]: #233
[#246]: #246
[#247]: #247
[#248]: #248

---

* Component rework

detect component.author - fixes #246
normalize empty component.version - fixes #248
add JSDoc - #220
use private properties - #233

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* use `@babel/eslint-parser`

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* update locked dependencies and lockfile format

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* CT/CI generates jsdoc & play with jsdoc

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* wrote history

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* slacked components getterusage internally

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

* fixed JSDoc `object` annotation

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck mentioned this issue Oct 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation QA Quality Assurance
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant