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

Consider adding TSLint completed-docs rule #2026

Closed
jogold opened this issue Mar 15, 2019 · 6 comments
Closed

Consider adding TSLint completed-docs rule #2026

jogold opened this issue Mar 15, 2019 · 6 comments
Assignees
Labels
feature-request A feature should be added or improved. management/devenv Related to CDK development/build environment package/awslint Related to the CDK linter package

Comments

@jogold
Copy link
Contributor

jogold commented Mar 15, 2019

See https://palantir.github.io/tslint/rules/completed-docs/

I see a lot of PR comments/change requests about JSDoc...

@rix0rrr
Copy link
Contributor

rix0rrr commented Mar 18, 2019

This is probably a low-effort fix. I feel the correct long-term solution solution is to put this into jsii, so that we can also require the correct doc comment annotations.

@eladb
Copy link
Contributor

eladb commented Mar 18, 2019

+1 about adding to Jsii

@rix0rrr
Copy link
Contributor

rix0rrr commented Mar 18, 2019

Of course it's never so easy. Tried to enable the TSLint rule, the build choked on the very first package with a 100+ errors. jsii is going to be the only place where we can put this and not be annoying about it.

@eladb
Copy link
Contributor

eladb commented Mar 18, 2019

We can initially add it as a Jsii warning

@SomayaB SomayaB added management/devenv Related to CDK development/build environment needs-triage This issue or PR still needs to be triaged. feature-request A feature should be added or improved. and removed needs-triage This issue or PR still needs to be triaged. labels Sep 9, 2019
@NGL321 NGL321 assigned rix0rrr and unassigned NGL321 Oct 11, 2019
@NGL321 NGL321 added the package/awslint Related to the CDK linter package label Oct 11, 2019
@NGL321
Copy link
Contributor

NGL321 commented Oct 11, 2019

@rix0rrr does this still need attention?

@jogold
Copy link
Contributor Author

jogold commented Oct 29, 2019

Closed by #4645

@jogold jogold closed this as completed Oct 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request A feature should be added or improved. management/devenv Related to CDK development/build environment package/awslint Related to the CDK linter package
Projects
None yet
Development

No branches or pull requests

5 participants