From 3ed19ef9491fd711c81ced06480c199f2adb35ba Mon Sep 17 00:00:00 2001 From: Brett Zamir Date: Thu, 11 Sep 2025 19:38:29 +0800 Subject: [PATCH] refactor: remove unnecessary lines in declaration file Also: - docs: add `type-formatting` to README --- .README/README.md | 1 + README.md | 1 + src/iterateJsdoc.cts | 3 --- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.README/README.md b/.README/README.md index ba7563828..f00bf3237 100644 --- a/.README/README.md +++ b/.README/README.md @@ -432,4 +432,5 @@ non-default-recommended fixer). |||[sort-tags](./docs/rules/sort-tags.md#readme)|Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups| |:heavy_check_mark:|:wrench:|[tag-lines](./docs/rules/tag-lines.md#readme)|Enforces lines (or no lines) between tags| ||:wrench:|[text-escaping](./docs/rules/text-escaping.md#readme)|This rule can auto-escape certain characters that are input within block and tag descriptions| +||:wrench:|[type-formatting](./docs/rules/type-formatting.md#readme)|Formats JSDoc type values| |:heavy_check_mark:||[valid-types](./docs/rules/valid-types.md#readme)|Requires all types/namepaths to be valid JSDoc, Closure compiler, or TypeScript types (configurable in settings)| diff --git a/README.md b/README.md index eb81a02de..e554e28f1 100644 --- a/README.md +++ b/README.md @@ -469,4 +469,5 @@ non-default-recommended fixer). |||[sort-tags](./docs/rules/sort-tags.md#readme)|Sorts tags by a specified sequence according to tag name, optionally adding line breaks between tag groups| |:heavy_check_mark:|:wrench:|[tag-lines](./docs/rules/tag-lines.md#readme)|Enforces lines (or no lines) between tags| ||:wrench:|[text-escaping](./docs/rules/text-escaping.md#readme)|This rule can auto-escape certain characters that are input within block and tag descriptions| +||:wrench:|[type-formatting](./docs/rules/type-formatting.md#readme)|Formats JSDoc type values| |:heavy_check_mark:||[valid-types](./docs/rules/valid-types.md#readme)|Requires all types/namepaths to be valid JSDoc, Closure compiler, or TypeScript types (configurable in settings)| diff --git a/src/iterateJsdoc.cts b/src/iterateJsdoc.cts index 8bb743633..4a4a89663 100644 --- a/src/iterateJsdoc.cts +++ b/src/iterateJsdoc.cts @@ -5,7 +5,4 @@ const exp = iterateJsdoc as ((iterator: JsdocVisitor, ruleConfig: RuleConfig) => parseComment: typeof parseComment }; -exp.getSettings = getSettings; -exp.parseComment = parseComment; - export = exp;