@kitschpatrol/prettier-config 4.7.11 → 5.0.0

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import type { Config as PrettierConfig } from 'prettier';
+declare const sharedPrettierConfig: PrettierConfig;
+/**
+ * **\@Kitschpatrol's Shared Prettier Configuration**
+ * @see [@kitschpatrol/prettier-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/prettier-config)
+ * @see [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config)
+ * @example
+ * ```js
+ * export default prettierConfig({
+ *   printWidth: 120,
+ * })
+ * ```
+ */
+export declare function prettierConfig(config?: PrettierConfig): PrettierConfig;
+export default sharedPrettierConfig;

package/dist/index.js

@@ -0,0 +1,72 @@
+import { deepmerge } from 'deepmerge-ts';
+import { homedir } from 'node:os';
+// export { commandDefinition } from './command.js'
+const sharedPrettierConfig = {
+    bracketSpacing: true,
+    overrides: [
+        {
+            files: ['*.md', '*.mdx', '*.yml'],
+            options: {
+                useTabs: false,
+            },
+        },
+        {
+            files: '*.astro',
+            options: {
+                parser: 'astro',
+                plugins: ['prettier-plugin-astro'],
+            },
+        },
+        {
+            files: '*.svelte',
+            options: {
+                parser: 'svelte',
+                plugins: ['prettier-plugin-svelte'],
+            },
+        },
+        {
+            files: '*.rb',
+            options: {
+                rubyExecutablePath: `${homedir()}/.rbenv/shims/ruby`,
+            },
+        },
+        {
+            files: ['*rc', '*ignore', '*.sh', '*.zsh', '*.bash', '*.fish'],
+            options: {
+                parser: 'sh',
+                plugins: ['prettier-plugin-sh'],
+            },
+        },
+    ],
+    plugins: [
+        '@prettier/plugin-php',
+        '@prettier/plugin-ruby',
+        '@prettier/plugin-xml',
+        'prettier-plugin-packagejson',
+        'prettier-plugin-sh',
+        'prettier-plugin-sql',
+        'prettier-plugin-tailwindcss',
+        'prettier-plugin-toml',
+    ],
+    printWidth: 100,
+    semi: false,
+    singleQuote: true,
+    tabWidth: 2,
+    trailingComma: 'all',
+    useTabs: true,
+};
+/**
+ * **\@Kitschpatrol's Shared Prettier Configuration**
+ * @see [@kitschpatrol/prettier-config](https://github.com/kitschpatrol/shared-config/tree/main/packages/prettier-config)
+ * @see [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config)
+ * @example
+ * ```js
+ * export default prettierConfig({
+ *   printWidth: 120,
+ * })
+ * ```
+ */
+export function prettierConfig(config) {
+    return deepmerge(sharedPrettierConfig, config);
+}
+export default sharedPrettierConfig;

package/init/.prettierignore

@@ -1,20 +1,5 @@
 # Prettier Ignore
-# Does not inherit from .gitignore
-
-# @kitschpatrol/repo-config boilerplate
-.astro/
-.DS_Store
-.svelte-kit/
-{tmp,temp}/
-**/*.min.js
-/scratch/
-bower_components/
-build/
-coverage/
-dist/
-node_modules/
-vendor/
-.parcel-cache/
+# Also respects .gitignore
 
 # @kitschpatrol/prettier-config boilerplate
 pnpm-lock.yaml

package/init/.vscode/settings.json

@@ -25,5 +25,6 @@
 		"**/*.rb",
 		"**/*.svelte"
 	],
+
 	"prettier.enable": true
 }

package/init/prettier.config.js

@@ -0,0 +1,3 @@
+import { prettierConfig } from '@kitschpatrol/prettier-config'
+
+export default prettierConfig()

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023-2024 Eric Mika
+Copyright (c) 2023-2025 Eric Mika
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,62 +1,71 @@
 {
   "name": "@kitschpatrol/prettier-config",
-  "version": "4.7.11",
-  "type": "module",
+  "version": "5.0.0",
   "description": "Prettier configuration for @kitschpatrol/shared-config.",
+  "keywords": [
+    "shared-config",
+    "prettier-config",
+    "prettier",
+    "cli",
+    "kpi",
+    "kpi-prettier"
+  ],
+  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kitschpatrol/shared-config/cli.git",
     "directory": "packages/prettier-config"
   },
-  "bugs": "https://github.com/kitschpatrol/shared-config/issues",
+  "license": "MIT",
   "author": {
     "name": "Eric Mika",
     "email": "eric@ericmika.com",
     "url": "https://ericmika.com"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0",
-    "pnpm": ">=8.0.0"
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
   },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "bin": {
-    "prettier-config": "bin/cli.js"
+    "kpi-prettier": "bin/cli.js"
   },
-  "main": "prettier.config.js",
   "files": [
     "bin/*",
+    "dist/*",
     "init/*"
   ],
