Add tests and refactor todoService

joeriddles · Apr 3, 2024 · c453c50 · c453c50
1 parent 3c500cd
commit c453c50
Show file tree

Hide file tree

Showing 13 changed files with 4,809 additions and 1,104 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,23 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+
+      - name: Build plugin
+        run: |
+          npm run test
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,9 @@
 # npm
 node_modules
 
+# jest
+coverage
+
 # Don't include the compiled main.js file in the repo.
 # They should be uploaded to GitHub releases instead.
 main.js

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,18 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug Jest Tests",
+      "type": "node",
+      "request": "launch",
+      "runtimeArgs": [
+        "--inspect-brk",
+        "${workspaceRoot}/node_modules/.bin/jest",
+        "--runInBand",
+        "--verbose"
+      ],
+      "console": "internalConsole",
+      "internalConsoleOptions": "neverOpen"
+    }
+  ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,8 +6,5 @@
       "source.fixAll": "explicit"
     },
   },
-  "eslint.codeActionsOnSave.mode": "problems",
-  "cSpell.words": [
-    "todos"
-  ]
+  "eslint.codeActionsOnSave.mode": "problems"
 }
diff --git a/jest.config.ts b/jest.config.ts
@@ -0,0 +1,16 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+import type { Config } from 'jest';
+
+const config: Config = {
+  preset: "ts-jest/presets/js-with-ts",
+  clearMocks: true,
+  collectCoverage: true,
+  coverageDirectory: "coverage",
+  coverageProvider: "v8",
+};
+
+export default config;
diff --git a/main.ts b/main.ts
@@ -1,6 +1,7 @@
 import { Plugin, TFile, Vault } from 'obsidian';
-import { DEFAULT_SETTINGS, ExtendedTaskListsSettingTab, ExtendedTaskListsSettings } from 'settings';
-import TodoService, { Todo } from './todoService';
+import { IFile, VaultFileService } from 'src/fileService';
+import { DEFAULT_SETTINGS, ExtendedTaskListsSettingTab, ExtendedTaskListsSettings } from 'src/settings';
+import TodoService, { Todo } from 'src/todoService';
 
 export default class ExtendedTaskListsPlugin extends Plugin {
 	settings: ExtendedTaskListsSettings
@@ -76,13 +77,18 @@ export default class ExtendedTaskListsPlugin extends Plugin {
 
 	updateTodo = async () => {
 		const vault = this.app.vault
-		const service = new TodoService(vault, this.settings)
+		const fileService = new VaultFileService(vault)
+		const service = new TodoService(fileService, this.settings)
 		const todoFiles = await service.findTodosFiles()
 		const todos: Todo[] = todoFiles
-			.map(todoFile => service.parseTodos(todoFile))
+			.map(todoFile => {
+				const todos = service.parseTodos(todoFile.contents)
+				todos.forEach(todo => todo.file = todoFile.file)
+				return todos
+			})
 			.reduce((prev, cur) => prev.concat(cur), [])
 		const todoFile = await this.getOrCreateTodoFile(vault);
-		await service.saveTodos(todoFile, todos)
+		await service.saveTodos(todoFile as IFile, todos)
 	}
 
 	getOrCreateTodoFile = async (vault: Vault): Promise<TFile> => {