This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 889
New completed-docs "tags" property doesn't work with single-line doc comments #3365
Comments
Can you try without the curly braces: "content": {"see": ".*"}, Looks like an issue with the docs and examples
That seems to be the way it works. At least that's how it's done in the tests. |
Thanks for the quick reply! Just tested with the two configurations below and reproduced the same result: ...
"completed-docs": [true, {
"classes": {"visibilities": ["exported"]},
"enums": {"visibilities": ["exported"]},
"functions": {"visibilities": ["exported"]},
"interfaces": {"visibilities": ["exported"]},
"methods": {"privacies": ["protected", "public"]},
"namespaces": {"visibilities": ["exported"]},
"properties": {"privacies": ["protected", "public"]},
"types": {"visibilities": ["exported"]},
"variables": {"visibilities": ["exported"]},
"tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}
}],
... ...
"completed-docs": [true, {
"classes": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"enums": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"functions": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"interfaces": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"methods": {"privacies": ["protected", "public"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"namespaces": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"properties": {"privacies": ["protected", "public"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"types": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}},
"variables": {"visibilities": ["exported"], "tags": {"content": {"see": ".*"}, "exists": ["inheritDoc"]}}
}],
... |
Testing the rule revealed that the new tags logic doesn't handle singleline JSDoc. |
Interesting, thanks! I'll wait for that to be resolved then before re-enabling this rule. |
4 tasks
|
3 tasks
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Bug Report
TypeScript code being linted
with
tslint.json
configuration:(Also tested with
tags
copied and pasted as a nested property of all of its sibling properties.)Actual behavior
Expected behavior
No errors.
The text was updated successfully, but these errors were encountered: