remark-lint
Advanced tools
remark-lint - npm Package Compare versions
Comparing version 6.0.4 to 6.0.5
@@ -7,4 +7,4 @@ 'use strict' | ||
| // `remark-lint`. This adds support for ignoring stuff from messages | ||
| // (`<!--lint ignore-->`). | ||
| // `remark-lint`. | ||
| // This adds support for ignoring stuff from messages (`<!--lint ignore-->`). | ||
| // All rules are in their own packages and presets. | ||
@@ -11,0 +11,0 @@ function lint() { |
| { | ||
| "name": "remark-lint", | ||
| "version": "6.0.4", | ||
| "description": "Lint markdown with remark", | ||
| "version": "6.0.5", | ||
| "description": "remark plugin to lint Markdown code style", | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "unified", | ||
| "remark", | ||
| "plugin", | ||
| "mdast", | ||
| "markdown", | ||
| "lint", | ||
| "validate", | ||
| "remark" | ||
| "validate" | ||
| ], | ||
@@ -12,0 +15,0 @@ "repository": "https://github.com/remarkjs/remark-lint/tree/master/packages/remark-lint", |
@@ -6,10 +6,10 @@ # ![remark-lint][logo] | ||
| [![Downloads][downloads-badge]][downloads] | ||
| [![Chat][chat-badge]][chat] | ||
| [![Size][size-badge]][size] | ||
| [![Sponsors][sponsors-badge]][collective] | ||
| [![Backers][backers-badge]][collective] | ||
| [![Chat][chat-badge]][chat] | ||
| `remark-lint` is a markdown code style linter built on [**remark**][remark], a | ||
| powerful markdown processor powered by [plugins][]. | ||
| [**remark**][remark] plugin to lint Markdown code style. | ||
| Read more about `remark-lint` on [the monorepo readme][repo]. | ||
| Read more about `remark-lint` on [the monorepo readme][readme]. | ||
@@ -19,4 +19,9 @@ This package doesn’t do much other than [suppressing messages][suppres] through | ||
| If you’re using [presets][], they already include `remark-lint` itself. | ||
| If you’re using just plugins, you have to include `remark-lint` explicitly. | ||
| ## Install | ||
| [npm][]: | ||
| ```sh | ||
@@ -26,2 +31,47 @@ npm install remark-lint | ||
| ## Use | ||
| You probably want to use it on the CLI through a config file: | ||
| ```diff | ||
| ... | ||
| "remarkConfig": { | ||
| "plugins": [ | ||
| ... | ||
| + "lint", | ||
| ... | ||
| ] | ||
| } | ||
| ... | ||
| ``` | ||
| Or use it on the CLI directly | ||
| ```sh | ||
| remark -u lint readme.md | ||
| ``` | ||
| Or use this on the API: | ||
| ```diff | ||
| var remark = require('remark'); | ||
| var report = require('vfile-reporter'); | ||
| remark() | ||
| + .use(require('remark-lint')) | ||
| .process('_Emphasis_ and **importance**', function (err, file) { | ||
| console.error(report(err || file)); | ||
| }); | ||
| ``` | ||
| ## Contribute | ||
| See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways | ||
| to get started. | ||
| See [`support.md`][support] for ways to get help. | ||
| This project has a [Code of Conduct][coc]. | ||
| By interacting with this repository, organisation, or community you agree to | ||
| abide by its terms. | ||
| ## License | ||
@@ -31,7 +81,5 @@ | ||
| <!-- Definitions --> | ||
| [logo]: https://raw.githubusercontent.com/remarkjs/remark-lint/02295bc/logo.svg?sanitize=true | ||
| [build-badge]: https://img.shields.io/travis/remarkjs/remark-lint.svg | ||
| [build-badge]: https://img.shields.io/travis/remarkjs/remark-lint/master.svg | ||
@@ -48,5 +96,5 @@ [build]: https://travis-ci.org/remarkjs/remark-lint | ||
| [chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
| [size-badge]: https://img.shields.io/bundlephobia/minzip/remark-lint.svg | ||
| [chat]: https://spectrum.chat/unified/remark | ||
| [size]: https://bundlephobia.com/result?p=remark-lint | ||
@@ -59,8 +107,16 @@ [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg | ||
| [repo]: https://github.com/remarkjs/remark-lint#readme | ||
| [chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
| [remark]: https://github.com/remarkjs/remark | ||
| [chat]: https://spectrum.chat/unified/remark | ||
| [plugins]: https://github.com/remarkjs/remark/blob/master/doc/plugins.md | ||
| [npm]: https://docs.npmjs.com/cli/install | ||
| [health]: https://github.com/remarkjs/.github | ||
| [contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md | ||
| [support]: https://github.com/remarkjs/.github/blob/master/support.md | ||
| [coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md | ||
| [license]: https://github.com/remarkjs/remark-lint/blob/master/license | ||
@@ -70,2 +126,8 @@ | ||
| [remark]: https://github.com/remarkjs/remark | ||
| [readme]: https://github.com/remarkjs/remark-lint#readme | ||
| [suppres]: https://github.com/remarkjs/remark-lint#configuring-remark-lint | ||
| [presets]: https://github.com/remarkjs/remark-lint#list-of-presets |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by49.91%
4238
- Number of lines in readme file
- increased by95.38%
127