remark-lint - npm Package Compare versions

Comparing version 9.1.0 to 9.1.1

index.d.ts

@@ -6,3 +6,3 @@ /**
  *
- * @type {import('unified').Plugin<void[], Root>}
+ * @type {import('unified').Plugin<Array<void>, Root>}
  */
@@ -9,0 +9,0 @@ export default function remarkLint():

index.js

@@ -12,3 +12,3 @@ /**
  *
- * @type {import('unified').Plugin<void[], Root>}
+ * @type {import('unified').Plugin<Array<void>, Root>}
  */
@@ -19,5 +19,5 @@ export default function remarkLint() {
 
-/** @type {import('unified').Plugin<void[], Root>} */
+/** @type {import('unified').Plugin<Array<void>, Root>} */
 function lintMessageControl() {
   return remarkMessageControl({name: 'lint', source: 'remark-lint'})
 }

package.json

 {
   "name": "remark-lint",
-  "version": "9.1.0",
+  "version": "9.1.1",
   "description": "remark plugin to lint Markdown code style",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -11,19 +11,35 @@ # ![remark-lint][logo]
 
-[**remark**][remark] plugin to lint Markdown code style.
+**[remark][]** plugin to support configuration comments for remark lint rules.
 
-Read more about `remark-lint` on [the monorepo readme][readme].
+See the [monorepo readme][mono] for more info on remark lint.
 
-This package doesn’t do much other than [suppressing messages][suppres] through
-comments.
+## Contents
 
-If you’re using [presets][], they already include `remark-lint` itself.
-If you’re using just plugins, you have to include `remark-lint` explicitly.
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`unified().use(remarkLint)`](#unifieduseremarklint)
+*   [Compatibility](#compatibility)
+*   [Contribute](#contribute)
+*   [License](#license)
 
+## What is this?
+
+This package is a [unified][] ([remark][]) plugin to add support for
+configuration comments to control remark lint rule messages.
+
+## When should I use this?
+
+This project is useful when you’re using remark lint rules and want to let
+authors ignore messages in certain cases.
+This package is already included in all our presets.
+If you’re building a preset yourself, you should include this package.
+
 ## Install
 
-This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
-Node 12+ is needed to use it and it must be `import`ed instead of `require`d.
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -33,6 +49,45 @@ npm install remark-lint
 
+In Deno with [Skypack][]:
+
+```js
+import remarkLint from 'https://cdn.skypack.dev/remark-lint@9?dts'
+```
+
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import remarkLint from 'https://cdn.skypack.dev/remark-lint@9?min'
+</script>
+```
+
 ## Use
 
-You probably want to use it on the CLI through a config file:
+On the API:
 
+```js
+import {read} from 'to-vfile'
+import {reporter} from 'vfile-reporter'
+import {remark} from 'remark'
+import remarkLint from 'remark-lint'
+
+main()
+
+async function main() {
+  const file = await remark()
+    .use(remarkLint)
+    .process(await read('example.md'))
+
+  console.error(reporter(file))
+}
+```
+
+On the CLI:
+
+```sh
+remark --use remark-lint example.md
+```
+
+On the CLI in a config file (here a `package.json`):
+
 ```diff
@@ -43,3 +98,3 @@ …
      …
-+    "lint",
++    "remark-lint",
      …
@@ -51,23 +106,21 @@ ]
 
-Or use it on the CLI directly
+## API
 
-```sh
-remark -u lint readme.md
-```
+This package exports no identifiers.
+The default export is `remarkLint`.
 
-Or use this on the API:
+### `unified().use(remarkLint)`
 
-```diff
- import {remark} from 'remark'
- import {reporter} from 'vfile-reporter'
- import remarkLint from 'remarkLint'
+Add support for configuration comments.
+There are no options.
 
- remark()
-+  .use(remarkLint)
-   .process('_Emphasis_ and **importance**')
-   .then((file) => {
-     console.error(reporter(file))
-   })
-```
+See [Ignore warnings][ignore] in the monorepo readme for how to use it.
 
+## Compatibility
+
+Projects maintained by the unified collective are compatible with all maintained
+versions of Node.js.
+As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
+Our projects sometimes work with older versions, but this is not guaranteed.
+
 ## Contribute
@@ -87,3 +140,3 @@
 
-[logo]: https://raw.githubusercontent.com/remarkjs/remark-lint/02295bc/logo.svg?sanitize=true
+[logo]: https://raw.githubusercontent.com/remarkjs/remark-lint/014fca7/logo.svg?sanitize=true
 
@@ -116,2 +169,6 @@ [build-badge]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[skypack]: https://www.skypack.dev
+
 [npm]: https://docs.npmjs.com/cli/install
@@ -121,7 +178,7 @@
 
-[contributing]: https://github.com/remarkjs/.github/blob/HEAD/contributing.md
+[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
 
-[support]: https://github.com/remarkjs/.github/blob/HEAD/support.md
+[support]: https://github.com/remarkjs/.github/blob/main/support.md
 
-[coc]: https://github.com/remarkjs/.github/blob/HEAD/code-of-conduct.md
+[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
 
@@ -132,8 +189,8 @@ [license]: https://github.com/remarkjs/remark-lint/blob/main/license
 
+[unified]: https://github.com/unifiedjs/unified
+
 [remark]: https://github.com/remarkjs/remark
 
-[readme]: https://github.com/remarkjs/remark-lint#readme
+[mono]: https://github.com/remarkjs/remark-lint
 
-[suppres]: https://github.com/remarkjs/remark-lint#configuring-remark-lint
-
-[presets]: https://github.com/remarkjs/remark-lint#list-of-presets
+[ignore]: https://github.com/remarkjs/remark-lint#ignore-warnings

No alert changes

Improved metrics

Total package byte prevSize

6814

increased by23.44%

Number of lines in readme file

189

increased by43.18%

No dependency changes