build: added ESLint configuration

Author: thorsten

AGENTS.md

@@ -63,7 +63,7 @@ It is built using HTML5, CSS, TypeScript, and PHP and supports various databases
 
 ## Coding Standards
 
-- Use PSR-12 coding standards for PHP code.
+- Use PER Coding Style 3.0 for PHP code.
 - Use TypeScript coding standards for TypeScript code.
 - Use HTML5 and CSS3 standards for frontend code.
 - Use semicolons at the end of each statement.

CHANGELOG.md

@@ -25,6 +25,7 @@ This is a log of major user-visible changes in each phpMyFAQ release.
 - added support for .env files (Thorsten)
 - added support for OpenSearch (Thorsten)
 - added support for Mago (Thorsten)
+- added ESLint configuration (Thorsten)
 - added experimental support for FrankenPHP (Thorsten)
 - added experimental support for LDAP group support (Thorsten)
 - added experimental MCP Server (Thorsten)

docs/development.md

@@ -300,7 +300,8 @@ To run the Jest-based tests, you can use the following command:
 
 The following coding standards are used in phpMyFAQ:
 
-- PHP: [PER Coding Style 2.0](https://www.php-fig.org/per/coding-style/)
+- PHP: [PER Coding Style 3.0](https://www.php-fig.org/per/coding-style/)
+- TypeScript with ESLint recommendations
 
 ### 8.5.8 Rebase your Patch
 

eslint.config.mjs

@@ -0,0 +1,21 @@
+// @ts-check
+import eslint from '@eslint/js';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import tseslint from 'typescript-eslint';
+
+const ignoresConfig = globalIgnores([
+  'babel.config.cjs',
+  'commitlint.config.cjs',
+  'coverage/*',
+  'html-coverage/*',
+  'node_modules/*',
+  'phpmyfaq/assets/public/*',
+  'phpmyfaq/src/libs/*',
+  'volumes/*',
+]);
+
+export default defineConfig([
+  {
+    extends: [ignoresConfig, eslint.configs.recommended, tseslint.configs.recommended],
+  },
+]);

package.json

@@ -22,6 +22,7 @@
     "build": "vite build",
     "build:watch": "vite build --watch",
     "build:prod": "vite build",
+    "eslint": "eslint .",
     "lint": "prettier --check .",
     "lint:fix": "prettier --write .",
     "prepare": "husky",
@@ -51,6 +52,7 @@
     "@babel/preset-env": "^7.28.5",
     "@commitlint/cli": "^20.2.0",
     "@commitlint/config-conventional": "^20.2.0",
+    "@eslint/js": "^9.39.2",
     "@types/bootstrap": "^5.2.10",
     "@types/highlightjs": "^9.12.6",
     "@types/jsdom": "^27.0.0",
@@ -60,6 +62,7 @@
     "@vitest/coverage-istanbul": "4.0.16",
     "@vitest/coverage-v8": "4.0.16",
     "autoprefixer": "^10.4.23",
+    "eslint": "^9.39.2",
     "husky": "^9.1.7",
     "jsdom": "^27.3.0",
     "postcss": "^8.5.6",
@@ -68,6 +71,7 @@
     "sass": "^1.97.1",
     "sigmund": "^1.0.1",
     "typescript": "^5.9.3",
+    "typescript-eslint": "^8.50.0",
     "vite": "^7.3.0",
     "vite-plugin-compression": "^0.5.1",
     "vite-plugin-html": "^3.2.2",

phpmyfaq/admin/assets/js/configuration.js

@@ -17,6 +17,8 @@
  * @since     2022-02-19
  */
 
+/* global window, document, fetch, performance */
+
 /**
  * Generates a UUID Version 4 compatible universally unique identifier.
  * @returns {string} The generated UUID.
@@ -29,7 +31,7 @@ const generateUUID = () => {
   }
 
   return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, (char) => {
-    const random = (date + Math.random() * 16) % 16 | 0;
+    const random = ((date + Math.random() * 16) % 16) | 0;
     date = Math.floor(date / 16);
     return (char === 'x' ? random : (random & 0x3) | 0x8).toString(16);
   });
@@ -38,7 +40,7 @@ const generateUUID = () => {
 /**
  * Sends a test email to the admin.
  */
-const handleSendTestMail = async () => {
+export const handleSendTestMail = async () => {
   const button = document.getElementById('btn-phpmyfaq-mail-sendTestEmail');
   if (button) {
     const csrf = document.querySelector('#pmf-csrf-token').value;
@@ -54,7 +56,9 @@ const handleSendTestMail = async () => {
       });
 
       if (!response.ok) {
-        throw new Error('Network response was not ok');
+        const result = await response.json();
+        displayResult(button, '👎 ' + (result.error || 'Network response was not ok'));
+        return;
       }
 
       const result = await response.json();
@@ -79,7 +83,7 @@ const displayResult = (button, message) => {
 /**
  * Generates an API token if the input field is empty.
  */
-const generateApiToken = () => {
+export const generateApiToken = () => {
   const buttonGenerateApiToken = document.getElementById('pmf-generate-api-token');
   const inputConfigurationApiToken = document.getElementById('edit[api.apiClientToken]');
 

phpmyfaq/admin/assets/src/api/attachment.ts

@@ -16,49 +16,37 @@
 import { Response } from '../interfaces';
 
 export const deleteAttachments = async (attachmentId: string, csrfToken: string): Promise<Response> => {
-  try {
-    const response = await fetch('./api/content/attachments', {
-      method: 'DELETE',
-      headers: {
-        Accept: 'application/json, text/plain, */*',
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({ attId: attachmentId, csrf: csrfToken }),
-    });
+  const response = await fetch('./api/content/attachments', {
+    method: 'DELETE',
+    headers: {
+      Accept: 'application/json, text/plain, */*',
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ attId: attachmentId, csrf: csrfToken }),
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };
 
 export const refreshAttachments = async (attachmentId: string, csrfToken: string): Promise<Response> => {
-  try {
-    const response = await fetch('./api/content/attachments/refresh', {
-      method: 'POST',
-      headers: {
-        Accept: 'application/json, text/plain, */*',
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({ attId: attachmentId, csrf: csrfToken }),
-    });
+  const response = await fetch('./api/content/attachments/refresh', {
+    method: 'POST',
+    headers: {
+      Accept: 'application/json, text/plain, */*',
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({ attId: attachmentId, csrf: csrfToken }),
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };
 
 export const uploadAttachments = async (formData: FormData): Promise<Response> => {
-  try {
-    const response = await fetch('./api/content/attachments/upload', {
-      method: 'POST',
-      cache: 'no-cache',
-      body: formData,
-    });
+  const response = await fetch('./api/content/attachments/upload', {
+    method: 'POST',
+    cache: 'no-cache',
+    body: formData,
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };

phpmyfaq/admin/assets/src/api/category.ts

@@ -15,73 +15,61 @@
 import { CategoryTranslations, Response } from '../interfaces';
 
 export const fetchCategoryTranslations = async (categoryId: string): Promise<CategoryTranslations> => {
-  try {
-    const response = await fetch(`./api/category/translations/${categoryId}`, {
-      method: 'GET',
-      cache: 'no-cache',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      redirect: 'follow',
-      referrerPolicy: 'no-referrer',
-    });
+  const response = await fetch(`./api/category/translations/${categoryId}`, {
+    method: 'GET',
+    cache: 'no-cache',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    redirect: 'follow',
+    referrerPolicy: 'no-referrer',
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };
 
 export const deleteCategory = async (
   categoryId: string,
   language: string,
   csrfToken: string
 ): Promise<Response | undefined> => {
-  try {
-    const response = await fetch(`./api/category/delete`, {
-      method: 'DELETE',
-      cache: 'no-cache',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({
-        categoryId: categoryId,
-        language: language,
-        csrfToken: csrfToken,
-      }),
-      redirect: 'follow',
-      referrerPolicy: 'no-referrer',
-    });
+  const response = await fetch(`./api/category/delete`, {
+    method: 'DELETE',
+    cache: 'no-cache',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({
+      categoryId: categoryId,
+      language: language,
+      csrfToken: csrfToken,
+    }),
+    redirect: 'follow',
+    referrerPolicy: 'no-referrer',
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };
 
 export const setCategoryTree = async (
-  categoryTree: any,
+  categoryTree: unknown,
   categoryId: string,
   csrfToken: string
 ): Promise<Response | undefined> => {
-  try {
-    const response = await fetch('./api/category/update-order', {
-      method: 'POST',
-      cache: 'no-cache',
-      headers: {
-        'Content-Type': 'application/json',
-      },
-      body: JSON.stringify({
-        categoryTree: categoryTree,
-        categoryId: categoryId,
-        csrfToken: csrfToken,
-      }),
-      redirect: 'follow',
-      referrerPolicy: 'no-referrer',
-    });
+  const response = await fetch('./api/category/update-order', {
+    method: 'POST',
+    cache: 'no-cache',
+    headers: {
+      'Content-Type': 'application/json',
+    },
+    body: JSON.stringify({
+      categoryTree: categoryTree,
+      categoryId: categoryId,
+      csrfToken: csrfToken,
+    }),
+    redirect: 'follow',
+    referrerPolicy: 'no-referrer',
+  });
 
-    return await response.json();
-  } catch (error) {
-    throw error;
-  }
+  return await response.json();
 };