Merge pull request #591 from tynanbe/prettier

Tooling to format and check formatting for PHP files

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+      - "v*.*"
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          check-latest: true
+          cache: npm
+          cache-dependency-path: package-lock.json
+
+      - run: npm ci
+
+      - run: npm run format-check

.gitignore

@@ -0,0 +1,8 @@
+*.local
+*.log
+*.swp
+.DS_Store
+.cache
+.env*
+.vscode
+node_modules

.prettierrc

@@ -1,10 +1,16 @@
 {
+	"plugins": [
+		"@prettier/plugin-php"
+	],
+	"arrowParens": "avoid",
+	"braceStyle": "per-cs",
 	"endOfLine": "auto",
-	"tabWidth": 4,
+	"phpVersion": "5.3",
 	"printWidth": 180,
-	"useTabs": true,
 	"semi": true,
 	"singleQuote": true,
+	"tabWidth": 4,
 	"trailingComma": "all",
-	"arrowParens": "avoid"
+	"trailingCommaPHP": false,
+	"useTabs": true
 }

package.json

@@ -0,0 +1,14 @@
+{
+	"name": "litespeed-cache",
+	"description": "High-performance page caching and site optimization from LiteSpeed",
+	"license": "GPLv3",
+	"scripts": {
+		"format": "npm run prettier -- --write",
+		"format-check": "npm run prettier -- --check",
+		"prettier": "prettier *.php cli/*.php cli/**/*.php inc/*.php inc/**/*.php src/*.php src/**/*.php thirdparty/*.php thirdparty/**/*.php tpl/*.php tpl/**/*.php"
+	},
+	"devDependencies": {
+		"@prettier/plugin-php": "^0.21.0",
+		"prettier": "^3.0.3"
+	}
+}