@kitschpatrol/prettier-config 4.3.3 → 4.4.0

package/init/.vscode/settings.json

@@ -17,12 +17,13 @@
 	"editor.defaultFormatter": "esbenp.prettier-vscode",
 	"editor.formatOnSave": true,
 	"prettier.documentSelectors": [
-		"**/*.rb",
-		"**/*.astro",
-		"**/*.svelte",
-		"**/.prettierignore",
+		"**/.eslintignore",
+		"**/.node-version",
 		"**/.npmrc",
-		"**/.eslintignore"
+		"**/.prettierignore",
+		"**/*.astro",
+		"**/*.rb",
+		"**/*.svelte"
 	],
 	"prettier.enable": true
 }

package/license.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2024 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/prettier-config",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "type": "module",
   "description": "Prettier config for @kitschpatrol/shared-config",
   "repository": {
@@ -35,17 +35,17 @@
   },
   "dependencies": {
     "@pinojs/json-colorizer": "^4.0.0",
-    "@prettier/plugin-php": "^0.22.1",
+    "@prettier/plugin-php": "^0.22.2",
     "@prettier/plugin-ruby": "^4.0.4",
-    "@prettier/plugin-xml": "^3.2.2",
+    "@prettier/plugin-xml": "^3.3.1",
     "cosmiconfig": "^9.0.0",
     "execa": "^8.0.1",
     "fs-extra": "^11.2.0",
-    "prettier-plugin-astro": "^0.12.3",
-    "prettier-plugin-pkg": "^0.18.0",
-    "prettier-plugin-sh": "^0.13.1",
+    "prettier-plugin-astro": "^0.13.0",
+    "prettier-plugin-pkg": "^0.18.1",
+    "prettier-plugin-sh": "^0.14.0",
     "prettier-plugin-sql": "^0.18.0",
-    "prettier-plugin-svelte": "^3.1.2",
+    "prettier-plugin-svelte": "^3.2.1",
     "prettier-plugin-tailwindcss": "^0.5.11",
     "prettier-plugin-toml": "^2.0.1"
   },
@@ -53,7 +53,7 @@
     "access": "public"
   },
   "scripts": {
-    "build": "../../scripts/build.ts",
+    "build": "../../scripts/build.ts && mdat readme",
     "cli": "node ./bin/cli.js"
   }
 }

package/readme.md

@@ -1,5 +1,16 @@
+<!--+ Warning: Content in HTML comment blocks generated by mdat on 2024-02-20 +-->
+
+<!-- header -->
+
 # @kitschpatrol/prettier-config
 
+[![NPM Package](https://img.shields.io/npm/v/@kitschpatrol/prettier-config.svg)](https://npmjs.com/package/@kitschpatrol/prettier-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Prettier config for @kitschpatrol/shared-config**
+
+<!-- /header -->
+
 ## Overview
 
 It's a shared [Prettier](https://prettier.io) config.
@@ -37,16 +48,39 @@ 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"
 }
-...
 ```
 
 You might need to pass certain plugins in explicitly. The `shared-config --fix` and `shared-config --lint` scripts take care of this for you.
 
+### CLI
+
+<!-- cli-help -->
+
+#### Command: `prettier-config`
+
+Prettier config for @kitschpatrol/shared-config
+
+Usage:
+
+```txt
+prettier-config [<file|glob> ...]
+```
+
+| Option           | Alias | Argument | Description                                                      |
+| ---------------- | ----- | -------- | ---------------------------------------------------------------- |
+| `--check`        | `-c`  |          | Check for and report issues. Same as prettier-config.            |
+| `--fix`          | `-f`  |          | Fix all auto-fixable issues, and report the un-fixable.          |
+| `--init`         | `-i`  |          | Initialize by copying starter config files to your project root. |
+| `--print-config` | `-p`  | `<path>` | Print the effective configuration at a certain path.             |
+| `--help`         | `-h`  |          | Print this help info.                                            |
+| `--version`      | `-v`  |          | Print the package version.                                       |
+
+<!-- /cli-help -->
+
 ## Ruby support
 
 Ruby formatting Expects a global Ruby install >=2.7 via `rbenv` at `~/.rbenv/shims/ruby` with the following gems:
@@ -57,4 +91,12 @@ Ruby formatting Expects a global Ruby install >=2.7 via `rbenv` at `~/.rbenv/shi
 - `syntax_tree-haml`
 - `syntax_tree-rbs`
 
-Note: Do _not_ add `plugins: ['prettier-plugin-ruby']` to, the per-file scope, it must be global.
+Note: Do _not_ add `plugins: ['prettier-plugin-ruby']` to the per-file scope, it must be global.
+
+<!-- license -->
+
+## License
+
+[MIT](license.txt) © Eric Mika
+
+<!-- /license -->