-  "keywords": [
-    "shared-config",
-    "prettier-config",
-    "prettier",
-    "cli"
-  ],
-  "peerDependencies": {
-    "prettier": "^3.3.3"
-  },
   "dependencies": {
     "@pinojs/json-colorizer": "^4.0.0",
-    "@prettier/plugin-php": "^0.22.2",
+    "@prettier/plugin-php": "^0.22.4",
     "@prettier/plugin-ruby": "^4.0.4",
     "@prettier/plugin-xml": "^3.4.1",
     "cosmiconfig": "^9.0.0",
-    "execa": "^8.0.1",
-    "fs-extra": "^11.2.0",
+    "deepmerge-ts": "^7.1.4",
+    "execa": "^9.5.2",
+    "fs-extra": "^11.3.0",
+    "prettier": "^3.4.2",
     "prettier-plugin-astro": "^0.14.1",
-    "prettier-plugin-pkg": "^0.18.1",
+    "prettier-plugin-packagejson": "^2.5.8",
     "prettier-plugin-sh": "^0.14.0",
     "prettier-plugin-sql": "^0.18.1",
-    "prettier-plugin-svelte": "^3.2.7",
-    "prettier-plugin-tailwindcss": "^0.6.8",
+    "prettier-plugin-svelte": "^3.3.3",
+    "prettier-plugin-tailwindcss": "^0.6.11",
     "prettier-plugin-toml": "^2.0.1"
   },
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "build": "../../scripts/build.ts && pnpm mdat readme",
+    "build": "tsc && ../../scripts/build.ts",
     "cli": "node ./bin/cli.js"
   }
 }

package/readme.md

@@ -21,9 +21,17 @@
 
 ## Overview
 
-It's a shared [Prettier](https://prettier.io) config.
+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.
 
