summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md')
-rw-r--r--tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md122
1 files changed, 66 insertions, 56 deletions
diff --git a/tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md b/tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md
index aa5e2b8ff7..22f5099b65 100644
--- a/tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md
+++ b/tools/node_modules/eslint/node_modules/eslint-plugin-markdown/README.md
@@ -32,42 +32,46 @@ eslint --ext md .
It will lint `js`, `javascript`, `jsx`, or `node` [fenced code blocks](https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks) in your Markdown documents:
- ```js
- // This gets linted
- var answer = 6 * 7;
- console.log(answer);
- ```
+````markdown
+```js
+// This gets linted
+var answer = 6 * 7;
+console.log(answer);
+```
- ```JavaScript
- // This also gets linted
+```JavaScript
+// This also gets linted
- /* eslint quotes: [2, "double"] */
+/* eslint quotes: [2, "double"] */
- function hello() {
- console.log("Hello, world!");
- }
- hello();
- ```
+function hello() {
+ console.log("Hello, world!");
+}
+hello();
+```
- ```jsx
- // This gets linted too
- var div = <div className="jsx"></div>;
- ```
+```jsx
+// This gets linted too
+var div = <div className="jsx"></div>;
+```
- ```node
- // And this
- console.log(process.version);
- ```
+```node
+// And this
+console.log(process.version);
+```
+````
Blocks that don't specify either `js`, `javascript`, `jsx`, or `node` syntax are ignored:
- ```
- This is plain text and doesn't get linted.
- ```
+````markdown
+```
+This is plain text and doesn't get linted.
+```
- ```python
- print("This doesn't get linted either.")
- ```
+```python
+print("This doesn't get linted either.")
+```
+````
## Configuration Comments
@@ -75,52 +79,58 @@ The processor will convert HTML comments immediately preceding a code block into
This example enables the `browser` environment, disables the `no-alert` rule, and configures the `quotes` rule to prefer single quotes:
- <!-- eslint-env browser -->
- <!-- eslint-disable no-alert -->
- <!-- eslint quotes: ["error", "single"] -->
+````markdown
+<!-- eslint-env browser -->
+<!-- eslint-disable no-alert -->
+<!-- eslint quotes: ["error", "single"] -->
- ```js
- alert('Hello, world!');
- ```
+```js
+alert('Hello, world!');
+```
+````
Each code block in a file is linted separately, so configuration comments apply only to the code block that immediately follows.
- Assuming `no-alert` is enabled in `.eslintrc`, the first code block will have no error from `no-alert`:
+````markdown
+Assuming `no-alert` is enabled in `.eslintrc`, the first code block will have no error from `no-alert`:
- <!-- eslint-env browser -->
- <!-- eslint-disable no-alert -->
+<!-- eslint-env browser -->
+<!-- eslint-disable no-alert -->
- ```js
- alert("Hello, world!");
- ```
+```js
+alert("Hello, world!");
+```
- But the next code block will have an error from `no-alert`:
+But the next code block will have an error from `no-alert`:
- <!-- eslint-env browser -->
+<!-- eslint-env browser -->
- ```js
- alert("Hello, world!");
- ```
+```js
+alert("Hello, world!");
+```
+````
## Skipping Blocks
Sometimes it can be useful to have code blocks marked with `js` even though they don't contain valid JavaScript syntax, such as commented JSON blobs that need `js` syntax highlighting. Standard `eslint-disable` comments only silence rule reporting, but ESLint still reports any syntax errors it finds. In cases where a code block should not even be parsed, insert a non-standard `<!-- eslint-skip -->` comment before the block, and this plugin will hide the following block from ESLint. Neither rule nor syntax errors will be reported.
- There are comments in this JSON, so we use `js` syntax for better
- highlighting. Skip the block to prevent warnings about invalid syntax.
+````markdown
+There are comments in this JSON, so we use `js` syntax for better
+highlighting. Skip the block to prevent warnings about invalid syntax.
- <!-- eslint-skip -->
+<!-- eslint-skip -->
- ```js
- {
- // This code block is hidden from ESLint.
- "hello": "world"
- }
- ```
+```js
+{
+ // This code block is hidden from ESLint.
+ "hello": "world"
+}
+```
- ```js
- console.log("This code block is linted normally.");
- ```
+```js
+console.log("This code block is linted normally.");
+```
+````
## Fix issues automatically