Skip to content

Commit

Permalink
Docs: Syntax highlight Markdown (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 authored and btmills committed Jun 25, 2019
1 parent fdacf0c commit 2de2490
Showing 1 changed file with 66 additions and 56 deletions.
122 changes: 66 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,95 +32,105 @@ 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

The processor will convert HTML comments immediately preceding a code block into JavaScript block comments and insert them at the beginning of the source code that it passes to ESLint. This permits configuring ESLint via configuration comments while keeping the configuration comments themselves hidden when the markdown is rendered. Comment bodies are passed through unmodified, so the plugin supports any [configuration comments](http://eslint.org/docs/user-guide/configuring) supported by ESLint itself.

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

Expand Down

0 comments on commit 2de2490

Please sign in to comment.