Merge branch 'master' into ip-version

Author: lucasnz

.devcontainer/README.md

@@ -6,7 +6,7 @@ You can modifiy Uptime Kuma in your browser without setting up a local developme
 
 1. Click `Code` -> `Create codespace on master`
 2. Wait a few minutes until you see there are two exposed ports
-3. Go to the `3000` url, see if it is working 
+3. Go to the `3000` url, see if it is working
 
 ![image](https://github.com/louislam/uptime-kuma/assets/1336778/909b2eb4-4c5e-44e4-ac26-6d20ed856e7f)
 

.devcontainer/devcontainer.json

@@ -13,9 +13,10 @@
     "customizations": {
         "vscode": {
             "extensions": [
-                "streetsidesoftware.code-spell-checker",
-                "dbaeumer.vscode-eslint"
-            ]
+				"streetsidesoftware.code-spell-checker",
+				"dbaeumer.vscode-eslint",
+				"GitHub.copilot-chat"
+			]
         }
     },
     "forwardPorts": [3000, 3001]

.dockerignore

@@ -1,6 +1,6 @@
 /.idea
 /node_modules
-/data
+/data*
 /cypress
 /out
 /test

.eslintrc.js

@@ -1,6 +1,7 @@
 module.exports = {
     ignorePatterns: [
-        "test/*",
+        "test/*.js",
+        "test/cypress",
         "server/modules/apicache/*",
         "src/util.js"
     ],
@@ -14,13 +15,17 @@ module.exports = {
     extends: [
         "eslint:recommended",
         "plugin:vue/vue3-recommended",
+        "plugin:jsdoc/recommended-error",
     ],
     parser: "vue-eslint-parser",
     parserOptions: {
         parser: "@babel/eslint-parser",
         sourceType: "module",
         requireConfigFile: false,
     },
+    plugins: [
+        "jsdoc"
+    ],
     rules: {
         "yoda": "error",
         eqeqeq: [ "warn", "smart" ],
@@ -71,7 +76,7 @@ module.exports = {
         "no-var": "error",
         "key-spacing": "warn",
         "keyword-spacing": "warn",
-        "space-infix-ops": "warn",
+        "space-infix-ops": "error",
         "arrow-spacing": "warn",
         "no-trailing-spaces": "error",
         "no-constant-condition": [ "error", {
@@ -97,7 +102,43 @@ module.exports = {
         }],
         "no-control-regex": "off",
         "one-var": [ "error", "never" ],
-        "max-statements-per-line": [ "error", { "max": 1 }]
+        "max-statements-per-line": [ "error", { "max": 1 }],
+        "jsdoc/check-tag-names": [
+            "error",
+            {
+                "definedTags": [ "link" ]
+            }
+        ],
+        "jsdoc/no-undefined-types": "off",
+        "jsdoc/no-defaults": [
+            "error",
+            { "noOptionalParamNames": true }
+        ],
+        "jsdoc/require-throws": "warn",
+        "jsdoc/require-jsdoc": [
+            "error",
+            {
+                "require": {
+                    "FunctionDeclaration": true,
+                    "MethodDefinition": true,
+                }
+            }
+        ],
+        "jsdoc/no-blank-block-descriptions": "error",
+        "jsdoc/require-returns-description": "warn",
+        "jsdoc/require-returns-check": [
+            "error",
+            { "reportMissingReturnForUndefinedTypes": false }
+        ],
+        "jsdoc/require-returns": [
+            "warn",
+            {
+                "forceRequireReturn": true,
+                "forceReturnsWithAsync": true
+            }
+        ],
+        "jsdoc/require-param-type": "warn",
+        "jsdoc/require-param-description": "warn"
     },
     "overrides": [
         {

.github/ISSUE_TEMPLATE/security.md

@@ -12,8 +12,6 @@ labels:
 
 DO NOT PROVIDE ANY DETAILS HERE. Please privately report to https://github.com/louislam/uptime-kuma/security/advisories/new.
 
-
 Why need this issue? It is because GitHub Advisory do not send a notification to @louislam, it is a workaround to do so.
 
 Your GitHub Advisory URL:
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 ⚠️⚠️⚠️ Since we do not accept all types of pull requests and do not want to waste your time. Please be sure that you have read pull request rules:
 https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md#can-i-create-a-pull-request-for-uptime-kuma
 
-Tick the checkbox if you understand [x]: 
+Tick the checkbox if you understand [x]:
 - [ ] I have read and understand the pull request rules.
 
 # Description

.github/workflows/auto-test.yml

@@ -22,7 +22,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, ubuntu-latest, windows-latest, ARM64]
-        node: [ 14, 20 ]
+        node: [ 14, 20.5 ]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
@@ -71,27 +71,28 @@ jobs:
     - run: git config --global core.autocrlf false  # Mainly for Windows
     - uses: actions/checkout@v3
 
-    - name: Use Node.js 14
+    - name: Use Node.js 20
       uses: actions/setup-node@v3
       with:
-        node-version: 14
+        node-version: 20
     - run: npm install
     - run: npm run lint
 
-  e2e-tests:
-    needs: [ check-linters ]
-    runs-on: ubuntu-latest
-    steps:
-    - run: git config --global core.autocrlf false  # Mainly for Windows
-    - uses: actions/checkout@v3
-
-    - name: Use Node.js 14
-      uses: actions/setup-node@v3
-      with:
-        node-version: 14
-    - run: npm install
-    - run: npm run build
-    - run: npm run cy:test
+# TODO: Temporarily disable, as it cannot pass the test in 2.0.0 yet
+#  e2e-tests:
+#    needs: [ check-linters ]
+#    runs-on: ubuntu-latest
+#    steps:
+#    - run: git config --global core.autocrlf false  # Mainly for Windows
+#    - uses: actions/checkout@v3
+#
+#    - name: Use Node.js 14
+#      uses: actions/setup-node@v3
+#      with:
+#        node-version: 14
+#    - run: npm install
+#    - run: npm run build
+#    - run: npm run cy:test
 
   frontend-unit-tests:
     needs: [ check-linters ]

.github/workflows/prevent-file-change.yml

@@ -0,0 +1,17 @@
+name: prevent-file-change
+
+on:
+  pull_request:
+
+jobs:
+  check-file-changes:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Prevent file change
+        uses: xalvarez/prevent-file-change-action@v1
+        with:
+          githubToken: ${{ secrets.GITHUB_TOKEN }}
+          # Regex, /src/lang/*.json is not allowed to be changed, except for /src/lang/en.json
+          pattern: '^(?!src/lang/en\.json$)src/lang/.*\.json$'
+          trustedAuthors: UptimeKumaBot
+

.gitignore

@@ -7,6 +7,7 @@ dist-ssr
 
 /data
 !/data/.gitkeep
+/data*
 .vscode
 
 /private