@html-validate/prettier-config 2.1.0 → 2.3.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2022 David Sveningsson <ext@sidvind.com>
+
+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/README.md

@@ -10,12 +10,35 @@ npm install --save-dev @html-validate/prettier-config
 
 ## Usage
 
-In your `package.json` file:
+```
+npm pkg set prettier="@html-validate/prettier-config"
+npm pkg set scripts.prettier:check="prettier --check ."
+npm pkg set scripts.prettier:write="prettier --write ."
+```
+
+Or manually edit `package.json`:
 
 ```json
 {
+  "scripts": {
+    "prettier:check": "prettier --check .",
+    "prettier:write": "prettier --write ."
+  },
   "prettier": "@html-validate/prettier-config"
 }
 ```
 
-Prettier does not need to be installed separately, this package includes `prettier` and it's binary.
+Prettier does not need to be installed separately, this package includes `prettier` and its binary.
+
+## lint-staged
+
+To use lint-staged (included) configure the `pre-commit` hook to run husky with the `--config` flag:
+
+```
+#!/bin/sh
+
+configfile=$(node -p 'require.resolve("@html-validate/prettier-config/lint-staged")')
+exec npm exec lint-staged -- --config "${configfile}"
+```
+
+Lint-staged does not need to be installed separately, this package includes `lint-staged` and its binary.

package/bin/lint-staged.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const path = require("path");
+const { spawn } = require("child_process"); // eslint-disable-line security/detect-child-process
+
+const pkgPath = path.dirname(require.resolve("lint-staged/package.json"));
+const binary = path.join(pkgPath, "bin/lint-staged.js");
+
+spawn("node", [binary, ...process.argv.slice(2)], {
+	stdio: "inherit",
+}).on("exit", (code) => {
+	/* eslint-disable-next-line no-process-exit */
+	process.exit(code);
+});

package/lint-staged.js

@@ -0,0 +1,3 @@
+module.exports = {
+	[`*`]: "prettier --ignore-unknown --write",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-validate/prettier-config",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": "Prettier sharable config used by the various HTML-validate packages",
   "keywords": [
     "prettier"
@@ -17,10 +17,12 @@
   "author": "David Sveningsson <ext@sidvind.com>",
   "main": "index.js",
   "bin": {
-    "prettier": "prettier.js"
+    "lint-staged": "bin/lint-staged.js",
+    "prettier": "bin/prettier.js"
   },
   "files": [
-    "*.js"
+    "*.js",
+    "bin"
   ],
   "scripts": {
     "prepare": "husky install",
@@ -31,31 +33,29 @@
   "commitlint": {
     "extends": "@html-validate"
   },
-  "lint-staged": {
-    "*.{js,json,md}": "prettier --write"
-  },
   "prettier": ".",
+  "release": {
+    "extends": "@html-validate/semantic-release-config"
+  },
   "dependencies": {
-    "prettier": "2.6.2"
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1"
   },
   "devDependencies": {
-    "@html-validate/commitlint-config": "2.1.9",
-    "@html-validate/semantic-release-config": "3.3.0",
-    "husky": "7.0.4",
-    "lint-staged": "12.3.7",
-    "npm-pkg-lint": "1.10.0"
+    "@html-validate/commitlint-config": "3.0.4",
+    "@html-validate/semantic-release-config": "3.5.0",
+    "husky": "8.0.1",
+    "npm-pkg-lint": "1.11.1"
   },
   "engines": {
-    "node": ">= 12.0"
+    "node": ">= 14.13.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "release": {
-    "extends": "@html-validate/semantic-release-config"
-  },
   "renovate": {
     "extends": [
+      "gitlab>html-validate/renovate-config",
       "gitlab>html-validate/renovate-config:bundled"
     ]
   }