@kitschpatrol/shared-config 5.9.1 → 5.10.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 (3) hide show
  1. package/bin/cli.js +41 -41
  2. package/package.json +13 -13
  3. package/readme.md +20 -4
package/bin/cli.js CHANGED
@@ -120,7 +120,7 @@ var require_cjs = __commonJS({
120
120
  return stringValue === "[object RegExp]" || stringValue === "[object Date]" || isReactElement(value);
121
121
  }
122
122
  var canUseSymbol = typeof Symbol === "function" && Symbol.for;
123
- var REACT_ELEMENT_TYPE = canUseSymbol ? Symbol.for("react.element") : 60103;
123
+ var REACT_ELEMENT_TYPE = canUseSymbol ? /* @__PURE__ */ Symbol.for("react.element") : 60103;
124
124
  function isReactElement(value) {
125
125
  return value.$$typeof === REACT_ELEMENT_TYPE;
126
126
  }
@@ -5717,7 +5717,7 @@ var require_ignore = __commonJS({
5717
5717
  var SLASH = "/";
5718
5718
  var TMP_KEY_IGNORE = "node-ignore";
5719
5719
  if (typeof Symbol !== "undefined") {
5720
- TMP_KEY_IGNORE = Symbol.for("node-ignore");
5720
+ TMP_KEY_IGNORE = /* @__PURE__ */ Symbol.for("node-ignore");
5721
5721
  }
5722
5722
  var KEY_IGNORE = TMP_KEY_IGNORE;
5723
5723
  var define = (object, key, value) => {
@@ -6150,7 +6150,7 @@ var require_ignore = __commonJS({
6150
6150
  module.exports = factory;
6151
6151
  factory.default = factory;
6152
6152
  module.exports.isPathValid = isPathValid;
6153
- define(module.exports, Symbol.for("setupWindows"), setupWindows);
6153
+ define(module.exports, /* @__PURE__ */ Symbol.for("setupWindows"), setupWindows);
6154
6154
  }
6155
6155
  });
6156
6156
 
@@ -9646,42 +9646,42 @@ function YargsFactory(_shim) {
9646
9646
  return yargs;
9647
9647
  };
9648
9648
  }
9649
- var kCopyDoubleDash = Symbol("copyDoubleDash");
9650
- var kCreateLogger = Symbol("copyDoubleDash");
9651
- var kDeleteFromParserHintObject = Symbol("deleteFromParserHintObject");
9652
- var kEmitWarning = Symbol("emitWarning");
9653
- var kFreeze = Symbol("freeze");
9654
- var kGetDollarZero = Symbol("getDollarZero");
9655
- var kGetParserConfiguration = Symbol("getParserConfiguration");
9656
- var kGetUsageConfiguration = Symbol("getUsageConfiguration");
9657
- var kGuessLocale = Symbol("guessLocale");
9658
- var kGuessVersion = Symbol("guessVersion");
9659
- var kParsePositionalNumbers = Symbol("parsePositionalNumbers");
9660
- var kPkgUp = Symbol("pkgUp");
9661
- var kPopulateParserHintArray = Symbol("populateParserHintArray");
9662
- var kPopulateParserHintSingleValueDictionary = Symbol("populateParserHintSingleValueDictionary");
9663
- var kPopulateParserHintArrayDictionary = Symbol("populateParserHintArrayDictionary");
9664
- var kPopulateParserHintDictionary = Symbol("populateParserHintDictionary");
9665
- var kSanitizeKey = Symbol("sanitizeKey");
9666
- var kSetKey = Symbol("setKey");
9667
- var kUnfreeze = Symbol("unfreeze");
9668
- var kValidateAsync = Symbol("validateAsync");
9669
- var kGetCommandInstance = Symbol("getCommandInstance");
9670
- var kGetContext = Symbol("getContext");
9671
- var kGetHasOutput = Symbol("getHasOutput");
9672
- var kGetLoggerInstance = Symbol("getLoggerInstance");
9673
- var kGetParseContext = Symbol("getParseContext");
9674
- var kGetUsageInstance = Symbol("getUsageInstance");
9675
- var kGetValidationInstance = Symbol("getValidationInstance");
9676
- var kHasParseCallback = Symbol("hasParseCallback");
9677
- var kIsGlobalContext = Symbol("isGlobalContext");
9678
- var kPostProcess = Symbol("postProcess");
9679
- var kRebase = Symbol("rebase");
9680
- var kReset = Symbol("reset");
9681
- var kRunYargsParserAndExecuteCommands = Symbol("runYargsParserAndExecuteCommands");
9682
- var kRunValidation = Symbol("runValidation");
9683
- var kSetHasOutput = Symbol("setHasOutput");
9684
- var kTrackManuallySetKeys = Symbol("kTrackManuallySetKeys");
9649
+ var kCopyDoubleDash = /* @__PURE__ */ Symbol("copyDoubleDash");
9650
+ var kCreateLogger = /* @__PURE__ */ Symbol("copyDoubleDash");
9651
+ var kDeleteFromParserHintObject = /* @__PURE__ */ Symbol("deleteFromParserHintObject");
9652
+ var kEmitWarning = /* @__PURE__ */ Symbol("emitWarning");
9653
+ var kFreeze = /* @__PURE__ */ Symbol("freeze");
9654
+ var kGetDollarZero = /* @__PURE__ */ Symbol("getDollarZero");
9655
+ var kGetParserConfiguration = /* @__PURE__ */ Symbol("getParserConfiguration");
9656
+ var kGetUsageConfiguration = /* @__PURE__ */ Symbol("getUsageConfiguration");
9657
+ var kGuessLocale = /* @__PURE__ */ Symbol("guessLocale");
9658
+ var kGuessVersion = /* @__PURE__ */ Symbol("guessVersion");
9659
+ var kParsePositionalNumbers = /* @__PURE__ */ Symbol("parsePositionalNumbers");
9660
+ var kPkgUp = /* @__PURE__ */ Symbol("pkgUp");
9661
+ var kPopulateParserHintArray = /* @__PURE__ */ Symbol("populateParserHintArray");
9662
+ var kPopulateParserHintSingleValueDictionary = /* @__PURE__ */ Symbol("populateParserHintSingleValueDictionary");
9663
+ var kPopulateParserHintArrayDictionary = /* @__PURE__ */ Symbol("populateParserHintArrayDictionary");
9664
+ var kPopulateParserHintDictionary = /* @__PURE__ */ Symbol("populateParserHintDictionary");
9665
+ var kSanitizeKey = /* @__PURE__ */ Symbol("sanitizeKey");
9666
+ var kSetKey = /* @__PURE__ */ Symbol("setKey");
9667
+ var kUnfreeze = /* @__PURE__ */ Symbol("unfreeze");
9668
+ var kValidateAsync = /* @__PURE__ */ Symbol("validateAsync");
9669
+ var kGetCommandInstance = /* @__PURE__ */ Symbol("getCommandInstance");
9670
+ var kGetContext = /* @__PURE__ */ Symbol("getContext");
9671
+ var kGetHasOutput = /* @__PURE__ */ Symbol("getHasOutput");
9672
+ var kGetLoggerInstance = /* @__PURE__ */ Symbol("getLoggerInstance");
9673
+ var kGetParseContext = /* @__PURE__ */ Symbol("getParseContext");
9674
+ var kGetUsageInstance = /* @__PURE__ */ Symbol("getUsageInstance");
9675
+ var kGetValidationInstance = /* @__PURE__ */ Symbol("getValidationInstance");
9676
+ var kHasParseCallback = /* @__PURE__ */ Symbol("hasParseCallback");
9677
+ var kIsGlobalContext = /* @__PURE__ */ Symbol("isGlobalContext");
9678
+ var kPostProcess = /* @__PURE__ */ Symbol("postProcess");
9679
+ var kRebase = /* @__PURE__ */ Symbol("rebase");
9680
+ var kReset = /* @__PURE__ */ Symbol("reset");
9681
+ var kRunYargsParserAndExecuteCommands = /* @__PURE__ */ Symbol("runYargsParserAndExecuteCommands");
9682
+ var kRunValidation = /* @__PURE__ */ Symbol("runValidation");
9683
+ var kSetHasOutput = /* @__PURE__ */ Symbol("setHasOutput");
9684
+ var kTrackManuallySetKeys = /* @__PURE__ */ Symbol("kTrackManuallySetKeys");
9685
9685
  var YargsInstance = class {
9686
9686
  constructor(processArgs = [], cwd, parentRequire, shim3) {
9687
9687
  this.customScriptName = false;
@@ -11084,7 +11084,7 @@ var Yargs = YargsFactory(esm_default);
11084
11084
  var yargs_default = Yargs;
11085
11085
 
11086
11086
  // ../../package.json
11087
- var version = "5.9.1";
11087
+ var version = "5.10.0";
11088
11088
 
11089
11089
  // ../../src/execa-utilities.ts
11090
11090
  function isErrorExecaError(error) {
@@ -12395,7 +12395,7 @@ var MergedStream = class extends PassThroughStream {
12395
12395
  #ended = /* @__PURE__ */ new Set([]);
12396
12396
  #aborted = /* @__PURE__ */ new Set([]);
12397
12397
  #onFinished;
12398
- #unpipeEvent = Symbol("unpipe");
12398
+ #unpipeEvent = /* @__PURE__ */ Symbol("unpipe");
12399
12399
  #streamPromises = /* @__PURE__ */ new WeakMap();
12400
12400
  add(stream) {
12401
12401
  validateStream(stream);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kitschpatrol/shared-config",
3
- "version": "5.9.1",
3
+ "version": "5.10.0",
4
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",
@@ -40,19 +40,19 @@
40
40
  "@pinojs/json-colorizer": "^4.0.0",
41
41
  "cosmiconfig": "^9.0.0",
42
42
  "cosmiconfig-typescript-loader": "^6.2.0",
43
- "execa": "^9.6.0",
43
+ "execa": "^9.6.1",
44
44
  "find-workspaces": "^0.3.1",
45
45
  "fs-extra": "^11.3.2",
46
- "prettier": "^3.6.2",
47
- "@kitschpatrol/cspell-config": "5.9.1",
48
- "@kitschpatrol/eslint-config": "5.9.1",
49
- "@kitschpatrol/knip-config": "5.9.1",
50
- "@kitschpatrol/mdat-config": "5.9.1",
51
- "@kitschpatrol/stylelint-config": "5.9.1",
52
- "@kitschpatrol/remark-config": "5.9.1",
53
- "@kitschpatrol/prettier-config": "5.9.1",
54
- "@kitschpatrol/typescript-config": "5.9.1",
55
- "@kitschpatrol/repo-config": "5.9.1"
46
+ "prettier": "^3.7.4",
47
+ "@kitschpatrol/cspell-config": "5.10.0",
48
+ "@kitschpatrol/knip-config": "5.10.0",
49
+ "@kitschpatrol/prettier-config": "5.10.0",
50
+ "@kitschpatrol/mdat-config": "5.10.0",
51
+ "@kitschpatrol/stylelint-config": "5.10.0",
52
+ "@kitschpatrol/eslint-config": "5.10.0",
53
+ "@kitschpatrol/typescript-config": "5.10.0",
54
+ "@kitschpatrol/remark-config": "5.10.0",
55
+ "@kitschpatrol/repo-config": "5.10.0"
56
56
  },
57
57
  "devDependencies": {
58
58
  "globby": "^15.0.0",
@@ -65,7 +65,7 @@
65
65
  "access": "public"
66
66
  },
67
67
  "scripts": {
68
- "build": "../../scripts/build.ts",
68
+ "build": "tsx ../../scripts/build.ts",
69
69
  "clean": "pnpm run bin-restore ; git clean -fdX",
70
70
  "cli": "node ./bin/cli.js"
71
71
  }
package/readme.md CHANGED
@@ -155,7 +155,7 @@ pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init && pnpm i && pnpm add
155
155
 
156
156
  #### Step-by-step:
157
157
 
158
- 1. Install the requisite `.npmrc`:
158
+ 1. Install the requisite basic repository configuration files:
159
159
 
160
160
  ```sh
161
161
  pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init
@@ -327,6 +327,22 @@ Recall that the `@kitschpatrol/shared-config` package aggregates integration and
327
327
 
328
328
  ## Implementation notes
329
329
 
330
+ ### Line endings
331
+
332
+ This project standardizes on LF (`\n`) line endings across all platforms. This is enforced via Prettier's `endOfLine: 'lf'` setting in [`@kitschpatrol/prettier-config`](https://github.com/kitschpatrol/shared-config/blob/main/packages/prettier-config/readme.md).
333
+
334
+ It is expected that your git configuration is set to avoid automatic line ending conversion. You can ensure this by adding the following to your global git config:
335
+
336
+ ```sh
337
+ git config --global core.autocrlf false
338
+ ```
339
+
340
+ Future versions of `@kitschpatrol/shared-config` might enforce this via a `.gitattributes` file.
341
+
342
+ ### Windows compatibility
343
+
344
+ This project works on Windows, but it's recommend to run commands in a [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) environment or a Bash-compatible terminal like [Git Bash](https://git-scm.com/download/win) to avoid potential issues with package scripts.
345
+
330
346
  ### `check` vs `lint`
331
347
 
332
348
  This project combines a mix of tools that regard their core task variously as "linting" or "checking" code and prose.
@@ -341,9 +357,9 @@ The monorepo must be kept intact, as the sub-packages depend on scripts in the p
341
357
 
342
358
  ### Hoisting caveats
343
359
 
344
- The pnpm authors consider module hoisting harmful, and I tend to agree, but certain exceptions are carved out as necessary and accommodated via the `.npmrc` file included in `@kitschpatrol/repo-config`:
360
+ The pnpm authors consider module hoisting harmful, and I tend to agree, but certain exceptions are carved out as necessary and accommodated via the `pnpm-workspace.yaml` file included in `@kitschpatrol/repo-config`:
345
361
 
346
- - CSpell, remark, mdat, ESLint, and Prettier all need to be hoisted via `public-hoist-pattern` to be accessible in `pnpm exec` scripts and to VS Code plugins.
362
+ - CSpell, remark, mdat, ESLint, and Prettier all need to be hoisted via the `publicHoistPattern` array in `pnpm-workspace.yaml` in order to resolve correctly in `pnpm exec` scripts, VS Code plugins, and elsewhere.
347
363
 
348
364
  - Even basic file-only packages like `repo-config` seem to need to be hoisted via for their bin scripts to be accessible via `pnpm exec`
349
365
 
@@ -376,7 +392,7 @@ Something to investigate: An [approach](https://github.com/antfu/eslint-config#v
376
392
  - [antfu/eslint-config](https://github.com/antfu/eslint-config)
377
393
  - [awesome-eslint](https://github.com/dustinspecker/awesome-eslint)
378
394
  - [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app)
379
- - [envsa/shared-config](https://github.com/envsa/shared-config) (Liam Rella's fork of `@kitschpatrol/shared-config`)
395
+ - [envsa/shared-config](https://www.npmjs.com/package/@envsa/shared-config) (Liam Rella's fork of `@kitschpatrol/shared-config`)
380
396
  - [eslint-config-current-thing](https://github.com/GildedPleb/eslint-config-current-thing) _(Smart!)_
381
397
  - [eslint-config-hyperse](https://github.com/hyperse-io/eslint-config-hyperse)
382
398
  - [lass](https://lass.js.org) (xo etc.)