ci: Please pre-commit hooks

.gitignore

@@ -160,4 +160,4 @@ cython_debug/
 node_modules/
 
 # Mac stuff
-.DS_Store
+.DS_Store

.pre-commit-config.yaml

@@ -43,13 +43,15 @@ repos:
     rev: 6.3.0
     hooks:
       - id: pydocstyle
-        exclude: '^tests/'
+        exclude: "^tests/"
         additional_dependencies:
           - pydocstyle[toml]
   - repo: https://github.com/pre-commit/mirrors-mypy
     rev: v1.8.0
     hooks:
       - id: mypy
+        additional_dependencies:
+          - types-pyyaml==6.0.11
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.4
     hooks:
@@ -62,7 +64,7 @@ repos:
           - --license-filepath
           - LICENSES/.license_header.txt
           - --comment-style
-          - '#'
+          - "#"
       - id: insert-license
         name: Insert license headers (XML-style comments)
         files: '\.(?:html|md|xml)$'
@@ -72,7 +74,7 @@ repos:
           - --license-filepath
           - LICENSES/.license_header.txt
           - --comment-style
-          - '<!--| ~| -->'
+          - "<!--| ~| -->"
       - id: insert-license
         name: Insert license headers (C-style comments)
         files: '\.(?:css|js|ts)$'
@@ -82,7 +84,7 @@ repos:
           - --license-filepath
           - LICENSES/.license_header.txt
           - --comment-style
-          - '/*| *| */'
+          - "/*| *| */"
       - id: insert-license
         name: Insert license headers (reST comments)
         files: '\.rst$'
@@ -92,7 +94,17 @@ repos:
           - --license-filepath
           - LICENSES/.license_header.txt
           - --comment-style
-          - '..|  |'
+          - "..|  |"
+      - id: insert-license
+        name: Insert license headers (shell-style comments)
+        files: '(?:^|/)(?:.*\.(?:jsx)|Dockerfile|Makefile)$'
+        exclude: '(?:^|/)\..+|^docs/Makefile$'
+        args:
+          - --detect-license-in-X-top-lines=15
+          - --license-filepath
+          - LICENSES/.license_header.txt
+          - --comment-style
+          - "//"
   - repo: https://github.com/fsfe/reuse-tool
     rev: v3.0.1
     hooks:

Dockerfile

@@ -1,3 +1,9 @@
+// Copyright DB InfraGO AG and contributors
+// SPDX-License-Identifier: Apache-2.0
+
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
 # Build frontend
 FROM node:20 as build-frontend
 WORKDIR /app
@@ -34,4 +40,4 @@ COPY --from=build-frontend /app/dist/ ./frontend/dist/
 EXPOSE 8000
 
 # Start the application
-CMD ["python", "-m", "capella_model_explorer.backend", "/model", "/views"]
+CMD ["python", "-m", "capella_model_explorer.backend", "/model", "/views"]

README.md

@@ -8,7 +8,7 @@
 ![image](https://github.com/DSD-DBS/capella-model-explorer/actions/workflows/build-test-publish.yml/badge.svg)
 ![image](https://github.com/DSD-DBS/capella-model-explorer/actions/workflows/lint.yml/badge.svg)
 
-A webapp for exploring Capella models through simple "auto-generated" textual and graphical views. 
+A webapp for exploring Capella models through simple "auto-generated" textual and graphical views.
 
 **Longer story**:
 

capella_model_explorer/backend/__init__.py

@@ -0,0 +1,2 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0

capella_model_explorer/backend/explorer.py

@@ -41,7 +41,9 @@ def __post_init__(self):
             allow_headers=["*"],
         )
         self.env = Environment()
-        self.grouped_templates, self.templates = index_templates(self.templates_path)
+        self.grouped_templates, self.templates = index_templates(
+            self.templates_path
+        )
         self.app.state.templates = templates = Jinja2Templates(
             directory=PATH_TO_FRONTEND
         )
@@ -59,7 +61,9 @@ def configure_routes(self):
         @self.app.get("/api/views")
         def read_templates():
             # list all templates in the templates folder from .yaml
-            self.grouped_templates, self.templates = index_templates(self.templates_path)
+            self.grouped_templates, self.templates = index_templates(
+                self.templates_path
+            )
             return self.grouped_templates
 
         @self.app.get("/api/objects/{uuid}")
@@ -100,20 +104,28 @@ def render_template(template_name: str, object_id: str):
                     encoding="utf8"
                 )
             except Exception as e:
