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.

Sign up for GitHub

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

Jump to bottom

chore: align JSDoc usage #568

Closed
dirkdev98 opened this issue Dec 23, 2020 · 3 comments
Closed

chore: align JSDoc usage #568

dirkdev98 opened this issue Dec 23, 2020 · 3 comments
Labels
prio 2 Issues with a lower prio, mostly features

Comments

@dirkdev98
Copy link
Member

  • Align used & generated doc blocks
  • Check if we are able to lint them automatically
@dirkdev98 dirkdev98 added the prio 1 Defines the highest prio issues label Dec 24, 2020
@dirkdev98
Copy link
Member Author

dirkdev98 commented Dec 26, 2020 •
edited
Loading

  • Allow selection of tags
  • Ban plain function & array type usage, ie Function instead of function(foo: boolean): void
  • Prefer lowercase primitives i.e number instead of Number

@dirkdev98 dirkdev98 added prio 2 Issues with a lower prio, mostly features and removed prio 1 Defines the highest prio issues labels Dec 28, 2020
dirkdev98 added a commit that referenced this issue Feb 21, 2021
@dirkdev98
feat(lint-config): add support for JSDoc linting
42584e3 
This is currently mostly stylish linting, will enforce proper types and stuff later.

The JSDoc linting is currently only enabled in with `CI=true`, since it is slow.

References #568
@dirkdev98 dirkdev98 mentioned this issue Feb 21, 2021
Merged
dirkdev98 added a commit that referenced this issue Feb 21, 2021
@dirkdev98
feat(lint-config): add support for JSDoc linting (#707)
c14c150 
This is currently mostly stylish linting, will enforce proper types and stuff later.

The JSDoc linting is currently only enabled in with `CI=true`, since it is slow.

References #568
@dirkdev98
Copy link
Member Author

We currently don't have the full configuration enabled. There are some things we need to look at before we can go all in on linted JSDoc. We need to help fixing jsdoctypeparser/jsdoctypeparser#131 for things like typeof import and { foo: boolean }[] support. And hopefully get some perf improvements in. Either by generating more efficiently, or by measuring and sending some patches to the upstream libraries. With JSDoc linting enabled, a big project goes from about 40 seconds to a full 4 minutes with --fix enabled.

Keeping this issue open for now, prioritized after some query builder improvements and more docs.

@dirkdev98
Copy link
Member Author

This is now checked by TS, so close it for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
prio 2 Issues with a lower prio, mostly features
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dirkdev98