@kitschpatrol/prettier-config 5.6.0 → 5.7.1

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 (3) hide show
  1. package/bin/cli.js +2 -2
  2. package/package.json +6 -5
  3. package/readme.md +19 -19
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.6.0";
5141
+ var version = "5.7.1";
5142
5142
 
5143
5143
  // ../../src/execa-utilities.ts
5144
5144
  function isErrorExecaError(error) {
@@ -5876,7 +5876,7 @@ var commandDefinition = {
5876
5876
  description: "Kitschpatrol's Prettier shared configuration tools.",
5877
5877
  logColor: "blue",
5878
5878
  logPrefix: "[Prettier]",
5879
- name: "kpi-prettier",
5879
+ name: "ksc-prettier",
5880
5880
  order: 9
5881
5881
  };
5882
5882
 
package/package.json CHANGED
@@ -1,14 +1,14 @@
1
1
  {
2
2
  "name": "@kitschpatrol/prettier-config",
3
- "version": "5.6.0",
3
+ "version": "5.7.1",
4
4
  "description": "Prettier configuration for @kitschpatrol/shared-config.",
5
5
  "keywords": [
6
6
  "shared-config",
7
7
  "prettier-config",
8
8
  "prettier",
9
9
  "cli",
10
- "kpi",
11
- "kpi-prettier"
10
+ "ksc",
11
+ "ksc-prettier"
12
12
  ],
13
13
  "homepage": "https://github.com/kitschpatrol/shared-config/tree/main/packages/prettier-config",
14
14
  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
@@ -33,7 +33,8 @@
33
33
  "main": "dist/index.js",
34
34
  "types": "dist/index.d.ts",
35
35
  "bin": {
36
- "kpi-prettier": "bin/cli.js"
36
+ "kpi-prettier": "bin/cli.js",
37
+ "ksc-prettier": "bin/cli.js"
37
38
  },
38
39
  "files": [
39
40
  "bin/*",
@@ -50,7 +51,7 @@
50
51
  "deepmerge-ts": "^7.1.5",
51
52
  "execa": "^9.6.0",
52
53
  "find-workspaces": "^0.3.1",
53
- "fs-extra": "^11.3.1",
54
+ "fs-extra": "^11.3.2",
54
55
  "prettier": "^3.6.2",
55
56
  "prettier-plugin-astro": "^0.14.1",
56
57
  "prettier-plugin-packagejson": "^2.5.19",
package/readme.md CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
  ## Overview
23
23
 
24
- It's a shared [Prettier](https://prettier.io) config, plus a command-line tool `kpi-prettier` to perform Prettier-related project initialization, linting, and fixing.
24
+ It's a shared [Prettier](https://prettier.io) config, plus a command-line tool `ksc-prettier` to perform Prettier-related project initialization, linting, and fixing.
25
25
 
26
26
  <!-- recommendation -->
27
27
 
@@ -29,7 +29,7 @@ It's a shared [Prettier](https://prettier.io) config, plus a command-line tool `
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 `kpi` command
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 this Prettier config in isolation:
52
52
  3. Add the starter `.prettierrc.js` and `.prettierignore` files to your project root, and add any customizations you'd like:
53
53
 
54
54
  ```sh
55
- pnpm exec kpi-prettier init
55
+ pnpm exec ksc-prettier init
56
56
  ```
57
57
 
58
58
  ## Usage
@@ -66,20 +66,20 @@ Integrate with your `package.json` scripts as you see fit, for example:
66
66
  ```json
67
67
  {
68
68
  "scripts": {
69
- "lint": "kpi-prettier lint",
70
- "fix": "kpi-prettier fix"
69
+ "lint": "ksc-prettier lint",
70
+ "fix": "ksc-prettier fix"
71
71
  }
72
72
  }
73
73
  ```
74
74
 
75
- You might need to pass certain plugins in explicitly if you're calling `prettier` directly. The `kpi-prettier fix` and `kpi-prettier lint` scripts take care of this for you.
75
+ You might need to pass certain plugins in explicitly if you're calling `prettier` directly. The `ksc-prettier fix` and `ksc-prettier lint` scripts take care of this for you.
76
76
 
77
77
  ### Configuration
78
78
 
79
79
  To create a `prettier.config.js` in your project root:
80
80
 
81
81
  ```sh
82
- pnpm exec kpi-prettier init
82
+ pnpm exec ksc-prettier init
83
83
  ```
84
84
 
85
85
  (Note that this will delete the `prettier` property in your `package.json`!)
@@ -89,7 +89,7 @@ _Or_
89
89
  To create a `prettier` property in `package.json`:
90
90
 
91
91
  ```sh
92
- pnpm exec kpi-prettier init --location package
92
+ pnpm exec ksc-prettier init --location package
93
93
  ```
94
94
 
95
95
  (Note that this will delete the `prettier.config.js` file in your project root!)
@@ -98,16 +98,16 @@ pnpm exec kpi-prettier init --location package
98
98
 
99
99
  <!-- cli-help -->
100
100
 
101
- #### Command: `kpi-prettier`
101
+ #### Command: `ksc-prettier`
102
102
 
103
103
  Kitschpatrol's Prettier shared configuration tools.
104
104
 
105
- This section lists top-level commands for `kpi-prettier`.
105
+ This section lists top-level commands for `ksc-prettier`.
106
106
 
107
107
  Usage:
108
108
 
109
109
  ```txt
110
- kpi-prettier <command>
110
+ ksc-prettier <command>
111
111
  ```
112
112
 
113
113
  | Command | Argument | Description |
@@ -124,14 +124,14 @@ kpi-prettier <command>
124
124
 
125
125
  _See the sections below for more information on each subcommand._
126
126
 
127
- #### Subcommand: `kpi-prettier init`
127
+ #### Subcommand: `ksc-prettier init`
128
128
 
129
129
  Initialize by copying starter config files to your project root or to your package.json file.
130
130
 
131
131
  Usage:
132
132
 
133
133
  ```txt
134
- kpi-prettier init
134
+ ksc-prettier init
135
135
  ```
136
136
 
137
137
  | Option | Description | Type | Default |
@@ -140,14 +140,14 @@ kpi-prettier init
140
140
  | `--help`<br>`-h` | Show help | `boolean` | |
141
141
  | `--version`<br>`-v` | Show version number | `boolean` | |
142
142
 
143
- #### Subcommand: `kpi-prettier lint`
143
+ #### Subcommand: `ksc-prettier lint`
144
144
 
145
145
  Check that files are formatted according to your Prettier configuration. Matches files below the current working directory by default.
146
146
 
147
147
  Usage:
148
148
 
149
149
  ```txt
150
- kpi-prettier lint [files..]
150
+ ksc-prettier lint [files..]
151
151
  ```
152
152
 
153
153
  | Positional Argument | Description | Type | Default |
@@ -159,14 +159,14 @@ kpi-prettier lint [files..]
159
159
  | `--help`<br>`-h` | Show help | `boolean` |
160
160
  | `--version`<br>`-v` | Show version number | `boolean` |
161
161
 
162
- #### Subcommand: `kpi-prettier fix`
162
+ #### Subcommand: `ksc-prettier fix`
163
163
 
164
164
  Format files according to your Prettier configuration. Matches files below the current working directory by default.
165
165
 
166
166
  Usage:
167
167
 
168
168
  ```txt
169
- kpi-prettier fix [files..]
169
+ ksc-prettier fix [files..]
170
170
  ```
171
171
 
172
172
  | Positional Argument | Description | Type | Default |
@@ -178,14 +178,14 @@ kpi-prettier fix [files..]
178
178
  | `--help`<br>`-h` | Show help | `boolean` |
179
179
  | `--version`<br>`-v` | Show version number | `boolean` |
180
180
 
181
- #### Subcommand: `kpi-prettier print-config`
181
+ #### Subcommand: `ksc-prettier print-config`
182
182
 
183
183
  Print the effective Prettier configuration. Package-scoped.. Searches up to the root of a monorepo if necessary..
184
184
 
185
185
  Usage:
186
186
 
187
187
  ```txt
188
- kpi-prettier print-config
188
+ ksc-prettier print-config
189
189
  ```
190
190
 
191
191
  | Option | Description | Type |