Refactor automaton + refactor file loading + add example projects + add recent projects

.eslintignore

@@ -1,5 +1,6 @@
 .DS_Store
 node_modules
+/Ecdar-Common
 /build
 /.svelte-kit
 /package

.eslintrc.cjs

@@ -28,4 +28,12 @@ module.exports = {
       },
     },
   ],
+  rules: {
+    // TODO: Enable this rule in the future. Production code should not output to console.
+    //"no-console": "error",
+    "@typescript-eslint/no-invalid-void-type": [
+      "error",
+      { allowAsThisParameter: true },
+    ],
+  },
 };

.github/workflows/lint.yml

@@ -22,6 +22,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: true
 
       - name: Set up Node ${{ matrix.node-version }}
         uses: actions/setup-node@v3
@@ -32,5 +34,8 @@ jobs:
       - name: Install dependencies
         run: yarn install
 
+      - name: Build site
+        run: yarn build
+
       - name: Run lint
         run: yarn lint

.github/workflows/test.yml

@@ -22,6 +22,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          submodules: true
 
       - name: Set up Node ${{ matrix.node-version }}
         uses: actions/setup-node@v3

.gitignore

@@ -20,6 +20,9 @@ yarn-error.log
 vite.config.js.timestamp-*
 vite.config.ts.timestamp-*
 
+#### Project examples ###
+/src/lib/projectExamples.ts
+/src/lib/projectExamples
 
 ### macOS ###
 *.DS_Store

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Ecdar-Common"]
+	path = Ecdar-Common
+	url = https://github.com/ECDAR-AAU-SW-P5/Ecdar-Common.git

.prettierignore

@@ -1,5 +1,6 @@
 .DS_Store
 node_modules
+/Ecdar-Common
 /build
 /.svelte-kit
 /package

bundleProjectExamples.ts

@@ -0,0 +1,81 @@
+import fs from "fs-extra";
+import path from "node:path";
+import { resolveConfig, format } from "prettier";
+import type { RawProject } from "./src/lib/classes/automaton/raw/RawProject";
+import { DirectoryHandleNodejs } from "./src/lib/classes/fileSystem/FileSystemNodejs";
+import { FileStructureProject } from "./src/lib/classes/projectHandler/FileStructure";
+import { serializeRaw } from "./src/lib/classes/projectHandler/zodSerializers";
+
+const sourcePath = "./Ecdar-Common/Project-Examples/examples/";
+const bundlePath = "./src/lib/projectExamples";
+
+export const bundleProjectExamples = {
+	name: "Bundle project examples",
+	async buildStart() {
+		try {
+			await fs.emptyDir(bundlePath);
+			await fs.remove(`${bundlePath}.ts`);
+		} catch (error) {
+			throw new Error(
+				`Could not remove old project example bundle: ${
+					(error as Error).message
+				}`,
+			);
+		}
+		const projects: RawProject[] = [];
+		try {
+			const projectNames = await fs.readdir(sourcePath);
+			await Promise.all(
+				projectNames.map(async (name) => {
+					const directoryHandle = new DirectoryHandleNodejs(
+						name,
+						path.join(sourcePath, name),
+					);
+					const project = await new FileStructureProject().toRaw(
+						directoryHandle,
+					);
+					project.name = name;
+					projects.push(project);
+				}),
+			);
+		} catch (error) {
+			throw new Error(
+				`Could not load project examples: ${(error as Error).message}`,
+			);
+		}
+
+		try {
+			projects.sort((a, b): number =>
+				(a.name ?? "").localeCompare(b.name ?? "", "en"),
+			);
+			for (const project of projects) {
+				const filepath = path.join(bundlePath, `${project.name}.ts`);
+				const projectCode = `export default ${serializeRaw(project)}`;
+				await fs.writeFile(filepath, projectCode);
+			}
+
+			let projectsCode = `export const projectExamples = {`;
+			for (const project of projects) {
+				projectsCode += `"${project.name}": async () => {return (await import("./projectExamples/${project.name}")).default},`;
+			}
+			projectsCode += `}`;
+			const filepath = `${bundlePath}.ts`;
+			const prettierConfig = await resolveConfig(filepath, {
+				editorconfig: true,
+			});
+			projectsCode = await format(projectsCode, {
+				filepath,
+				...prettierConfig,
+			});
+
+			await fs.writeFile(filepath, projectsCode);
+		} catch (error) {
+			throw new Error(
+				`Writing project example bundle to lib: ${
+					(error as Error).message
+				}`,
+			);
+		}
+		console.log("✔ bundled project examples");
+	},
+};