Merge pull request #397 from open-pv/396-code-cleaning

Code Cleaning and Linters
open-pv · Jan 13, 2025 · 1dd494f · 1dd494f
2 parents 81aee74 + eb590b1
commit 1dd494f
Show file tree

Hide file tree

Showing 59 changed files with 316,020 additions and 1,497 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm"
-    directory: "/" # Location of package manifest
+  - package-ecosystem: 'npm'
+    directory: '/' # Location of package manifest
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
diff --git a/.github/workflows/linting.yml b/.github/workflows/linting.yml
@@ -0,0 +1,30 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  run-linters:
+    if: github.event.pull_request.draft == false
+    name: Run linters
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install Prettier
+        run: npm install prettier
+
+      - name: Run linters
+        uses: wearerequired/lint-action@v2
+        with:
+          eslint: false
+          prettier: true
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -1,4 +1,6 @@
-# prettier config
-semi: false  # No semicolons
-singleQuote: false  # use single quotes in regular js files
-jsxSingleQuote: false  # use single quotes in jsx files
+semi: false
+singleQuote: true
+jsxSingleQuote: true
+endOfLine: 'lf'
+trailingComma: 'all'
+tabWidth: 2
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -3,11 +3,5 @@
     "editor.suggest.insertMode": "replace"
   },
   "editor.formatOnSave": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit",
-    "source.sortImports": "explicit"
-  },
-  "prettier.semi": false,
-  "prettier.jsxSingleQuote": false
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
 }
diff --git a/README.md b/README.md
@@ -1,11 +1,12 @@
 [![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.openpv.de%2F)](https://www.openpv.de/)
 
-
 # The OpenPV website
+
 This is the base repository for the website [openpv.de](https://www.openpv.de). The website is built using
-* [React](https://react.dev/)
-* [Chakra-UI](https://v2.chakra-ui.com)
-* [Three.js](https://threejs.org/)
+
+- [React](https://react.dev/)
+- [Chakra-UI](https://v2.chakra-ui.com)
+- [Three.js](https://threejs.org/)
 
 The whole site is **static**, reducing the hosting costs as much as possible. The shading simulation happens in the browser, using
 our npm package [simshady](https://github.com/open-pv/simshady).
@@ -16,24 +17,26 @@ If you want to deploy this website locally, you need to follow these steps:
 
 1. Clone the repository and enter it.
 2. Make sure that you have [node](https://nodejs.org/en) and the node package manager npm installed. Check this by running
-    ```
-    node --version
-    npm --version
-    ```
+   ```
+   node --version
+   npm --version
+   ```
 3. Install all required packages from `package.json` by running
-    ```shell
-    npm install
-    ```
+   ```shell
+   npm install
+   ```
 4. To build the code and host it in a development environment, run
-    ```shell
-    npm run dev
-    ```
-    and visit [localhost:5173](http://localhost:5173).
+   ```shell
+   npm run dev
+   ```
+   and visit [localhost:5173](http://localhost:5173).
 
 ## How does this work?
-We have a detailed description in german and english on our [About Page](https://www.openpv.de/about). 
+
+We have a detailed description in german and english on our [About Page](https://www.openpv.de/about). Also check out our [blog](https://blog.openpv.de).
 
 ## Funding
+
 We thank our sponsors.
 
 <a href="https://prototypefund.de/">

diff --git a/index.html b/index.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html itemscope="" itemtype="http://schema.org/WebPage" lang="en">
   <head>
     <meta http-equiv="content-type" content="text/html;charset=utf-8" />

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,7 +4,8 @@
     "build": "vite build",
     "preview": "vite preview",
     "deploy": "gh-pages -d dist -b build",
-    "deploy:test": "gh-pages -d dist -b gh-pages"
+    "deploy:test": "gh-pages -d dist -b gh-pages",
+    "format": "prettier --write ."
   },
   "dependencies": {
     "@chakra-ui/react": "^2.10.1",
@@ -17,7 +18,6 @@
     "i18next-http-backend": "^3.0.1",
     "jszip": "^3.10.1",
     "maplibre-gl": "^4.7.1",
-    "pako": "^2.1.0",
     "proj4": "^2.15.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -31,6 +31,7 @@
   "devDependencies": {
     "@vitejs/plugin-react": "^4.3.4",
     "gh-pages": "^6.2.0",
+    "prettier": "3.4.2",
     "vite": "^6.0.7"
   },
   "browserslist": {

diff --git a/public/draco/README.md b/public/draco/README.md
@@ -8,21 +8,21 @@ Draco is an open-source library for compressing and decompressing 3D geometric m
 
 This folder contains three utilities:
 
-* `draco_decoder.js` — Emscripten-compiled decoder, compatible with any modern browser.
-* `draco_decoder.wasm` — WebAssembly decoder, compatible with newer browsers and devices.
-* `draco_wasm_wrapper.js` — JavaScript wrapper for the WASM decoder.
+- `draco_decoder.js` — Emscripten-compiled decoder, compatible with any modern browser.
+- `draco_decoder.wasm` — WebAssembly decoder, compatible with newer browsers and devices.
+- `draco_wasm_wrapper.js` — JavaScript wrapper for the WASM decoder.
 
 Each file is provided in two variations:
 
-* **Default:** Latest stable builds, tracking the project's [master branch](https://github.com/google/draco).
-* **glTF:** Builds targeted by the [glTF mesh compression extension](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression), tracking the [corresponding Draco branch](https://github.com/google/draco/tree/gltf_2.0_draco_extension).
+- **Default:** Latest stable builds, tracking the project's [master branch](https://github.com/google/draco).
+- **glTF:** Builds targeted by the [glTF mesh compression extension](https://github.com/KhronosGroup/glTF/tree/master/extensions/2.0/Khronos/KHR_draco_mesh_compression), tracking the [corresponding Draco branch](https://github.com/google/draco/tree/gltf_2.0_draco_extension).
 
 Either variation may be used with `THREE.DRACOLoader`:
 
 ```js
-var dracoLoader = new THREE.DRACOLoader();
-dracoLoader.setDecoderPath('path/to/decoders/');
-dracoLoader.setDecoderConfig({type: 'js'}); // (Optional) Override detection of WASM support.
+var dracoLoader = new THREE.DRACOLoader()
+dracoLoader.setDecoderPath('path/to/decoders/')
+dracoLoader.setDecoderConfig({ type: 'js' }) // (Optional) Override detection of WASM support.
 ```
 
 Further [documentation on GitHub](https://github.com/google/draco/tree/master/javascript/example#static-loading-javascript-decoder).

diff --git a/public/draco/draco_decoder.js b/public/draco/draco_decoder.js
diff --git a/public/draco/draco_encoder.js b/public/draco/draco_encoder.js