This repository has been archived by the owner on Aug 7, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add types for tslint-rule-documentation
- Loading branch information
Showing
2 changed files
with
11 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
declare module "tslint-rule-documentation" { | ||
export interface IRuleResult { | ||
found: boolean; // true if the rule is a TSLint core rule, or a known plugin rule, false otherwise | ||
uri: string; // If found is true, uri of the documentation of the rule. If found is false, uri of the contribution guidelines | ||
} | ||
/** Find the url for the documentation of a TSLint rule | ||
* @param {string} ruleID The ID of a TSLint rule such as `no-var-keyword` or `__example/foo` | ||
*/ | ||
export function getRuleUri(ruleID: string): IRuleResult | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters