@kitschpatrol/shared-config 5.7.1 → 5.7.3

package/bin/cli.js

@@ -11084,7 +11084,7 @@ var Yargs = YargsFactory(esm_default);
 var yargs_default = Yargs;
 
 // ../../package.json
-var version = "5.7.1";
+var version = "5.7.3";
 
 // ../../src/execa-utilities.ts
 function isErrorExecaError(error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/shared-config",
-  "version": "5.7.1",
+  "version": "5.7.3",
   "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.",
   "keywords": [
     "shared-config",
@@ -39,20 +39,20 @@
   "dependencies": {
     "@pinojs/json-colorizer": "^4.0.0",
     "cosmiconfig": "^9.0.0",
-    "cosmiconfig-typescript-loader": "^6.1.0",
+    "cosmiconfig-typescript-loader": "^6.2.0",
     "execa": "^9.6.0",
     "find-workspaces": "^0.3.1",
     "fs-extra": "^11.3.2",
     "prettier": "^3.6.2",
-    "@kitschpatrol/cspell-config": "5.7.1",
-    "@kitschpatrol/knip-config": "5.7.1",
-    "@kitschpatrol/eslint-config": "5.7.1",
-    "@kitschpatrol/remark-config": "5.7.1",
-    "@kitschpatrol/mdat-config": "5.7.1",
-    "@kitschpatrol/repo-config": "5.7.1",
-    "@kitschpatrol/prettier-config": "5.7.1",
-    "@kitschpatrol/stylelint-config": "5.7.1",
-    "@kitschpatrol/typescript-config": "5.7.1"
+    "@kitschpatrol/cspell-config": "5.7.3",
+    "@kitschpatrol/eslint-config": "5.7.3",
+    "@kitschpatrol/mdat-config": "5.7.3",
+    "@kitschpatrol/remark-config": "5.7.3",
+    "@kitschpatrol/knip-config": "5.7.3",
+    "@kitschpatrol/prettier-config": "5.7.3",
+    "@kitschpatrol/repo-config": "5.7.3",
+    "@kitschpatrol/stylelint-config": "5.7.3",
+    "@kitschpatrol/typescript-config": "5.7.3"
   },
   "devDependencies": {
     "globby": "^15.0.0",

package/readme.md

@@ -121,24 +121,36 @@ The top-level `ksc` command also takes care of some nuances in terms of _which_
 
 ### Installation
 
-#### Quick start from scratch:
+There are a few different ways to integrate `@kitschpatrol/shared-config` into your project, depending on whether you're starting from scratch or adding it to an existing project.
 
-Bootstrap a new project and open in VS Code:
+#### Create new project from a template:
+
+The easiest way to get started is to create a new project from a starter template:
+
+```sh
+pnpm create @kitschpatrol/project
+```
+
+See the [template repository](https://github.com/kitschpatrol/create-project) for more details.
+
+#### Bootstrap from scratch:
+
+Alternatively, this one-liner will bootstrap a new project and open it in VS Code, but the template approach above is preferred:
 
 ```sh
-git init && pnpm init && pnpm pkg set type="module" && pnpm dlx @kitschpatrol/repo-config init && pnpm add -D @kitschpatrol/shared-config && pnpm ksc init && pnpm i && code .
+git init && pnpm init && pnpm pkg set type="module" && pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init && pnpm add -D @kitschpatrol/shared-config && pnpm ksc init && pnpm i && code .
 ```
 
-Note that `ksc init` takes an optional `--location package` flag will put as much configuration in your `package.json` as possible instead of creating discrete config files in your project root for each tool. Putting config in `package.json` can save some clutter, but can make it clunkier to extend or customize configurations.
+Note that `ksc init` takes an optional `--location package` flag will put as much configuration in your `package.json` as possible instead of creating discrete config files in your project root for each tool. Putting config in `package.json` can save some clutter, but it makes configs less discoverable and can make it clunkier to extend or customize configurations since you don't have the benefit of type safety and autocomplete.
 
 At any point, you can call `ksc init` again with the `--location package` or `--location file` flag to reinitialize your configuration files in one place or the other and restore the default configurations.
 
-#### Quick add to an existing project:
+#### Add to an existing project:
 
 This might overwrite certain config files, so commit first:
 
 ```sh
-pnpm dlx @kitschpatrol/repo-config init && pnpm i && pnpm add -D @kitschpatrol/shared-config && pnpm ksc init
+pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init && pnpm i && pnpm add -D @kitschpatrol/shared-config && pnpm ksc init
 ```
 
 #### Step-by-step:
@@ -146,7 +158,7 @@ pnpm dlx @kitschpatrol/repo-config init && pnpm i && pnpm add -D @kitschpatrol/s
 1. Install the requisite `.npmrc`:
 
    ```sh
-   pnpm dlx @kitschpatrol/repo-config init
+   pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init
    ```
 
 2. Install the package: