Turns off all rules that are unnecessary or might conflict with Prettier.
MIT License
Turns off all rules that are unnecessary or might conflict with Prettier.
If you're not ready for native ESM, top level await or latest remark-lint
plugins, please use versions <1
, see #61 and #97 for more details.
# yarn
yarn add -D remark-preset-prettier
# npm
npm i -D remark-preset-prettier
.remarkrc
{
"plugins": [
"preset-lint-consistent",
"preset-lint-markdown-style-guide",
"preset-lint-recommended",
"preset-prettier"
]
}
Please use eslint-plugin-mdx which works perfectly with ESLint and Remark both together.
{
"extends": "plugin:mdx/recommended"
}
remark . --use preset-lint-consistent preset-lint-markdown-style-guide preset-lint-recommended preset-prettier
import report from 'vfile-reporter'
import remark from 'remark'
import consistent from 'remark-preset-lint-consistent'
import styleGuide from 'remark-preset-lint-markdown-style-guide'
import recommended from 'remark-preset-lint-recommended'
import prettier from 'remark-preset-prettier'
const file = remark()
.use(consistent)
.use(styleGuide)
.use(recommended)
.use(prettier)
.processSync('_Hello world_')
console.log(report(file))
retext-sentence-spacing is a plugin of retext, and remark-retext makes it possible to use retext plugins together with remark, and retext-sentence-spacing may conflict with Prettier.
However, remark-retext can only be enabled once what means we can not simply disable rule retext-sentence-spacing in this preset which is actually meaningless.
If you do have problems between retext-sentence-spacing and Prettier, you have to override the whole configuration of remark-retext like following:
// .remarkrc.js
import wooorm from 'retext-preset-wooorm'
import sentenceSpacing from 'retext-sentence-spacing'
export default {
plugins: [
'preset-wooorm', // other preset(s) or plugin(s)
'preset-prettier',
[
'retext',
unified()
.use(wooorm) // retext preset(s)
.use({
plugins: [[sentenceSpacing, false]],
}),
],
],
}
Detailed changes for each release are documented in CHANGELOG.md.