-                error_message = f"<p style='color:red'>Template not found: {str(e)}</p>"
+                error_message = (
+                    f"<p style='color:red'>Template not found: {str(e)}</p>"
+                )
                 return HTMLResponse(content=error_message)
             try:
                 object = self.model.by_uuid(object_id)
             except Exception as e:
-                error_message = f"<p style='color:red'>Requested object not found: {str(e)}</p>"
+                error_message = (
+                    "<p style='color:red'>Requested object "
+                    f"not found: {str(e)}</p>"
+                )
                 return HTMLResponse(content=error_message)
             try:
                 # render the template with the object
                 template = self.env.from_string(content)
                 rendered = template.render(object=object)
                 return HTMLResponse(content=rendered, status_code=200)
             except TemplateSyntaxError as e:
-                error_message = f"<p style='color:red'>Template syntax error: {e.message}, line {e.lineno}</p>"
+                error_message = (
+                    "<p style='color:red'>Template syntax error: "
+                    f"{e.message}, line {e.lineno}</p>"
+                )
                 return HTMLResponse(content=error_message)
             except Exception as e:
                 error_message = (
@@ -130,7 +142,7 @@ def model_info():
                 hash=info.rev_hash,
                 capella_version=info.capella_version,
                 branch=info.branch,
-                badge=self.model.description_badge
+                badge=self.model.description_badge,
             )
 
         @self.app.get("/{rest_of_path:path}")
@@ -140,7 +152,9 @@ async def catch_all(request: Request, rest_of_path: str):
             )
 
 
-def index_templates(path: pathlib.Path) -> dict[str, t.Any]:
+def index_templates(
+    path: pathlib.Path,
+) -> tuple[dict[str, t.Any], dict[str, t.Any]]:
     templates_grouped: dict[str, t.Any] = {"other": []}
     templates: dict[str, t.Any] = {}
     for template_file in path.glob("*.yaml"):

frontend/.eslintrc.cjs

@@ -1,3 +1,6 @@
+// Copyright DB InfraGO AG and contributors
+// SPDX-License-Identifier: Apache-2.0
+
 module.exports = {
   root: true,
   env: { browser: true, es2020: true },

frontend/.gitignore

@@ -1,3 +1,6 @@
+# Copyright DB InfraGO AG and contributors
+# SPDX-License-Identifier: Apache-2.0
+
 # Logs
 logs
 *.log
@@ -22,3 +25,6 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+
+# Package
+package-lock.json

frontend/.storybook/main.js

@@ -1,3 +1,6 @@
+// Copyright DB InfraGO AG and contributors
+// SPDX-License-Identifier: Apache-2.0
+
 /** @type { import('@storybook/react-vite').StorybookConfig } */
 const config = {
   stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],

frontend/.storybook/preview.js

@@ -1,3 +1,6 @@
+// Copyright DB InfraGO AG and contributors
+// SPDX-License-Identifier: Apache-2.0
+
 import '../src/index.css'
 
 /** @type { import('@storybook/react').Preview } */

frontend/README.md

@@ -1,3 +1,8 @@
+<!--
+ ~ Copyright DB InfraGO AG and contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
 # React + Vite
 
 This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

frontend/index.html

@@ -1,3 +1,8 @@
+<!--
+ ~ Copyright DB InfraGO AG and contributors
+ ~ SPDX-License-Identifier: Apache-2.0
+ -->
+
 <!doctype html>
 <html lang="en">
   <head>