Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Removed use of type checker from completed-docs #3557

Merged
merged 11 commits into from
Feb 23, 2019
Merged

Removed use of type checker from completed-docs #3557

merged 11 commits into from
Feb 23, 2019

Conversation

JoshuaKGoldberg
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg commented Dec 6, 2017

Uses tsutil's getJsDoc instead.

PR checklist

Overview of change:

Makes completed-docs an untyped rule by removing usages of the TSLint program. It instead uses tsutils's getJsDoc.

CHANGELOG.md entry:

[enhancement] Made completed-docs an untyped rule
[bugfix] Fixed single-line comment parsing for completed-docs

Uses tsutil's `getJsDoc` instead.
test/rules/completed-docs/accessors/test.ts.lint Outdated Show resolved Hide resolved
src/rules/completedDocsRule.ts Outdated Show resolved Hide resolved
src/rules/completedDocsRule.ts Outdated Show resolved Hide resolved
ajafff
ajafff previously requested changes Dec 12, 2017
src/rules/completedDocsRule.ts Outdated Show resolved Hide resolved
@JoshuaKGoldberg
Copy link
Contributor Author

JoshuaKGoldberg commented Dec 13, 2017

(will look at version-specific failures soon - will also add test case for mismatched names in accessors) ✔️

@suchanlee
Copy link
Contributor

whats the status of this PR?

@JoshuaKGoldberg
Copy link
Contributor Author

I think I've addressed all of @ajafff's feedback. It's been through a few merges.

Also, some amusing errata: this also fixes the TS 2.8 issue with the [Symbol.iterator]() {} doc comment.

@buu700
Copy link
Contributor

buu700 commented Jun 27, 2018

Any recent updates on this? (Very eager to have back my completed-docs that hasn't worked since December 2016!) Would it be worth merging #3841 as a stopgap until this is completely ready to go?

Copy link
Contributor

@johnwiseheart johnwiseheart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable to me. Theres a couple of new issues springing up from completed-docs (#4399, #4398, #4396), so I'd love to get this out before working on them with the hope that it might help to fix them.

@adidahiya adidahiya added this to the 5.13.0 milestone Jan 10, 2019
@adidahiya adidahiya merged commit bd4a048 into palantir:master Feb 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
6 participants