mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-05 23:37:04 +00:00
Added explicit options to 'markdownlint'. (#34861)
* Added explicit options to 'markdownlint'. * Update index.d.ts * Addressed lints. * Silence quotation errors.
This commit is contained in:
Daniel Rosenwasser
committed by
Pranav Senthilnathan
Pranav Senthilnathan
parent
7bb03173ee
commit
21e09f2827
Vendored
+229
-2
@@ -1,7 +1,8 @@
|
||||
// Type definitions for markdownlint 0.6
|
||||
// Type definitions for markdownlint 0.13
|
||||
// Project: https://github.com/DavidAnson/markdownlint
|
||||
// Definitions by: ark120202 <https://github.com/ark120202>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
// TypeScript Version: 2.1
|
||||
|
||||
declare function markdownlint(
|
||||
options: markdownlint.MarkdownlintOptions,
|
||||
@@ -18,7 +19,233 @@ declare namespace markdownlint {
|
||||
function readConfigSync(file: string): MarkdownlintConfig;
|
||||
|
||||
interface MarkdownlintConfig {
|
||||
[rule: string]: boolean | { [key: string]: any };
|
||||
[rule: string]: undefined | string | number | boolean | { [key: string]: any };
|
||||
|
||||
/**
|
||||
* Default state for all rules.
|
||||
* @default true
|
||||
*/
|
||||
default?: boolean;
|
||||
|
||||
/**
|
||||
* Heading levels should only increment by one level at a time.
|
||||
*
|
||||
* This rule is triggered when you skip heading levels in a markdown document.
|
||||
*/
|
||||
"heading-increment"?: boolean;
|
||||
/**
|
||||
* Heading levels should only increment by one level at a time.
|
||||
*
|
||||
* This rule is triggered when you skip heading levels in a markdown document.
|
||||
*/
|
||||
"header-increment"?: boolean;
|
||||
|
||||
/**
|
||||
* First heading should be a top level heading.
|
||||
* @deprecated
|
||||
* @see {"first-line-heading"}
|
||||
* @see {"first-line-h1"}
|
||||
*/
|
||||
"first-heading-h1"?: boolean | {
|
||||
level?: number;
|
||||
};
|
||||
/**
|
||||
* First heading should be a top level heading.
|
||||
* @deprecated
|
||||
* @see {"first-line-heading"}
|
||||
* @see {"first-line-h1"}
|
||||
*/
|
||||
"first-header-h1"?: MarkdownlintConfig["first-heading-h1"];
|
||||
|
||||
/**
|
||||
* Heading style.
|
||||
* @default "consistent"
|
||||
*/
|
||||
"heading-style"?: {
|
||||
style?: "consistent" | "atx" | "atx_closed" | "setext" | "setext_with_atx" | "setext_with_atx_closed"
|
||||
};
|
||||
/**
|
||||
* Heading style.
|
||||
* @default "consistent"
|
||||
*/
|
||||
"header-style"?: MarkdownlintConfig["heading-style"];
|
||||
|
||||
/**
|
||||
* This rule is triggered when the symbols used in the document for unordered list items do not match the configured unordered list style:
|
||||
*
|
||||
* ```md
|
||||
* * Item 1
|
||||
* + Item 2
|
||||
* - Item 3
|
||||
* ```
|
||||
*
|
||||
* @default "consistent"
|
||||
*/
|
||||
"ul-style"?: {
|
||||
style?: "consistent" | "asterisk" | "plus" | "dash" | "sublist";
|
||||
};
|
||||
|
||||
/**
|
||||
* Inconsistent indentation for list items at the same level
|
||||
*/
|
||||
"list-indent"?: boolean;
|
||||
|
||||
/**
|
||||
* Consider starting bulleted lists at the beginning of the line.
|
||||
*/
|
||||
"ul-start-left"?: boolean;
|
||||
|
||||
/**
|
||||
* This rule is triggered when list items are not indented by the configured number of spaces.
|
||||
* @default 2
|
||||
*/
|
||||
"ul-indent"?: boolean | {
|
||||
indent?: number;
|
||||
};
|
||||
|
||||
"no-trailing-spaces"?: boolean | {
|
||||
br_spaces?: number;
|
||||
list_item_empty_lines?: boolean
|
||||
};
|
||||
|
||||
"no-hard-tabs"?: boolean | {
|
||||
code_blocks?: boolean;
|
||||
};
|
||||
|
||||
"no-reversed-links"?: boolean;
|
||||
|
||||
"no-multiple-blanks"?: boolean | {
|
||||
maximum?: number;
|
||||
};
|
||||
|
||||
"line-length"?: boolean | {
|
||||
line_length: number;
|
||||
heading_line_length: number;
|
||||
/**
|
||||
* Exclude this rule for code blocks.
|
||||
*/
|
||||
code_blocks?: boolean;
|
||||
/**
|
||||
* Exclude this rule for tables.
|
||||
*/
|
||||
tables?: boolean;
|
||||
/**
|
||||
* Exclude this rule for headings/headers.
|
||||
*/
|
||||
headings?: boolean;
|
||||
/**
|
||||
* Exclude this rule for headings/headers (alias for `headings`).
|
||||
*/
|
||||
headers?: boolean;
|
||||
};
|
||||
|
||||
"commands-show-output"?: boolean;
|
||||
|
||||
"no-missing-space-atx"?: boolean;
|
||||
|
||||
"no-multiple-space-atx"?: boolean;
|
||||
|
||||
"no-missing-space-closed-atx"?: boolean;
|
||||
|
||||
"no-multiple-space-closed-atx"?: boolean;
|
||||
|
||||
"blanks-around-headings"?: boolean | {
|
||||
lines_above?: number;
|
||||
lines_below?: number;
|
||||
};
|
||||
|
||||
"blanks-around_headers"?: MarkdownlintConfig["blanks-around-headings"];
|
||||
|
||||
"heading-start-left"?: boolean;
|
||||
"header-start-left"?: MarkdownlintConfig["heading-start-left"];
|
||||
|
||||
"no-duplicate-heading"?: boolean | {
|
||||
siblings_only?: boolean;
|
||||
allow_different_nesting?: boolean;
|
||||
};
|
||||
"no-duplicate-header"?: MarkdownlintConfig["no-duplicate-heading"];
|
||||
|
||||
"single-title"?: boolean | {
|
||||
/**
|
||||
* @default 1
|
||||
*/
|
||||
level?: number;
|
||||
/**
|
||||
* @default "^\s*title:"
|
||||
*/
|
||||
front_matter_title?: string;
|
||||
};
|
||||
"single-h1"?: MarkdownlintConfig["single-title"];
|
||||
|
||||
"no-trailing-punctuation"?: boolean | {
|
||||
/**
|
||||
* @default ".,;:!?"
|
||||
*/
|
||||
punctuation?: string;
|
||||
};
|
||||
|
||||
"no-multiple-space-blockquote"?: boolean;
|
||||
|
||||
"no-blanks-blockquote"?: boolean;
|
||||
|
||||
"ol-prefix"?: boolean | {
|
||||
style?: "one" | "ordered" | "one_or_ordered" | "zero";
|
||||
};
|
||||
|
||||
"list-marker-space"?: boolean | {
|
||||
"ul_single"?: number;
|
||||
"ol_single"?: number;
|
||||
"ul_multi"?: number;
|
||||
"ol_multi"?: number;
|
||||
};
|
||||
|
||||
"blanks-around-fences"?: boolean;
|
||||
|
||||
"blanks-around-lists"?: boolean;
|
||||
|
||||
"no-inline-html"?: boolean | {
|
||||
allowed_elements?: string[];
|
||||
};
|
||||
|
||||
"no-bare-urls"?: boolean;
|
||||
|
||||
"hr-style"?: {
|
||||
/**
|
||||
* @default consistent
|
||||
*/
|
||||
style: string;
|
||||
};
|
||||
|
||||
"no-emphasis-as-heading"?: boolean | {
|
||||
punctuation?: string;
|
||||
};
|
||||
"no-emphasis-as-header"?: MarkdownlintConfig["no-emphasis-as-heading"];
|
||||
|
||||
"no-space-in-emphasis"?: boolean;
|
||||
|
||||
"no-space-in-code"?: boolean;
|
||||
|
||||
"no-space-in-links"?: boolean;
|
||||
|
||||
"fenced-code-language"?: boolean;
|
||||
|
||||
"first-line-heading"?: {
|
||||
level?: number;
|
||||
front_matter_title?: string;
|
||||
};
|
||||
"first-line-h1"?: MarkdownlintConfig["first-line-heading"];
|
||||
|
||||
"no-empty-links"?: boolean;
|
||||
|
||||
"required-headings"?: string[];
|
||||
"required-headers"?: MarkdownlintConfig["required-headings"];
|
||||
|
||||
"proper-names"?: {
|
||||
names?: string[] | null;
|
||||
code_blocks?: boolean;
|
||||
};
|
||||
|
||||
"no-alt-text"?: boolean;
|
||||
}
|
||||
|
||||
interface MarkdownlintOptions {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import * as markdownlint from 'markdownlint';
|
||||
import markdownlint = require('markdownlint');
|
||||
|
||||
const config: markdownlint.MarkdownlintConfig = {
|
||||
default: true,
|
||||
@@ -17,7 +17,7 @@ const options: markdownlint.MarkdownlintOptions = {
|
||||
};
|
||||
|
||||
// $ExpectType MarkdownlintResults
|
||||
const results = markdownlint.sync(options);
|
||||
markdownlint.sync(options);
|
||||
|
||||
markdownlint(options, (err, results) => {
|
||||
// $ExpectType Error | null
|
||||
@@ -26,9 +26,8 @@ markdownlint(options, (err, results) => {
|
||||
// $ExpectType MarkdownlintResults
|
||||
results;
|
||||
|
||||
const resultString: string = results.toString();
|
||||
// $ExpectError
|
||||
results.toString() as markdownlint.MarkdownlintResult[];
|
||||
// $ExpectType string
|
||||
results.toString();
|
||||
|
||||
const fileErrors: markdownlint.MarkdownlintResult[] = results[
|
||||
'file.md'
|
||||
@@ -36,3 +35,48 @@ markdownlint(options, (err, results) => {
|
||||
const firstFileError: markdownlint.MarkdownlintResult = fileErrors[0];
|
||||
const firstFileErrorRule: string = firstFileError.ruleName;
|
||||
});
|
||||
|
||||
// tslint:disable: object-literal-key-quotes
|
||||
markdownlint.sync({
|
||||
config: {
|
||||
"default": false,
|
||||
"heading-style": {
|
||||
"style": "atx"
|
||||
},
|
||||
"ul-style": {
|
||||
"style": "asterisk"
|
||||
},
|
||||
"list-indent": true,
|
||||
"ul-start-left": true,
|
||||
"ul-indent": {
|
||||
"indent": 4
|
||||
},
|
||||
"no-trailing-spaces": true,
|
||||
"no-hard-tabs": true,
|
||||
"no-reversed-links": true,
|
||||
"no-multiple-blanks": true,
|
||||
"no-missing-space-atx": true,
|
||||
"no-multiple-space-atx": true,
|
||||
"blanks-around-headings": true,
|
||||
"heading-start-left": true,
|
||||
"no-trailing-punctuation": {
|
||||
"punctuation": ".,;:!"
|
||||
},
|
||||
"no-multiple-space-blockquote": true,
|
||||
"no-blanks-blockquote": true,
|
||||
"ol-prefix": {
|
||||
"style": "ordered"
|
||||
},
|
||||
"list-marker-space": true,
|
||||
"blanks-around-fences": true,
|
||||
"blanks-around-lists": true,
|
||||
"no-bare-urls": true,
|
||||
"hr-style": {
|
||||
"style": "---"
|
||||
},
|
||||
"no-space-in-emphasis": true,
|
||||
"no-space-in-links": true,
|
||||
"fenced-code-language": true
|
||||
}
|
||||
});
|
||||
// tslint:enable: object-literal-key-quotes
|
||||
|
||||
Reference in New Issue
Block a user