-**See [`@kitschpatrol/shared-config`](https://www.npmjs.com/package/@kitschpatrol/shared-config) for the recommended single-package approach.**
+<!-- recommendation -->
+
+> [!Important]
+>
+> **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.**
+>
+> 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
+
+<!-- /recommendation -->
 
 ## Setup
 
@@ -32,7 +40,7 @@ To use just this Prettier config in isolation:
 1. Install the `.npmrc` in your project root. This is required for correct PNPM behavior:
 
    ```sh
-   pnpm dlx @kitschpatrol/repo-config --init
+   pnpm dlx @kitschpatrol/repo-config init
    ```
 
 2. Add the package:
@@ -44,7 +52,7 @@ To use just this Prettier config in isolation:
 3. Add the starter `.prettierrc.js` and `.prettierignore` files to your project root, and add any customizations you'd like:
 
    ```sh
-   pnpm exec prettier-config --init
+   pnpm exec kpi-prettier init
    ```
 
 ## Usage
@@ -56,36 +64,134 @@ You can call it directly, or use the script bundled with the config.
 Integrate with your `package.json` scripts as you see fit, for example:
 
 ```json
-"scripts": {
-  "lint": "prettier-config --check"
-  "format": "prettier-config --fix"
+{
+  "scripts": {
+    "lint": "kpi-prettier lint",
+    "fix": "kpi-prettier fix"
+  }
 }
 ```
 
-You might need to pass certain plugins in explicitly. The `shared-config --fix` and `shared-config --lint` scripts take care of this for you.
+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.
+
+### Configuration
+
+To create a `prettier.config.js` in your project root:
+
+```sh
+pnpm exec kpi-prettier init
+```
+
+(Note that this will delete the `prettier` property in your `package.json`!)
+
+_Or_
+
+To create a `prettier` property in `package.json`:
+
+```sh
+pnpm exec kpi-prettier init --location package
+```
+
+(Note that this will delete the `prettier.config.js` file in your project root!)
 
 ### CLI
 
 <!-- cli-help -->
 
-#### Command: `prettier-config`
+#### Command: `kpi-prettier`
+
+Kitschpatrol's Prettier shared configuration tools.
+
+This section lists top-level commands for `kpi-prettier`.
+
+Usage:
+
+```txt
+kpi-prettier <command>
+```
+
+| Command        | Argument    | Description                                                                                                                            |
+| -------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| `init`         |             | Initialize by copying starter config files to your project root or to your package.json file.                                          |
+| `lint`         | `[files..]` | Check that files are formatted according to your Prettier configuration. Matches files below the current working directory by default. |
+| `fix`          | `[files..]` | Format files according to your Prettier configuration. Matches files below the current working directory by default.                   |
+| `print-config` |             | Print the effective Prettier configuration. Package-scoped.. Searches up to the root of a monorepo if necessary..                      |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+_See the sections below for more information on each subcommand._
+
+#### Subcommand: `kpi-prettier init`
+
+Initialize by copying starter config files to your project root or to your package.json file.
+
+Usage:
+
+```txt
+kpi-prettier init
+```
+
+| Option              | Description         | Type                 | Default  |
+| ------------------- | ------------------- | -------------------- | -------- |
+| `--location`        | TK                  | `"file"` `"package"` | `"file"` |
+| `--help`<br>`-h`    | Show help           | `boolean`            |          |
+| `--version`<br>`-v` | Show version number | `boolean`            |          |
+
+#### Subcommand: `kpi-prettier lint`
+
+Check that files are formatted according to your Prettier configuration. Matches files below the current working directory by default.
+
+Usage:
+
+```txt
+kpi-prettier lint [files..]
+```
+
+| Positional Argument | Description                    | Type    | Default |
+| ------------------- | ------------------------------ | ------- | ------- |
+| `files`             | Files or glob pattern to lint. | `array` | `"."`   |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
 
-Prettier configuration for @kitschpatrol/shared-config.
+#### Subcommand: `kpi-prettier fix`
+
+Format files according to your Prettier configuration. Matches files below the current working directory by default.
 
 Usage:
 
 ```txt
-prettier-config [<file|glob> ...]
+kpi-prettier fix [files..]
 ```
 
-| Option                   | Argument | Description                                                      |
-| ------------------------ | -------- | ---------------------------------------------------------------- |
-| `--check`<br>`-c`        |          | Check for and report issues. Same as `prettier-config`.          |
-| `--fix`<br>`-f`          |          | Fix all auto-fixable issues, and report the un-fixable.          |
-| `--init`<br>`-i`         |          | Initialize by copying starter config files to your project root. |
-| `--print-config`<br>`-p` | `<path>` | Print the effective configuration at a certain path.             |
-| `--help`<br>`-h`         |          | Print this help info.                                            |
-| `--version`<br>`-v`      |          | Print the package version.                                       |
+| Positional Argument | Description                   | Type    | Default |
+| ------------------- | ----------------------------- | ------- | ------- |
+| `files`             | Files or glob pattern to fix. | `array` | `"."`   |
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
+
+#### Subcommand: `kpi-prettier print-config`
+
+Print the effective Prettier configuration. Package-scoped.. Searches up to the root of a monorepo if necessary..
+
+Usage:
+
+```txt
+kpi-prettier print-config
+```
+
+| Option              | Description         | Type      |
+| ------------------- | ------------------- | --------- |
+| `--help`<br>`-h`    | Show help           | `boolean` |
+| `--version`<br>`-v` | Show version number | `boolean` |
 
 <!-- /cli-help -->
 
@@ -105,11 +211,9 @@ Note: Do _not_ add `plugins: ['prettier-plugin-ruby']` to the per-file scope, it
 
 Tabs are unambiguously preferred wherever the file format specification does not mandate spaces.
 
-The reluctant exceptions are:
-
-### JSON
+Note that despite widely-accepted FUD regarding JSON requiring spaces, the [specification](https://www.json.org/json-en.html) indicates otherwise. So we use tabs.
 
-Despite widely accepted FUD regarding JSON requiring spaces, the [specification](https://www.json.org/json-en.html) indicates otherwise.
+The reluctant exceptions are:
 
 ### YAML
 

package/init/.prettierrc.js

@@ -1,16 +0,0 @@
-import sharedConfig from '@kitschpatrol/prettier-config'
-
-/** @type {import("prettier").Config} */
-const localConfig = {
-	// Config overrides
-	// overrides: [
-	// 	...sharedConfig.overrides,
-	// 	{
-	// 		// Per-file overrides overrides
-	// 	},
-	// ],
-}
-export default {
-	...sharedConfig,
-	...localConfig,
-}

package/prettier.config.js

@@ -1,59 +0,0 @@
-import { homedir } from 'node:os'
-
-/** @type {import("prettier").Config} */
-const config = {
-	bracketSpacing: true,
-	overrides: [
-		{
-			files: ['*.md', '*.mdx', '*.yml'],
-			options: {
-				useTabs: false,
-			},
-		},
-		{
-			files: '*.astro',
-			options: {
-				parser: 'astro',
-				plugins: ['prettier-plugin-astro'],
-			},
-		},
-		{
-			files: '*.svelte',
-			options: {
-				parser: 'svelte',
-				plugins: ['prettier-plugin-svelte'],
-			},
-		},
-		{
-			files: '*.rb',
-			options: {
-				rubyExecutablePath: `${homedir}/.rbenv/shims/ruby`,
-			},
-		},
-		{
-			files: ['*rc', '*ignore', '*.sh', '*.zsh', '*.bash', '*.fish'],
-			options: {
-				parser: 'sh',
-				plugins: ['prettier-plugin-sh'],
-			},
-		},
-	],
-	plugins: [
-		'@prettier/plugin-php',
-		'@prettier/plugin-ruby',
-		'@prettier/plugin-xml',
-		'prettier-plugin-pkg',
-		'prettier-plugin-sh',
-		'prettier-plugin-sql',
-		'prettier-plugin-tailwindcss',
-		'prettier-plugin-toml',
-	],
-	printWidth: 100,
-	semi: false,
-	singleQuote: true,
-	tabWidth: 2,
-	trailingComma: 'all',
-	useTabs: true,
-}
-
-export default config