@kitschpatrol/remark-config 4.4.3 → 4.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +9 -2
  2. package/readme.md +4 -4
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@kitschpatrol/remark-config",
3
- "version": "4.4.3",
3
+ "version": "4.6.0",
4
4
  "type": "module",
5
- "description": "Linting for markdown and MDX files, managed via ESLint.",
5
+ "description": "Markdown and MDX linting for @kitschpatrol/shared-config.",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "git@github.com:kitschpatrol/shared-config.git",
@@ -30,6 +30,13 @@
30
30
  "bin/*",
31
31
  "init/*"
32
32
  ],
33
+ "keywords": [
34
+ "shared-config",
35
+ "remark-config",
36
+ "remark-lint",
37
+ "remark",
38
+ "cli"
39
+ ],
33
40
  "dependencies": {
34
41
  "@pinojs/json-colorizer": "^4.0.0",
35
42
  "cosmiconfig": "^9.0.0",
package/readme.md CHANGED
@@ -7,7 +7,7 @@
7
7
  [![NPM Package @kitschpatrol/remark-config](https://img.shields.io/npm/v/@kitschpatrol/remark-config.svg)](https://npmjs.com/package/@kitschpatrol/remark-config)
8
8
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
9
9
 
10
- **Linting for markdown and MDX files, managed via ESLint.**
10
+ **Markdown and MDX linting for @kitschpatrol/shared-config.**
11
11
 
12
12
  <!-- /header -->
13
13
 
@@ -43,13 +43,13 @@ To use just this Remark config in isolation:
43
43
 
44
44
  The Remark binary should be picked up automatically by VS Code plugins.
45
45
 
46
- You can call it directly, but it's recommended to use the script bundled with the shared config to invoke the remark lint rules through `eslint`.
46
+ You can call it directly, but it's recommended to use the script bundled with the shared config to invoke the remark lint rules through ESLint. The [`eslint-mdx`](https://github.com/mdx-js/eslint-mdx) plugin is used to bridge these rules into ESLint and the VS Code ESLint plugin.
47
47
 
48
48
  Integrate with your `package.json` scripts as you see fit, for example:
49
49
 
50
50
  ```json
51
51
  "scripts": {
52
- "lint": "p remark . --quiet --frail"
52
+ "lint": "pnpm remark . --quiet --frail"
53
53
  }
54
54
  ```
55
55
 
@@ -59,7 +59,7 @@ Integrate with your `package.json` scripts as you see fit, for example:
59
59
 
60
60
  #### Command: `remark-config`
61
61
 
62
- Linting for markdown and MDX files, managed via ESLint.
62
+ Markdown and MDX linting for @kitschpatrol/shared-config.
63
63
 
64
64
  Usage:
65
65