# jest-runner-markdownlint

> Markdown Lint runner for Jest

Latest version **0.1.3** (published 2019-10-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install jest-runner-markdownlint
pnpm add jest-runner-markdownlint
yarn add jest-runner-markdownlint
bun add jest-runner-markdownlint
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2019-10-02 |
| First published | 2018-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Michael Irigoyen |
| Maintainers | goyney |
| Keywords | jest, markdown, lint |

## Links

- npm: https://www.npmjs.com/package/jest-runner-markdownlint
- Repository: https://github.com/goyney/jest-runner-markdownlint
- Homepage: https://github.com/goyney/jest-runner-markdownlint#readme
- Issues: https://github.com/goyney/jest-runner-markdownlint/issues
- npm.io page: https://npm.io/package/jest-runner-markdownlint

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [strip-ansi](https://npm.io/package/strip-ansi.md) ^5.2.0
- [text-table](https://npm.io/package/text-table.md) ^0.2.0
- [markdownlint](https://npm.io/package/markdownlint.md) ^0.16.0
- [create-jest-runner](https://npm.io/package/create-jest-runner.md) ^0.5.3

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2019-10-02
- 0.1.2 — 2018-10-03
- 0.1.1 — 2018-08-20
- 0.1.0 — 2018-08-20

## README

<div align="center">
  <img width="150" src="https://cdn.worldvectorlogo.com/logos/markdown.svg">
  <a href="https://facebook.github.io/jest/">
    <img height="100" vspace="" hspace="25" src="https://cdn.worldvectorlogo.com/logos/jest.svg">
  </a>
  <h1>jest-runner-markdownlint</h1>
  <p>Markdown Lint runner for Jest</p>
</div>

# Usage

## Install

Install `jest` _(Jest 21+)_ and `jest-runner-markdownlint`

```bash
yarn add --dev jest jest-runner-markdownlint
```

### Add it to your Jest config

In your `package.json`

```json
{
  "jest": {
    "runner": "jest-runner-markdownlint",
    "displayName": "Markdown Lint",
    "testMatch": ["<rootDir>/src/**/*.md"],
    "moduleFileExtensions": ["md"]
  }
}
```

Or in `jest.config.js`

```js
module.exports = {
  runner: 'jest-runner-markdownlint',
  displayName: 'Markdown Lint',
  testMatch: ['<rootDir>/src/**/*.md'],
  moduleFileExtensions: ['md']
}
```

### Run Jest

```bash
yarn jest
```

---
_Source: https://npm.io/package/jest-runner-markdownlint · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._