Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Suggest disabling strict in .md files (fixes #94) #95

Merged
merged 2 commits into from
Jun 4, 2018
Merged

Docs: Suggest disabling strict in .md files (fixes #94) #95

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d76dc4
Docs: Suggest disabling strict in .md files (fixes #94)
btmills May 26, 2018
45924bd
Docs: Recommend enabling parserOptions.impliedStrict
btmills May 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,23 @@ Since code blocks are not files themselves but embedded inside a Markdown docume
- `eol-last`
- `unicode-bom`

### Strict

The `strict` rule is technically satisfiable inside of code blocks, but most users will likely want to disable it. To disable `strict` inside all `.md` files, add the following override to your `.eslintrc.json`:

```js
// .eslintrc.json
{
// ...
"overrides": [{
"files": ["**/*.md"],
"rules": {
"strict": "off"
}
}]
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also recommend parserOptions: { impliedStrict: true } so that users can effectively always have strict mode?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea! Updated.

```

## Contributing

```sh
Expand Down