@kitschpatrol/remark-config 5.5.0 → 5.7.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.
- package/bin/cli.js +4 -4
- package/package.json +8 -7
- package/readme.md +11 -11
package/bin/cli.js
CHANGED
|
@@ -5138,7 +5138,7 @@ var Yargs = YargsFactory(esm_default);
|
|
|
5138
5138
|
var yargs_default = Yargs;
|
|
5139
5139
|
|
|
5140
5140
|
// ../../package.json
|
|
5141
|
-
var version = "5.
|
|
5141
|
+
var version = "5.7.0";
|
|
5142
5142
|
|
|
5143
5143
|
// ../../src/execa-utilities.ts
|
|
5144
5144
|
function isErrorExecaError(error) {
|
|
@@ -5184,7 +5184,7 @@ function stringify(passedObj, options = {}) {
|
|
|
5184
5184
|
).slice(2, -3);
|
|
5185
5185
|
const maxLength = indent === "" ? Infinity : options.maxLength === void 0 ? 80 : options.maxLength;
|
|
5186
5186
|
let { replacer } = options;
|
|
5187
|
-
return function _stringify(obj, currentIndent, reserved) {
|
|
5187
|
+
return (function _stringify(obj, currentIndent, reserved) {
|
|
5188
5188
|
if (obj && typeof obj.toJSON === "function") {
|
|
5189
5189
|
obj = obj.toJSON();
|
|
5190
5190
|
}
|
|
@@ -5250,7 +5250,7 @@ ${currentIndent}`
|
|
|
5250
5250
|
}
|
|
5251
5251
|
}
|
|
5252
5252
|
return string;
|
|
5253
|
-
}(passedObj, "", 0);
|
|
5253
|
+
})(passedObj, "", 0);
|
|
5254
5254
|
}
|
|
5255
5255
|
|
|
5256
5256
|
// ../../src/json-utilities.ts
|
|
@@ -5831,7 +5831,7 @@ var commandDefinition = {
|
|
|
5831
5831
|
description: "Kitschpatrol's Remark and Remark Lint shared configuration tools. (Actual linting and fixing is managed through @kitschpatrol/eslint-config.)",
|
|
5832
5832
|
logColor: "blue",
|
|
5833
5833
|
logPrefix: "[remarklint]",
|
|
5834
|
-
name: "
|
|
5834
|
+
name: "ksc-remark",
|
|
5835
5835
|
order: 8
|
|
5836
5836
|
};
|
|
5837
5837
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/remark-config",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.7.0",
|
|
4
4
|
"description": "Markdown and MDX linting for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
"remark-lint",
|
|
9
9
|
"remark",
|
|
10
10
|
"cli",
|
|
11
|
-
"
|
|
12
|
-
"
|
|
11
|
+
"ksc",
|
|
12
|
+
"ksc-remark"
|
|
13
13
|
],
|
|
14
14
|
"homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/remark-config",
|
|
15
15
|
"bugs": "https://github.com/kitschpatrol/shared-config/issues",
|
|
@@ -34,7 +34,8 @@
|
|
|
34
34
|
"main": "dist/index.js",
|
|
35
35
|
"types": "dist/index.d.ts",
|
|
36
36
|
"bin": {
|
|
37
|
-
"kpi-remark": "bin/cli.js"
|
|
37
|
+
"kpi-remark": "bin/cli.js",
|
|
38
|
+
"ksc-remark": "bin/cli.js"
|
|
38
39
|
},
|
|
39
40
|
"files": [
|
|
40
41
|
"bin/*",
|
|
@@ -48,9 +49,9 @@
|
|
|
48
49
|
"cosmiconfig-typescript-loader": "^6.1.0",
|
|
49
50
|
"execa": "^9.6.0",
|
|
50
51
|
"find-workspaces": "^0.3.1",
|
|
51
|
-
"fs-extra": "^11.3.
|
|
52
|
+
"fs-extra": "^11.3.1",
|
|
52
53
|
"mdast-util-to-markdown": "^2.1.2",
|
|
53
|
-
"prettier": "^3.
|
|
54
|
+
"prettier": "^3.6.2",
|
|
54
55
|
"remark-directive": "^4.0.0",
|
|
55
56
|
"remark-frontmatter": "^5.0.0",
|
|
56
57
|
"remark-gfm": "^4.0.1",
|
|
@@ -90,7 +91,7 @@
|
|
|
90
91
|
"unified": "^11.0.5"
|
|
91
92
|
},
|
|
92
93
|
"engines": {
|
|
93
|
-
"node": ">=20.
|
|
94
|
+
"node": ">=20.19.0"
|
|
94
95
|
},
|
|
95
96
|
"publishConfig": {
|
|
96
97
|
"access": "public"
|
package/readme.md
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
## Overview
|
|
23
23
|
|
|
24
|
-
It's a shared [Remark](https://github.com/remarkjs/remark/blob/main/packages/remark-cli/readme.md#example-config-files-json-yaml-js) config for linting Markdown and MDX files, plus a command-line tool `
|
|
24
|
+
It's a shared [Remark](https://github.com/remarkjs/remark/blob/main/packages/remark-cli/readme.md#example-config-files-json-yaml-js) config for linting Markdown and MDX files, plus a command-line tool `ksc-remark` to streamline project initialization. Note that linting and fixing is provided separately through [@kitschpatrol/eslint-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/eslint-config).
|
|
25
25
|
|
|
26
26
|
<!-- recommendation -->
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ It's a shared [Remark](https://github.com/remarkjs/remark/blob/main/packages/rem
|
|
|
29
29
|
>
|
|
30
30
|
> **You can use this package on its own, but it's recommended to use [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) instead for a single-dependency and single-package approach to linting and fixing your project.**
|
|
31
31
|
>
|
|
32
|
-
> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `
|
|
32
|
+
> This package is included as a dependency in [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config), which also automatically invokes the command line functionality in this package via its `ksc` command
|
|
33
33
|
|
|
34
34
|
<!-- /recommendation -->
|
|
35
35
|
|
|
@@ -52,14 +52,14 @@ To use just this Remark config in isolation:
|
|
|
52
52
|
3. Add the starter `.remarkrc.js` and files to your project root, and add any customizations you'd like:
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
|
-
pnpm exec
|
|
55
|
+
pnpm exec ksc-remark init
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
## Usage
|
|
59
59
|
|
|
60
60
|
The Remark binary should be picked up automatically by VS Code plugins.
|
|
61
61
|
|
|
62
|
-
You can call it directly, but it's recommended to use the `
|
|
62
|
+
You can call it directly, but it's recommended to use the `ksc` script bundled with the [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) instead 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.
|
|
63
63
|
|
|
64
64
|
If you really want to call it directly, you can integrate a command to the underlying `remark` CLI tool with your `package.json` scripts as you see fit, for example:
|
|
65
65
|
|
|
@@ -75,16 +75,16 @@ If you really want to call it directly, you can integrate a command to the under
|
|
|
75
75
|
|
|
76
76
|
<!-- cli-help -->
|
|
77
77
|
|
|
78
|
-
#### Command: `
|
|
78
|
+
#### Command: `ksc-remark`
|
|
79
79
|
|
|
80
80
|
Kitschpatrol's Remark and Remark Lint shared configuration tools. (Actual linting and fixing is managed through @kitschpatrol/eslint-config.)
|
|
81
81
|
|
|
82
|
-
This section lists top-level commands for `
|
|
82
|
+
This section lists top-level commands for `ksc-remark`.
|
|
83
83
|
|
|
84
84
|
Usage:
|
|
85
85
|
|
|
86
86
|
```txt
|
|
87
|
-
|
|
87
|
+
ksc-remark <command>
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
| Command | Description |
|
|
@@ -99,14 +99,14 @@ kpi-remark <command>
|
|
|
99
99
|
|
|
100
100
|
_See the sections below for more information on each subcommand._
|
|
101
101
|
|
|
102
|
-
#### Subcommand: `
|
|
102
|
+
#### Subcommand: `ksc-remark init`
|
|
103
103
|
|
|
104
104
|
Initialize by copying starter config files to your project root or to your package.json file.
|
|
105
105
|
|
|
106
106
|
Usage:
|
|
107
107
|
|
|
108
108
|
```txt
|
|
109
|
-
|
|
109
|
+
ksc-remark init
|
|
110
110
|
```
|
|
111
111
|
|
|
112
112
|
| Option | Description | Type | Default |
|
|
@@ -115,14 +115,14 @@ kpi-remark init
|
|
|
115
115
|
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
116
116
|
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
117
117
|
|
|
118
|
-
#### Subcommand: `
|
|
118
|
+
#### Subcommand: `ksc-remark print-config`
|
|
119
119
|
|
|
120
120
|
Print the effective Remark configuration. Package-scoped. Searches up to the root of a monorepo if necessary.
|
|
121
121
|
|
|
122
122
|
Usage:
|
|
123
123
|
|
|
124
124
|
```txt
|
|
125
|
-
|
|
125
|
+
ksc-remark print-config
|
|
126
126
|
```
|
|
127
127
|
|
|
128
128
|
| Option | Description | Type |
|