remarkjs/remark-lint
1
1
Fork 0
mirror of https://github.com/remarkjs/remark-lint.git synced 2024-10-26 19:31:42 +03:00
Code Issues Projects Releases Wiki Activity

Fix types of rule arguments

Browse Source 
Closes GH-289.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
This commit is contained in:
Jack Bates 2022-04-04 01:13:16 -07:00 committed by GitHub
parent a3f5b01c6d
commit d1e24ff097
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
packages/unified-lint-rule/index.d.ts vendored
View File

@ -19,7 +19,7 @@ export function lintRule<Tree extends Node = Node, Options = unknown>(
name: string | RuleMeta,
rule: Rule<Tree, Options>
): Plugin<
void[] | [Options | Label | Severity] | [boolean | Label | Severity, Options],
void[] | [Options | [boolean | Label | Severity, (Options | undefined)?]],
Tree
>

3
readme.md
View File

@ -269,7 +269,8 @@ remark()
.use(remarkLintUnorderedListMarkerStyle, '*')
.use(remarkLintUnorderedListMarkerStyle, ['on', '*'])
.use(remarkLintUnorderedListMarkerStyle, [1, '*'])
// The following rule accepts a number, numbers *must* be passed in arrays:
// The following rule accepts a number:
.use(remarkLintMaximumLineLength, 72)
.use(remarkLintMaximumLineLength, ['on', 72])
.use(remarkLintMaximumLineLength, [1, 72])
```