remark-preset-lint-recommended - npm Package Compare versions

Comparing version 6.1.1 to 6.1.2

index.js

 /**
- * @fileoverview
- *   remark preset to configure `remark-lint` with settings that prevent
- *   mistakes or stuff that fails across vendors.
+ * ## When should I use this?
+ *
+ * You can use this package to check that markdown follows some best practices.
+ *
+ * @summary
+ *   Preset of remark-lint rules to warn for some likely problems.
  */
@@ -6,0 +9,0 @@

package.json

 {
   "name": "remark-preset-lint-recommended",
-  "version": "6.1.1",
+  "version": "6.1.2",
   "description": "remark preset to configure remark-lint with rules that prevent mistakes or stuff that fails across vendors.",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -13,8 +13,30 @@ <!--This file is generated-->
 
-remark preset to configure `remark-lint` with settings that prevent
-mistakes or stuff that fails across vendors.
+Preset of [`remark-lint`][mono] rules to warn for some likely problems.
 
+## Contents
+
+*   [What is this?](#what-is-this)
+*   [When should I use this?](#when-should-i-use-this)
+*   [Rules](#rules)
+*   [Install](#install)
+*   [Use](#use)
+*   [API](#api)
+    *   [`unified().use(remarkPresetLintRecommended)`](#unifieduseremarkpresetlintrecommended)
+*   [Compatibility](#compatibility)
+*   [Contribute](#contribute)
+*   [License](#license)
+
+## What is this?
+
+This package is a [unified][] ([remark][]) preset, specifically consisting of
+`remark-lint` rules.
+Lint rules check markdown code style.
+
+## When should I use this?
+
+You can use this package to check that markdown follows some best practices.
+
 ## Rules
 
-This preset configures [`remark-lint`](https://github.com/remarkjs/remark-lint) with the following rules:
+This preset configures [`remark-lint`][mono] with the following rules:
 
@@ -40,7 +62,5 @@ | Rule | Setting |
 
-This package is [ESM only][esm]:
-Node 12+ is needed to use it and it must be `imported`ed instead of `required`d.
+This package is [ESM only][esm].
+In Node.js (version 12.20+, 14.14+, or 16.0+), install with [npm][]:
 
-[npm][]:
-
 ```sh
@@ -50,13 +70,53 @@ npm install remark-preset-lint-recommended
 
-This package exports no identifiers.
-The default export is `remarkPresetLintRecommended`.
+In Deno with [Skypack][]:
 
+```js
+import remarkPresetLintRecommended from 'https://cdn.skypack.dev/remark-preset-lint-recommended@6?dts'
+```
+
+In browsers with [Skypack][]:
+
+```html
+<script type="module">
+  import remarkPresetLintRecommended from 'https://cdn.skypack.dev/remark-preset-lint-recommended@6?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 remarkPresetLintRecommended from 'remark-preset-lint-recommended'
+
+main()
+
+async function main() {
+  const file = await remark()
+    .use(remarkPresetLintRecommended)
+    .process(await read('example.md'))
+
+  console.error(reporter(file))
+}
+```
+
+On the CLI:
+
+```sh
+remark --use remark-preset-lint-recommended example.md
+```
+
+On the CLI in a config file (here a `package.json`):
+
 ```diff
  …
  "remarkConfig": {
-+  "plugins": ["preset-lint-recommended"]
+   "plugins": [
+     …
++    "remark-preset-lint-recommended",
+     …
+   ]
  }
@@ -66,23 +126,21 @@ …
 
-Or use it on the CLI directly
+## API
 
-```sh
-remark -u preset-lint-recommended readme.md
-```
+This package exports no identifiers.
+The default export is `remarkPresetLintRecommended`.
 
-Or use this on the API:
+### `unified().use(remarkPresetLintRecommended)`
 
-```diff
- import {remark} from 'remark'
- import {reporter} from 'vfile-reporter'
- import remarkPresetLintRecommended from 'remark-preset-lint-recommended'
+Use the preset.
+Presets don’t have options.
+You can reconfigure rules in them by using the afterwards with different
+options.
 
- remark()
-+  .use(remarkPresetLintRecommended)
-   .process('_Emphasis_ and **importance**')
-   .then((file) => {
-     console.error(reporter(file))
-   })
-```
+## 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
@@ -128,4 +186,12 @@
 
+[unified]: https://github.com/unifiedjs/unified
+
+[remark]: https://github.com/remarkjs/remark
+
+[mono]: https://github.com/remarkjs/remark-lint
+
 [esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
 
+[skypack]: https://www.skypack.dev
+
 [npm]: https://docs.npmjs.com/cli/install
@@ -135,7 +201,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
 
@@ -142,0 +208,0 @@ [license]: https://github.com/remarkjs/remark-lint/blob/main/license

New alerts

License Policy Violation

License

This 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

License

This 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

10982

increased by16.79%

Lines of code

54

increased by5.88%

Number of lines in readme file

205

increased by47.48%

No dependency changes