@kitschpatrol/shared-config 5.0.3 → 5.0.5

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 +11 -6
  2. package/package.json +16 -15
  3. package/readme.md +19 -32
package/bin/cli.js CHANGED
@@ -5541,7 +5541,7 @@ var Yargs = YargsFactory(esm_default);
5541
5541
  var yargs_default = Yargs;
5542
5542
 
5543
5543
  // ../../package.json
5544
- var version = "5.0.3";
5544
+ var version = "5.0.5";
5545
5545
 
5546
5546
  // ../../src/execa-utils.ts
5547
5547
  function isErrorExecaError(error) {
@@ -5879,10 +5879,15 @@ async function executeCliCommand(logStream, positionalArguments, optionFlags, co
5879
5879
  try {
5880
5880
  const subprocess = execa(command2.name, resolvedArguments, {
5881
5881
  cwd,
5882
- env: process.env.NO_COLOR === void 0 ? {
5882
+ env: {
5883
+ // Use colorful output unless NO_COLOR is set
5883
5884
  // eslint-disable-next-line ts/naming-convention
5884
- FORCE_COLOR: "true"
5885
- } : {},
5885
+ ...process.env.NO_COLOR === void 0 ? { FORCE_COLOR: "true" } : {},
5886
+ // Quiet node for when processing *.config.ts files in Node 22
5887
+ // Suppress experimental type stripping warning with --no-warnings
5888
+ // eslint-disable-next-line ts/naming-convention
5889
+ NODE_OPTIONS: "--experimental-strip-types --disable-warning=ExperimentalWarning"
5890
+ },
5886
5891
  preferLocal: true,
5887
5892
  reject: false,
5888
5893
  // Prevents throwing on non-zero exit code
@@ -6871,7 +6876,7 @@ var commandDefinition7 = {
6871
6876
  fix: {
6872
6877
  commands: [
6873
6878
  {
6874
- execute: copyrightYearLinterCommand,
6879
+ execute: copyrightYearFixerCommand,
6875
6880
  name: copyrightYearLinterCommand.name
6876
6881
  }
6877
6882
  ],
@@ -6884,7 +6889,7 @@ var commandDefinition7 = {
6884
6889
  lint: {
6885
6890
  commands: [
6886
6891
  {
6887
- execute: copyrightYearFixerCommand,
6892
+ execute: copyrightYearLinterCommand,
6888
6893
  name: copyrightYearFixerCommand.name
6889
6894
  }
6890
6895
  ],
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@kitschpatrol/shared-config",
3
- "version": "5.0.3",
4
- "description": "A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.",
3
+ "version": "5.0.5",
4
+ "description": "A collection of shared configurations, linters, and formatting tools for TypeScript projects. All managed as a single dependency, and invoked via a single CLI command.",
5
5
  "keywords": [
6
6
  "shared-config",
7
7
  "eslint-config",
@@ -15,10 +15,11 @@
15
15
  "cli",
16
16
  "kpi"
17
17
  ],
18
+ "homepage": "https://github.com/kitschpatrol/shared-config",
18
19
  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
19
20
  "repository": {
20
21
  "type": "git",
21
- "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
22
+ "url": "git+https://github.com/kitschpatrol/shared-config.git",
22
23
  "directory": "packages/shared-config"
23
24
  },
24
25
  "license": "MIT",
@@ -40,23 +41,23 @@
40
41
  "execa": "^9.5.2",
41
42
  "find-workspaces": "^0.3.1",
42
43
  "fs-extra": "^11.3.0",
43
- "prettier": "^3.4.2",
44
- "@kitschpatrol/cspell-config": "5.0.3",
45
- "@kitschpatrol/eslint-config": "5.0.3",
46
- "@kitschpatrol/knip-config": "5.0.3",
47
- "@kitschpatrol/mdat-config": "5.0.3",
48
- "@kitschpatrol/prettier-config": "5.0.3",
49
- "@kitschpatrol/repo-config": "5.0.3",
50
- "@kitschpatrol/remark-config": "5.0.3",
51
- "@kitschpatrol/stylelint-config": "5.0.3",
52
- "@kitschpatrol/typescript-config": "5.0.3"
44
+ "prettier": "^3.5.0",
45
+ "@kitschpatrol/cspell-config": "5.0.5",
46
+ "@kitschpatrol/eslint-config": "5.0.5",
47
+ "@kitschpatrol/mdat-config": "5.0.5",
48
+ "@kitschpatrol/knip-config": "5.0.5",
49
+ "@kitschpatrol/prettier-config": "5.0.5",
50
+ "@kitschpatrol/remark-config": "5.0.5",
51
+ "@kitschpatrol/repo-config": "5.0.5",
52
+ "@kitschpatrol/stylelint-config": "5.0.5",
53
+ "@kitschpatrol/typescript-config": "5.0.5"
53
54
  },
54
55
  "devDependencies": {
55
56
  "chalk": "^5.4.1",
56
- "globby": "^14.0.2"
57
+ "globby": "^14.1.0"
57
58
  },
58
59
  "engines": {
59
- "node": ">=22.0.0",
60
+ "node": ">=22.13.1",
60
61
  "pnpm": ">=10.0.0"
61
62
  },
62
63
  "publishConfig": {
package/readme.md CHANGED
@@ -15,7 +15,7 @@
15
15
 
16
16
  <!-- description -->
17
17
 
18
- **A collection of shared configurations for various linters and formatting tools. All managed as a single dependency, and invoked via a single command.**
18
+ **A collection of shared configurations, linters, and formatting tools for TypeScript projects. All managed as a single dependency, and invoked via a single CLI command.**
19
19
 
20
20
  <!-- /description -->
21
21
 
@@ -67,19 +67,19 @@ This particular readme is for the [`@kitschpatrol/shared-config`](https://www.np
67
67
 
68
68
  #### Primary package
69
69
 
70
- - [`@kitschpatrol/shared-config`](/packages/shared-config/readme.md) (`kpi` command)
70
+ - [`@kitschpatrol/shared-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/shared-config/readme.md) (`kpi` command)
71
71
 
72
72
  #### Sub-packages
73
73
 
74
- - [`@kitschpatrol/cspell-config`](/packages/cspell-config/readme.md) (`kpi-cspell` command)
75
- - [`@kitschpatrol/eslint-config`](/packages/eslint-config/readme.md) (`kpi-eslint` command)
76
- - [`@kitschpatrol/knip-config`](/packages/knip-config/readme.md) (`kpi-knip` command)
77
- - [`@kitschpatrol/mdat-config`](/packages/mdat-config/readme.md) (`kpi-mdat` command)
78
- - [`@kitschpatrol/prettier-config`](/packages/prettier-config/readme.md) (`kpi-prettier` command)
79
- - [`@kitschpatrol/remark-config`](/packages/remark-config/readme.md) (`kpi-remark` command)
80
- - [`@kitschpatrol/repo-config`](/packages/repo-config/readme.md) (`kpi-repo` command)
81
- - [`@kitschpatrol/stylelint-config`](/packages/stylelint-config/readme.md) (`kpi-stylelint` command)
82
- - [`@kitschpatrol/typescript-config`](/packages/typescript-config/readme.md) (`kpi-typescript` command)
74
+ - [`@kitschpatrol/cspell-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/cspell-config/readme.md) (`kpi-cspell` command)
75
+ - [`@kitschpatrol/eslint-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/eslint-config/readme.md) (`kpi-eslint` command)
76
+ - [`@kitschpatrol/knip-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/knip-config/readme.md) (`kpi-knip` command)
77
+ - [`@kitschpatrol/mdat-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/mdat-config/readme.md) (`kpi-mdat` command)
78
+ - [`@kitschpatrol/prettier-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/prettier-config/readme.md) (`kpi-prettier` command)
79
+ - [`@kitschpatrol/remark-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/remark-config/readme.md) (`kpi-remark` command)
80
+ - [`@kitschpatrol/repo-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/repo-config/readme.md) (`kpi-repo` command)
81
+ - [`@kitschpatrol/stylelint-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/stylelint-config/readme.md) (`kpi-stylelint` command)
82
+ - [`@kitschpatrol/typescript-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/typescript-config/readme.md) (`kpi-typescript` command)
83
83
 
84
84
  > [!IMPORTANT]
85
85
  >
@@ -98,17 +98,19 @@ kpi init
98
98
  Is the same as running:
99
99
 
100
100
  ```sh
101
- kpi-cspell init
101
+ kpi-repo init
102
+ kpi-mdat init
103
+ kpi-typescript init
102
104
  kpi-eslint init
105
+ kpi-stylelint init
106
+ kpi-cspell init
103
107
  kpi-knip init
104
- kpi-mdat init
105
- kpi-prettier init
106
108
  kpi-remark init
107
- kpi-repo init
108
- kpi-stylelint init
109
- kpi-typescript init
109
+ kpi-prettier init
110
110
  ```
111
111
 
112
+ _(Sub-commands are always executed in the above order.)_
113
+
112
114
  The top-level `kpi` command also takes care of some nuances in terms of _which_ sub-packages implement _which_ commands, and which subcommands take arguments.
113
115
 
114
116
  ## Getting started
@@ -176,9 +178,6 @@ pnpm dlx @kitschpatrol/repo-config init && pnpm i && pnpm add -D @kitschpatrol/s
176
178
  }
177
179
  ```
178
180
 
179
- > [!NOTE]
180
- > Prettier formatting for Ruby requires some extra legwork to configure, see [`the @kitschpatrol/prettier-config` package readme](https://github.com/kitschpatrol/shared-config/blob/main/packages/prettier-config/readme.md) for more details.
181
-
182
181
  5. Set up GitHub action credentials (if desired)
183
182
 
184
183
  The GitHub actions included in @kitschpatrol/repo-config require permissions to create releases and update your repository metadata. You can add these through the GitHub website under the _Settings → Secrets and variables → Actions_ page under the key `PERSONAL_ACCESS_TOKEN`, or with the [GitHub CLI](https://cli.github.com/) and a credential manager like [1Password CLI](https://developer.1password.com/docs/cli/get-started/):
@@ -346,18 +345,6 @@ For local development via `pnpm`, use `file:` dependency protocol instead of `li
346
345
 
347
346
  Something to investigate: An [approach](https://github.com/antfu/eslint-config#vs-code-support-auto-fix) to ignoring style rules in VS Code, and possibly migrate all style handling to eslint instead of prettier.
348
347
 
349
- Serial run order:
350
-
351
- 1. `kpi-repo`
352
- 2. `kpi-mdat`
353
- 3. `kpi-typescript`
354
- 4. `kpi-eslint`
355
- 5. `kpi-stylelint`
356
- 6. `kpi-cspell`
357
- 7. `kpi-knip`
358
- 8. `kpi-remark`
359
- 9. `kpi-prettier`
360
-
361
348
  ## Background
362
349
 
363
350
  ### Motivation