Skip to content
Turns off all rules that are unnecessary or might conflict with Prettier.
TypeScript Shell JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.commitlintrc build: use r from @1stg/rollup-config for simple Sep 22, 2019
.editorconfig feat: first blood, should just work Sep 1, 2019
.eslintignore chore: bump dependencies, use union @1stG configs Jan 23, 2020
.eslintrc chore: bump dependencies, use union @1stG configs Jan 23, 2020
.gitignore chore: bump dependencies, use union @1stG configs Jan 23, 2020
.huskyrc.js feat: first blood, should just work Sep 1, 2019
.lintstagedrc.js
.prettierrc feat: first blood, should just work Sep 1, 2019
.remarkrc build: use r from @1stg/rollup-config for simple Sep 22, 2019
.renovaterc chore: add missing renovate configuration Sep 1, 2019
.travis.yml chore: add type-coverage support Sep 25, 2019
CHANGELOG.md chore(release): 0.2.2 Sep 25, 2019
LICENSE Initial commit Sep 1, 2019
README.md Update README.md Sep 27, 2019
codechecks.yml
deploy.sh feat: first blood, should just work Sep 1, 2019
index.ts chore: bump dependencies, use union @1stG configs Jan 23, 2020
package.json
tsconfig.json chore: add type-coverage support Sep 25, 2019
yarn.lock

README.md

remark-preset-prettier

Travis Codacy Grade type-coverage npm GitHub release

David Peer David David Dev

Conventional Commits JavaScript Style Guide Code Style: Prettier codechecks.io

Turns off all rules that are unnecessary or might conflict with Prettier.

TOC

Disabled remark-lint plugins

  1. blank-lines-1-0-2
  2. blockquote-indentation
  3. books-links
  4. checkbox-character-style
  5. code-block-style
  6. definition-case
  7. definition-spacing
  8. emphasis-marker
  9. fenced-code-marker
  10. final-newline
  11. hard-break-spaces
  12. heading-style
  13. heading-whitespace
  14. link-title-style
  15. list-item-bullet-indent
  16. list-item-content-indent
  17. list-item-indent
  18. list-item-spacing
  19. maximum-line-length
  20. no-blockquote-without-marker
  21. no-consecutive-blank-lines
  22. no-heading-content-indent
  23. no-inline-padding
  24. no-long-code
  25. no-table-indentation
  26. ordered-list-marker-style
  27. ordered-list-marker-value
  28. rule-style
  29. spaces-around-number
  30. spaces-around-word
  31. strong-marker
  32. table-cell-padding
  33. table-pipe-alignment
  34. table-pipes
  35. unordered-list-marker-style

Install

# yarn
yarn add -D remark-preset-prettier

# npm
npm i -D remark-preset-prettier

Usage

Via config like .remarkrc

{
  "plugins": [
    "preset-lint-consistent",
    "preset-lint-markdown-style-guide",
    "preset-lint-recommended",
    "preset-prettier"
  ]
}

Via ESLint(recommended)

Please use eslint-plugin-mdx which works perfectly with ESLint and Remark both together.

{
  "extends": "plugin:mdx/recommended"
}

Via remark-cli

remark . --use preset-lint-consistent preset-lint-markdown-style-guide preset-lint-recommended preset-prettier

Via Node API

const report = require('vfile-reporter')
const remark = require('remark')
const consistent = require('remark-preset-lint-consistent')
const styleGuide = require('remark-preset-lint-markdown-style-guide')
const recommended = require('remark-preset-lint-recommended')
const prettier = require('remark-preset-lint-prettier')

const file = remark()
  .use(consistent)
  .use(styleGuide)
  .use(recommended)
  .use(prettier)
  .processSync('_Hello world_')

console.log(report(file))
You can’t perform that action at this time.