chore: add PHPStan static analysis

.eslintrc.json

@@ -1,185 +1,51 @@
 {
+	"extends": "plugin:@wordpress/eslint-plugin/recommended",
 	"parser": "@babel/eslint-parser",
-	"globals": {
-		"wp": true,
-		"wpApiSettings": true,
-		"window": true,
-		"document": true,
-		"simple_comment_editing": true
-	},
-	"env": {
-		"browser": true,
-		"node": true,
-		"es6": true,
-		"jest/globals": true
-	},
 	"parserOptions": {
-		"ecmaVersion": 6,
+		"ecmaVersion": 2021,
 		"sourceType": "module",
 		"ecmaFeatures": {
-			"jsx": true,
-			"experimentalObjectRestSpread": true
+			"jsx": true
 		},
 		"requireConfigFile": false
 	},
-	"extends": ["plugin:@wordpress/eslint-plugin/recommended-with-formatting"],
-	"plugins": ["react", "jsx-a11y", "jest"],
-	"settings": {
-		"react": {
-			"pragma": "wp"
-		}
+	"env": {
+		"browser": true,
+		"node": true,
+		"es2021": true
+	},
+	"globals": {
+		"$": "readonly",
+		"jQuery": "readonly",
+		"sceIntegrations": "readonly",
+		"simple_comment_editing": "readonly",
+		"wp": "readonly",
+		"wpApiSettings": "readonly",
+		"wpAjax": "readonly"
 	},
 	"rules": {
-		"array-bracket-spacing": ["error", "always"],
-		"brace-style": ["error", "1tbs"],
-		"camelcase": 0,
-		"comma-dangle": ["error", "always-multiline"],
-		"comma-spacing": "error",
-		"comma-style": "error",
-		"computed-property-spacing": ["error", "always"],
-		"constructor-super": "error",
-		"dot-notation": "error",
-		"eol-last": "error",
-		"eqeqeq": "error",
-		"func-call-spacing": "error",
-		"indent": ["error", "tab", { "SwitchCase": 1 }],
-		"jsx-a11y/label-has-for": [
-			"error",
-			{
-				"required": "id"
-			}
-		],
-		"jsx-a11y/media-has-caption": "off",
-		"jsx-a11y/no-noninteractive-tabindex": "off",
-		"jsx-a11y/role-has-required-aria-props": "off",
-		"jsx-quotes": "error",
-		"key-spacing": "error",
-		"keyword-spacing": "error",
-		"lines-around-comment": "off",
-		"no-alert": "error",
-		"no-bitwise": "error",
-		"no-caller": "error",
-		"no-console": "error",
-		"no-const-assign": "error",
-		"no-debugger": "error",
-		"no-dupe-args": "error",
-		"no-dupe-class-members": "error",
-		"no-dupe-keys": "error",
-		"no-duplicate-case": "error",
-		"no-duplicate-imports": "error",
-		"no-else-return": "error",
-		"no-eval": "error",
-		"no-extra-semi": "error",
-		"no-fallthrough": "error",
-		"no-lonely-if": "error",
-		"no-mixed-operators": "error",
-		"no-mixed-spaces-and-tabs": "error",
-		"no-multiple-empty-lines": ["error", { "max": 1 }],
-		"no-multi-spaces": "error",
-		"no-multi-str": "off",
-		"no-negated-in-lhs": "error",
-		"no-nested-ternary": "error",
-		"no-redeclare": "error",
-		"no-restricted-syntax": [
-			"error",
-			{
-				"selector": "ImportDeclaration[source.value=/^@wordpress\\u002F.+\\u002F/]",
-				"message": "Path access on WordPress dependencies is not allowed."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^blocks$/]",
-				"message": "Use @wordpress/blocks as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^components$/]",
-				"message": "Use @wordpress/components as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^date$/]",
-				"message": "Use @wordpress/date as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^editor$/]",
-				"message": "Use @wordpress/editor as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^element$/]",
-				"message": "Use @wordpress/element as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^i18n$/]",
-				"message": "Use @wordpress/i18n as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^data$/]",
-				"message": "Use @wordpress/data as import path instead."
-			},
-			{
-				"selector": "ImportDeclaration[source.value=/^utils$/]",
-				"message": "Use @wordpress/utils as import path instead."
-			},
-			{
-				"selector": "CallExpression[callee.name=/^__|_n|_x$/]:not([arguments.0.type=/^Literal|BinaryExpression$/])",
-				"message": "Translate function arguments must be string literals."
-			},
-			{
-				"selector": "CallExpression[callee.name=/^_n|_x$/]:not([arguments.1.type=/^Literal|BinaryExpression$/])",
-				"message": "Translate function arguments must be string literals."
-			},
-			{
-				"selector": "CallExpression[callee.name=_nx]:not([arguments.2.type=/^Literal|BinaryExpression$/])",
-				"message": "Translate function arguments must be string literals."
-			}
-		],
-		"no-shadow": "error",
-		"no-undef": "error",
-		"no-undef-init": "error",
-		"no-unreachable": "error",
-		"no-unsafe-negation": "error",
-		"no-unused-expressions": "error",
-		"no-unused-vars": "error",
-		"no-useless-computed-key": "error",
-		"no-useless-constructor": "error",
-		"no-useless-return": "error",
-		"no-var": "error",
-		"no-whitespace-before-property": "error",
-		"object-curly-spacing": ["error", "always"],
-		"padded-blocks": ["error", "never"],
-		"prefer-const": "error",
-		"quote-props": ["error", "as-needed"],
-		"react/display-name": "off",
-		"react/jsx-curly-spacing": [
-			"error",
-			{
-				"when": "always",
-				"children": true
-			}
-		],
-		"react/jsx-equals-spacing": "error",
-		"react/jsx-indent": ["error", "tab"],
-		"react/jsx-indent-props": ["error", "tab"],
-		"react/jsx-key": "error",
-		"react/jsx-tag-spacing": "error",
-		"react/no-children-prop": "off",
-		"react/no-find-dom-node": "warn",
-		"react/prop-types": "off",
-		"semi": "error",
-		"semi-spacing": "error",
-		"space-before-blocks": ["error", "always"],
-		"space-before-function-paren": ["error", "never"],
-		"space-in-parens": ["error", "always"],
-		"space-infix-ops": ["error", { "int32Hint": false }],
-		"space-unary-ops": [
-			"error",
-			{
-				"overrides": {
-					"!": true
-				}
-			}
-		],
-		"template-curly-spacing": ["error", "always"],
-		"valid-jsdoc": ["error", { "requireReturn": false }],
-		"valid-typeof": "error",
-		"yoda": "off"
-	}
+		"@wordpress/no-unsafe-wp-apis": "warn",
+		"@wordpress/no-unused-vars-before-return": "warn",
+		"camelcase": "off",
+		"eqeqeq": "warn",
+		"import/no-unresolved": "warn",
+		"jsdoc/check-line-alignment": "warn",
+		"jsdoc/require-param": "warn",
+		"jsdoc/require-param-description": "warn",
+		"jsdoc/require-param-type": "warn",
+		"jsdoc/require-returns": "warn",
+		"no-alert": "warn",
+		"no-console": "warn",
+		"no-multi-str": "warn",
+		"no-shadow": "warn",
+		"no-unused-vars": "warn",
+		"no-var": "warn",
+		"object-shorthand": "warn",
+		"prettier/prettier": "off"
+	},
+	"ignorePatterns": [
+		"dist/",
+		"lib/",
+		"node_modules/"
+	]
 }

