chore: Add ci workflow to github actions (#1)

jespertheend · web-flow · commit 022692b1bdd3 · 2022-08-09T20:06:55.000+02:00
diff --git a/.editorconfig b/.editorconfig
@@ -6,3 +6,7 @@ indent_style = tab
 insert_final_newline = true
 charset = utf-8
 trim_trailing_whitespace = true
+
+[*.yml]
+indent_size = 2
+indent_style = space
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,8 @@
 dist
 editor/dist/js/*
-editor/libs/
+editor/deps/
 *.ts
+.coverage
+.denoTypes
+node_modules
+npm_packages
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,46 @@
+# This workflow will install Deno then run Deno lint and test.
+
+name: ci
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup repo
+        uses: actions/checkout@v2
+
+      - name: Setup Deno
+        # For more information see: https://github.com/denoland/setup-deno
+        uses: denoland/setup-deno@v1.1.0
+        with:
+          deno-version: "1.24.1"
+
+      - name: npm install
+        run: npm install
+
+      - name: Setup Renda
+        # Sets up a development environment required for type the next steps to pass.
+        run: deno task dev --no-serve
+
+      - name: Install editor dependencies
+        run: deno task build-editor-dependencies
+
+      - name: Type check
+        run: deno task check
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Install puppeteer
+        run: PUPPETEER_PRODUCT=chrome deno run -A --unstable https://deno.land/x/puppeteer@14.1.1/install.ts
+
+      - name: Test
+        run: deno task test
+
diff --git a/editor/src/keyboardShortcuts/ShorcutConditionValueSetter.js b/editor/src/keyboardShortcuts/ShorcutConditionValueSetter.js
@@ -1,5 +1,3 @@
-import {ShortcutCondition} from "./ShortcutCondition.js";
-
 /**
  * A single valueSetter is used to control the value of ShortcutConditions.
  * This is to ensure multiple places in the code can control the value of a
@@ -8,7 +6,7 @@ import {ShortcutCondition} from "./ShortcutCondition.js";
  */
 export class ShorcutConditionValueSetter {
 	/**
-	 * @param {ShortcutCondition} condition
+	 * @param {import("./ShortcutCondition.js").ShortcutCondition} condition
 	 * @param {number} priority
 	 */
 	constructor(condition, priority = 0) {
diff --git a/editor/src/keyboardShortcuts/ShortcutCommand.js b/editor/src/keyboardShortcuts/ShortcutCommand.js
@@ -1,5 +1,3 @@
-import {KeyboardShortcutManager} from "./KeyboardShortcutManager.js";
-
 /**
  * - `single` Only fire command once.
  * - `hold` Activate when the key is down, and deactivate when it is up.
@@ -25,7 +23,7 @@ import {KeyboardShortcutManager} from "./KeyboardShortcutManager.js";
  */
 export class ShortcutCommand {
 	/**
-	 * @param {KeyboardShortcutManager} shortcutManager
+	 * @param {import("./KeyboardShortcutManager.js").KeyboardShortcutManager} shortcutManager
 	 * @param {ShortcutCommandOptions} opts
 	 */
 	constructor(shortcutManager, {
diff --git a/editor/src/propertiesWindowContent/EntityPropertiesWindowContent.js b/editor/src/propertiesWindowContent/EntityPropertiesWindowContent.js
@@ -235,11 +235,11 @@ export class EntityPropertiesWindowContent extends PropertiesWindowContent {
 	 * @param {any} object
 	 * @param {string | number} propertyName
 	 * @param {any} scriptValue
-	 * @param {import("../ui/PropertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<any>} guiEntry
+	 * @param {import("../ui/propertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<any>} guiEntry
 	 */
 	mapFromDroppableGuiValues(object, propertyName, scriptValue, guiEntry) {
 		if (Array.isArray(scriptValue)) {
-			const castGuiEntry = /** @type {import("../ui/PropertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<import("../ui/ArrayGui.js").ArrayGui<any>>} */ (guiEntry);
+			const castGuiEntry = /** @type {import("../ui/propertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<import("../ui/ArrayGui.js").ArrayGui<any>>} */ (guiEntry);
 			/** @type {unknown[]} */
 			const newScriptValue = [];
 			for (const [i, item] of scriptValue.entries()) {
diff --git a/editor/src/ui/TreeView.js b/editor/src/ui/TreeView.js
@@ -140,10 +140,10 @@ export class TreeView {
 	#textFieldVisible = false;
 	#lastTextFocusOutWasFromRow = false;
 	#lastTextFocusOutTime = 0;
-	/** @type {import("../KeyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>?} */
+	/** @type {import("../keyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>?} */
 	#renamingShortcutCondition = null;
 
-	/** @type {import("../KeyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>?} */
+	/** @type {import("../keyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>?} */
 	#focusSelectedShortcutCondition = null;
 
 	/**
@@ -276,10 +276,10 @@ export class TreeView {
 		const editor = getMaybeEditorInstance();
 		if (editor && editor.keyboardShortcutManager) {
 			const renamingCondition = editor.keyboardShortcutManager.getCondition("treeView.renaming");
-			this.#renamingShortcutCondition = /** @type {import("../KeyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>} */ (renamingCondition.requestValueSetter());
+			this.#renamingShortcutCondition = /** @type {import("../keyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>} */ (renamingCondition.requestValueSetter());
 
 			const focusSelectedCondition = editor.keyboardShortcutManager.getCondition("treeView.focusSelected");
-			this.#focusSelectedShortcutCondition = /** @type {import("../KeyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>} */ (focusSelectedCondition.requestValueSetter());
+			this.#focusSelectedShortcutCondition = /** @type {import("../keyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<boolean>} */ (focusSelectedCondition.requestValueSetter());
 		}
 
 		this.updateArrowHidden();
diff --git a/editor/src/windowManagement/contentWindows/BuiltInAssetsContentWindow.js b/editor/src/windowManagement/contentWindows/BuiltInAssetsContentWindow.js
@@ -1,6 +1,5 @@
 import {ContentWindow} from "./ContentWindow.js";
 import {TreeView} from "../../ui/TreeView.js";
-import {SelectionGroup} from "../../misc/SelectionGroup.js";
 
 export class BuiltInAssetsContentWindow extends ContentWindow {
 	static contentWindowTypeId = "builtInAssets";
@@ -28,7 +27,7 @@ export class BuiltInAssetsContentWindow extends ContentWindow {
 
 		this.contentEl.appendChild(this.treeView.el);
 
-		/** @type {SelectionGroup<import("../../assets/ProjectAsset.js").ProjectAssetAny>} */
+		/** @type {import("../../misc/SelectionGroup.js").SelectionGroup<import("../../assets/ProjectAsset.js").ProjectAssetAny>} */
 		this.selectionManager = this.editorInstance.selectionManager.createSelectionGroup();
 
 		this.init();
diff --git a/editor/src/windowManagement/contentWindows/ConnectionsContentWindow.js b/editor/src/windowManagement/contentWindows/ConnectionsContentWindow.js
@@ -5,7 +5,7 @@ import {ContentWindow} from "./ContentWindow.js";
 /**
  * @typedef {Object} ConectionGui
  * @property {PropertiesTreeView<any>} treeView
- * @property {import("../../ui/PropertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<import("../../ui/LabelGui.js").LabelGui>} statusLabel
+ * @property {import("../../ui/propertiesTreeView/PropertiesTreeViewEntry.js").PropertiesTreeViewEntry<import("../../ui/LabelGui.js").LabelGui>} statusLabel
  */
 
 export class ConnectionsContentWindow extends ContentWindow {
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
 	"type": "module",
 	"scripts": {
 		"lint": "eslint .",
-		"test": "playwright test"
+		"lint-fix": "npm run lint -- --fix"
 	},
 	"devDependencies": {
 		"@babel/eslint-parser": "^7.16.3",
diff --git a/scripts/dev.js b/scripts/dev.js
@@ -45,8 +45,10 @@ const buildProcess = Deno.run({
 });
 await buildProcess.status();
 
-const server = new DevServer({
-	port: 8080,
-	serverName: "development server",
-});
-server.start();
+if (!Deno.args.includes("--no-serve")) {
+	const server = new DevServer({
+		port: 8080,
+		serverName: "development server",
+	});
+	server.start();
+}
diff --git a/src/gizmos/draggables/GizmoDraggable.js b/src/gizmos/draggables/GizmoDraggable.js
@@ -65,7 +65,7 @@ export class GizmoDraggable {
 	}
 
 	/**
-	 * @param {import("../../Components/builtIn/CameraComponent.js").CameraComponent} camera
+	 * @param {import("../../components/builtIn/CameraComponent.js").CameraComponent} camera
 	 */
 	getScreenPos(camera) {
 		return camera.worldToScreenPos(this.entity.pos);
diff --git a/test/e2e/shared/browser.js b/test/e2e/shared/browser.js
@@ -35,7 +35,6 @@ export async function initBrowser() {
 		headless,
 		args: ["--enable-unsafe-webgpu"],
 		devtools,
-		executablePath: "/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary",
 	});
 }
 
diff --git a/test/unit/editor/shared/mockKeyboardShortcutManager.js b/test/unit/editor/shared/mockKeyboardShortcutManager.js
@@ -1,9 +1,9 @@
 export function createMockKeyboardShortcutManager() {
-	const keyboardShortcutManager = /** @type {import("../../../../editor/src/KeyboardShortcuts/KeyboardShortcutManager.js").KeyboardShortcutManager} */ ({
+	const keyboardShortcutManager = /** @type {import("../../../../editor/src/keyboardShortcuts/KeyboardShortcutManager.js").KeyboardShortcutManager} */ ({
 		getCondition(name) {
-			const mockCondition = /** @type {import("../../../../editor/src/KeyboardShortcuts/ShortcutCondition.js").ShortcutCondition} */ ({
+			const mockCondition = /** @type {import("../../../../editor/src/keyboardShortcuts/ShortcutCondition.js").ShortcutCondition} */ ({
 				requestValueSetter(priority) {
-					const mockValueSetter = /** @type {import("../../../../editor/src/KeyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<any>} */ ({
+					const mockValueSetter = /** @type {import("../../../../editor/src/keyboardShortcuts/ShorcutConditionValueSetter.js").ShorcutConditionValueSetter<any>} */ ({
 						setValue(value) {},
 					});
 					return mockValueSetter;
diff --git a/test/unit/editor/src/tasks/TaskManager.test.js b/test/unit/editor/src/tasks/TaskManager.test.js
@@ -98,7 +98,7 @@ Deno.test({
 Deno.test({
 	name: "running a task",
 	async fn() {
-		injectMockEditorInstance(/** @type {import("../../../../../editor/src/editor.js").Editor} */ ({}));
+		injectMockEditorInstance(/** @type {import("../../../../../editor/src/Editor.js").Editor} */ ({}));
 
 		try {
 			const manager = new TaskManager();
diff --git a/test/unit/editor/src/ui/NumericGui.test.js b/test/unit/editor/src/ui/NumericGui.test.js
@@ -1,5 +1,5 @@
 import {assertEquals} from "std/testing/asserts.ts";
-import {NumericGui} from "../../../../../editor/src/UI/NumericGui.js";
+import {NumericGui} from "../../../../../editor/src/ui/NumericGui.js";
 import {initializeDom} from "../../shared/initializeDom.js";
 
 Deno.test({

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ export class GizmoDraggable {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`68`		`- * @param {import("../../Components/builtIn/CameraComponent.js").CameraComponent} camera`
	`68`	`+ * @param {import("../../components/builtIn/CameraComponent.js").CameraComponent} camera`
`69`	`69`	`*/`
`70`	`70`	`getScreenPos(camera) {`
`71`	`71`	`return camera.worldToScreenPos(this.entity.pos);`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,6 @@ export async function initBrowser() {`
`35`	`35`	`headless,`
`36`	`36`	`args: ["--enable-unsafe-webgpu"],`
`37`	`37`	`devtools,`
`38`		`- executablePath: "/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary",`
`39`	`38`	`});`
`40`	`39`	`}`
`41`	`40`