♻️ Pull request comments

CONTRIBUTING.md

@@ -105,6 +105,9 @@ Homarr uses [GitMoji](https://gitmoji.dev/).
 We would appreciate it if everyone keeps their commit messages withing these rulings.
 
 ### Tests
+
+> Components should be tested using unit tests. A unit is the smallest isolated part of the component. Unit tests must not have any dependencies and must be isolated.
+
 - Place testfiles directly at the root of the unit
 - Only test a single unit of work inside a unit test
 - You may test multiple units inside one test file

next-i18next.config.js

@@ -1,6 +1,7 @@
 const path = require('path');
 
 module.exports = {
+  // https://www.i18next.com/overview/configuration-options#logging
   i18n: {
     defaultLocale: 'en',
     locales: [

next.config.js

@@ -10,5 +10,5 @@ module.exports = withBundleAnalyzer({
   },
   reactStrictMode: true,
   output: 'standalone',
-  i18n: i18n,
+  i18n,
 });

src/modules/Docker/ContainerActionBar.tsx

@@ -207,6 +207,9 @@ export default function ContainerActionBar({ selected, reload }: ContainerAction
   );
 }
 
+/**
+ * @deprecated legacy code
+ */
 function tryMatchType(imageName: string): ServiceType {
   const match = MatchingImages.find(({ image }) => imageName.includes(image));
   if (match) {
@@ -216,6 +219,11 @@ function tryMatchType(imageName: string): ServiceType {
   return 'Other';
 }
 
+/**
+ * @deprecated
+ * @param container the container to match
+ * @returns a new service
+ */
 const tryMatchService = (container: Dockerode.ContainerInfo | undefined) => {
   if (container === undefined) return {};
   const name = container.Names[0].substring(1);

src/tools/types.ts

@@ -1,4 +1,5 @@
 import { MantineTheme } from '@mantine/core';
+
 import { OptionValues } from '../modules/ModuleTypes';
 
 export interface Settings {
@@ -74,6 +75,12 @@ export type ServiceType =
   | 'Sabnzbd'
   | 'NZBGet';
 
+/**
+ * @deprecated
+ * @param name the name to match
+ * @param form the form
+ * @returns the port from the map
+ */
 export function tryMatchPort(name: string | undefined, form?: any) {
   if (!name) {
     return undefined;

vitest.config.ts

@@ -6,15 +6,15 @@ import { defineConfig } from 'vitest/config';
 export default defineConfig({
   plugins: [react()],
   test: {
-    environment: 'jsdom',
+    environment: 'happy-dom',
     coverage: {
       provider: 'c8',
       reporter: ['html'],
       all: true,
-      exclude: ['.next/', '.yarn/', 'data/']
+      exclude: ['.next/', '.yarn/', 'data/'],
     },
     setupFiles: [
-      "./setupVitest.ts"
-    ]
+      './tests/setupVitest.ts',
+    ],
   },
 });