.github/workflows/code-quality.yml

@@ -0,0 +1,74 @@
+name: Code Quality
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+concurrency:
+  group: code-quality-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  eslint:
+    name: ESLint and build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint:js
+
+      - name: Build assets
+        run: npm run build
+
+  phpcs:
+    name: PHPCS and PHPStan
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "8.2"
+          tools: composer:v2
+          coverage: none
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v5
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run PHPCS
+        run: composer phpcs
+
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyse --error-format=github --memory-limit=1G

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+vendor
 .DS_Store
 simple-comment-editing\.zip
 simple-comment-editing

composer.json

@@ -2,19 +2,42 @@
     "name": "ronalfy/simple-comment-editing",
     "description": "Allow users to edit comments for a period of time.",
     "type": "project",
-    "license": "GPL",
+    "license": "GPL-2.0-or-later",
     "authors": [
         {
             "name": "Ronald Huereca"
         }
     ],
     "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require-dev": {
+        "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
+        "php-stubs/woocommerce-stubs": "^3.0",
+        "php-stubs/wordpress-stubs": "^6.0",
+        "phpcompatibility/phpcompatibility-wp": "^2.1",
+        "phpstan/phpstan": "^2.0",
+        "squizlabs/php_codesniffer": "^3.7",
+        "szepeviktor/phpstan-wordpress": "^2.0",
+        "wp-coding-standards/wpcs": "^3.0"
+    },
     "config": {
-        "vendor-dir": "lib"
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        },
+        "sort-packages": true
     },
-      "autoload": {
+    "autoload": {
         "psr-4": {
             "DLXPlugins\\CommentEditLite\\": "includes/"
         }
+    },
+    "scripts": {
+        "phpcs": "vendor/bin/phpcs",
+        "phpcbf": "vendor/bin/phpcbf",
+        "phpstan": "php -d memory_limit=1G vendor/bin/phpstan analyse --memory-limit=1G",
+        "lint": [
+            "@phpcs",
+            "@phpstan"
+        ]
     }
 }