@kitschpatrol/mdat-config 5.6.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 +2 -2
- package/dist/index.js +1 -1
- package/package.json +5 -4
- package/readme.md +18 -18
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) {
|
|
@@ -5879,7 +5879,7 @@ var commandDefinition = {
|
|
|
5879
5879
|
description: "Kitschpatrol's Mdat shared configuration tools.",
|
|
5880
5880
|
logColor: "green",
|
|
5881
5881
|
logPrefix: "[Mdat Config]",
|
|
5882
|
-
name: "
|
|
5882
|
+
name: "ksc-mdat",
|
|
5883
5883
|
order: 2
|
|
5884
5884
|
};
|
|
5885
5885
|
|
package/dist/index.js
CHANGED
|
@@ -2,7 +2,7 @@ import { mergeConfigs } from 'mdat';
|
|
|
2
2
|
// export { commandDefinition } from './command.js'
|
|
3
3
|
const sharedMdatConfig = {
|
|
4
4
|
rules: {
|
|
5
|
-
'shared-config': '## Project configuration\n\nThis project uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) to consolidate various linting and formatting tool configurations under a single dependency and the CLI command `
|
|
5
|
+
'shared-config': '## Project configuration\n\nThis project uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) to consolidate various linting and formatting tool configurations under a single dependency and the CLI command `ksc`. (ESLint, Prettier, CSpell, etc.)',
|
|
6
6
|
},
|
|
7
7
|
};
|
|
8
8
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kitschpatrol/mdat-config",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.7.0",
|
|
4
4
|
"description": "MDAT configuration for @kitschpatrol/shared-config.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"shared-config",
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"readme",
|
|
10
10
|
"mdat",
|
|
11
11
|
"cli",
|
|
12
|
-
"
|
|
13
|
-
"
|
|
12
|
+
"ksc",
|
|
13
|
+
"ksc-mdat"
|
|
14
14
|
],
|
|
15
15
|
"homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/mdat-config",
|
|
16
16
|
"bugs": "https://github.com/kitschpatrol/shared-config/issues",
|
|
@@ -35,7 +35,8 @@
|
|
|
35
35
|
"main": "dist/index.js",
|
|
36
36
|
"types": "dist/index.d.ts",
|
|
37
37
|
"bin": {
|
|
38
|
-
"kpi-mdat": "bin/cli.js"
|
|
38
|
+
"kpi-mdat": "bin/cli.js",
|
|
39
|
+
"ksc-mdat": "bin/cli.js"
|
|
39
40
|
},
|
|
40
41
|
"files": [
|
|
41
42
|
"bin/*",
|
package/readme.md
CHANGED
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
|
|
22
22
|
## Overview
|
|
23
23
|
|
|
24
|
-
It's a shared [MDAT (Markdown Autophagic Template)](https://github.com/kitschpatrol/mdat) system config, plus a command-line tool `
|
|
24
|
+
It's a shared [MDAT (Markdown Autophagic Template)](https://github.com/kitschpatrol/mdat) system config, plus a command-line tool `ksc-mdat` to perform mdat-related project initialization, linting, and fixing.
|
|
25
25
|
|
|
26
26
|
<!-- recommendation -->
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ It's a shared [MDAT (Markdown Autophagic Template)](https://github.com/kitschpat
|
|
|
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,7 +52,7 @@ To use just `mdat-config` in isolation:
|
|
|
52
52
|
3. Add the starter `.mdatrc.ts` file to your project root, and add any customizations you'd like:
|
|
53
53
|
|
|
54
54
|
```sh
|
|
55
|
-
pnpm exec
|
|
55
|
+
pnpm exec ksc-mdat init
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
## Usage
|
|
@@ -66,8 +66,8 @@ Integrate with your `package.json` scripts as you see fit, for example:
|
|
|
66
66
|
```json
|
|
67
67
|
{
|
|
68
68
|
"scripts": {
|
|
69
|
-
"lint": "
|
|
70
|
-
"fix": "
|
|
69
|
+
"lint": "ksc-mdat lint",
|
|
70
|
+
"fix": "ksc-mdat fix"
|
|
71
71
|
}
|
|
72
72
|
}
|
|
73
73
|
```
|
|
@@ -81,7 +81,7 @@ It runs `mdat readme expand` to expand placeholder comments in your readme.md us
|
|
|
81
81
|
To create a `mdat.config.ts` in your project root:
|
|
82
82
|
|
|
83
83
|
```sh
|
|
84
|
-
pnpm exec
|
|
84
|
+
pnpm exec ksc-mdat init
|
|
85
85
|
```
|
|
86
86
|
|
|
87
87
|
(Note that this will delete the `mdat` property in your `package.json`!)
|
|
@@ -91,7 +91,7 @@ _Or_
|
|
|
91
91
|
To create a `mdat` property in `package.json`:
|
|
92
92
|
|
|
93
93
|
```sh
|
|
94
|
-
pnpm exec
|
|
94
|
+
pnpm exec ksc-mdat init --location package
|
|
95
95
|
```
|
|
96
96
|
|
|
97
97
|
(Note that this will delete the `mdat.config.ts` file in your project root!)
|
|
@@ -100,16 +100,16 @@ pnpm exec kpi-mdat init --location package
|
|
|
100
100
|
|
|
101
101
|
<!-- cli-help -->
|
|
102
102
|
|
|
103
|
-
#### Command: `
|
|
103
|
+
#### Command: `ksc-mdat`
|
|
104
104
|
|
|
105
105
|
Kitschpatrol's Mdat shared configuration tools.
|
|
106
106
|
|
|
107
|
-
This section lists top-level commands for `
|
|
107
|
+
This section lists top-level commands for `ksc-mdat`.
|
|
108
108
|
|
|
109
109
|
Usage:
|
|
110
110
|
|
|
111
111
|
```txt
|
|
112
|
-
|
|
112
|
+
ksc-mdat <command>
|
|
113
113
|
```
|
|
114
114
|
|
|
115
115
|
| Command | Description |
|
|
@@ -126,14 +126,14 @@ kpi-mdat <command>
|
|
|
126
126
|
|
|
127
127
|
_See the sections below for more information on each subcommand._
|
|
128
128
|
|
|
129
|
-
#### Subcommand: `
|
|
129
|
+
#### Subcommand: `ksc-mdat init`
|
|
130
130
|
|
|
131
131
|
Initialize by copying starter config files to your project root or to your package.json file.
|
|
132
132
|
|
|
133
133
|
Usage:
|
|
134
134
|
|
|
135
135
|
```txt
|
|
136
|
-
|
|
136
|
+
ksc-mdat init
|
|
137
137
|
```
|
|
138
138
|
|
|
139
139
|
| Option | Description | Type | Default |
|
|
@@ -142,14 +142,14 @@ kpi-mdat init
|
|
|
142
142
|
| `--help`<br>`-h` | Show help | `boolean` | |
|
|
143
143
|
| `--version`<br>`-v` | Show version number | `boolean` | |
|
|
144
144
|
|
|
145
|
-
#### Subcommand: `
|
|
145
|
+
#### Subcommand: `ksc-mdat lint`
|
|
146
146
|
|
|
147
147
|
Validate that all Mdat content placeholders in your readme.md file(s) have been expanded. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
|
|
148
148
|
|
|
149
149
|
Usage:
|
|
150
150
|
|
|
151
151
|
```txt
|
|
152
|
-
|
|
152
|
+
ksc-mdat lint
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
| Option | Description | Type |
|
|
@@ -157,14 +157,14 @@ kpi-mdat lint
|
|
|
157
157
|
| `--help`<br>`-h` | Show help | `boolean` |
|
|
158
158
|
| `--version`<br>`-v` | Show version number | `boolean` |
|
|
159
159
|
|
|
160
|
-
#### Subcommand: `
|
|
160
|
+
#### Subcommand: `ksc-mdat fix`
|
|
161
161
|
|
|
162
162
|
Expand all Mdat content placeholders in your readme.md file(s). Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
|
|
163
163
|
|
|
164
164
|
Usage:
|
|
165
165
|
|
|
166
166
|
```txt
|
|
167
|
-
|
|
167
|
+
ksc-mdat fix
|
|
168
168
|
```
|
|
169
169
|
|
|
170
170
|
| Option | Description | Type |
|
|
@@ -172,14 +172,14 @@ kpi-mdat fix
|
|
|
172
172
|
| `--help`<br>`-h` | Show help | `boolean` |
|
|
173
173
|
| `--version`<br>`-v` | Show version number | `boolean` |
|
|
174
174
|
|
|
175
|
-
#### Subcommand: `
|
|
175
|
+
#### Subcommand: `ksc-mdat print-config`
|
|
176
176
|
|
|
177
177
|
Print the effective Mdat configuration. Package-scoped.. Searches up to the root of a monorepo if necessary.. Includes configuration provided by the `mdat readme` command.
|
|
178
178
|
|
|
179
179
|
Usage:
|
|
180
180
|
|
|
181
181
|
```txt
|
|
182
|
-
|
|
182
|
+
ksc-mdat print-config
|
|
183
183
|
```
|
|
184
184
|
|
|
185
185
|
| Option | Description | Type |
|