Showing 3,908 of 3,908 total issues
Line length Open
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Bare URL used Open
Here's a codesandbox that shows this issue: https://codesandbox.io/s/react-mops-issue-template-jodfo
- Read upRead up
- Exclude checks
MD034 - Bare URL used
Tags: links, url
Aliases: no-bare-urls
This rule is triggered whenever a URL is given that isn't surrounded by angle brackets:
For more information, see http://www.example.com/.
To fix this, add angle brackets around the URL:
For more information, see <http:></http:>.
Rationale: Without angle brackets, the URL isn't converted into a link in many markdown parsers.
Note: if you do want a bare URL without it being converted into a link, enclose it in a code block, otherwise in some markdown parsers it will be converted:
`http://www.example.com`
Headers should be surrounded by blank lines Open
## Motivation
- Read upRead up
- Exclude checks
MD022 - Headers should be surrounded by blank lines
Tags: headers, blank_lines
Aliases: blanks-around-headers
This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:
# Header 1
Some text
Some more text
## Header 2
To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):
# Header 1
Some text
Some more text
## Header 2
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.
space indentation expected Open
setInitialPosition(nextPosition);
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
rotation
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
onMouseDown: setRightDown,
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
onMouseDown: setBottomRightDown,
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
setInitialSize,
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
handlePosition,
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
const nextSize = handleSize(position, altKey, shiftKey);
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
setSize(nextSize);
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
{
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
Line length Open
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Line length Open
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
- Read upRead up
- Exclude checks
MD013 - Line length
Tags: line_length
Aliases: line-length Parameters: linelength, codeblocks, tables (number; default 80, boolean; default true)
This rule is triggered when there are lines that are longer than the configured line length (default: 80 characters). To fix this, split the line up into multiple lines.
This rule has an exception where there is no whitespace beyond the configured line length. This allows you to still include items such as long URLs without being forced to break them in the middle.
You also have the option to exclude this rule for code blocks and tables. To
do this, set the code_blocks
and/or tables
parameters to false.
Code blocks are included in this rule by default since it is often a requirement for document readability, and tentatively compatible with code rules. Still, some languages do not lend themselves to short lines.
Headers should be surrounded by blank lines Open
## Issues closed
- Read upRead up
- Exclude checks
MD022 - Headers should be surrounded by blank lines
Tags: headers, blank_lines
Aliases: blanks-around-headers
This rule is triggered when headers (any style) are either not preceded or not followed by a blank line:
# Header 1
Some text
Some more text
## Header 2
To fix this, ensure that all headers have a blank line both before and after (except where the header is at the beginning or end of the document):
# Header 1
Some text
Some more text
## Header 2
Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse headers that don't have a blank line before, and will parse them as regular text.
space indentation expected Open
rotation
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
const nextSize = handleSize(position, altKey, shiftKey);
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
const nextPosition = handlePosition(position, altKey, shiftKey);
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
setBottomDown,
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.
space indentation expected Open
},
- Read upRead up
- Exclude checks
Rule: indent
Enforces indentation with tabs or spaces.
Rationale
Using only one of tabs or spaces for indentation leads to more consistent editor behavior, cleaner diffs in version control, and easier programmatic manipulation.
Notes
- Has Fix
Config
One of the following arguments must be provided:
-
spaces
enforces consistent spaces. -
tabs
enforces consistent tabs.
A second optional argument specifies indentation size:
-
2
enforces 2 space indentation. -
4
enforces 4 space indentation.
Indentation size is required for auto-fixing, but not for rule checking.
NOTE: auto-fixing will only convert invalid indent whitespace to the desired type, it will not fix invalid whitespace sizes.
Examples
"indent": true,spaces
"indent": true,spaces,4
"indent": true,tabs,2
Schema
{
"type": "array",
"items": [
{
"type": "string",
"enum": [
"tabs",
"spaces"
]
},
{
"type": "number",
"enum": [
2,
4
]
}
],
"minLength": 0,
"maxLength": 5
}
For more information see this page.