docs: mention dev env setup

darklab8 · Mar 24, 2024 · 4beac63 · 4beac63
1 parent 741686e
commit 4beac63
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ go.work*
 web/static/export/*
 *_templ*
 build/
-id_rsa*
+id_rsa*
+cover.out
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,14 @@
+{
+    "go.testFlags": [
+        "-v"
+    ],
+    "go.testEnvVars": {
+        "FLDARKSTAT_FREELANCER_FOLDER": "/home/naa/windows10shared/Discovery/DiscoveryFreelancer",
+        "DARKSTAT_LOG_LEVEL": "DEBUG",
+    },
+    "editor.formatOnSave": true,
+    "terminal.integrated.env.linux": {
+        "FLDARKSTAT_FREELANCER_FOLDER": "/home/naa/windows10shared/Discovery/DiscoveryFreelancer",
+        "DARKSTAT_LOG_LEVEL": "DEBUG",
+    }
+}
diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
 # Description
 
 flstat on online-web version to browse game data for game Freelancer.
+
+# dev env setup
+
+- check [env environment to set](.vscode/settings.json)
+- check [commands to run](Taskfile.yml)
+
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -3,11 +3,20 @@ version: '3'
 tasks:
   test:
     cmds:
-      - go test ./... {{.CLI_ARGS}}
+      - go test ./... -coverprofile=cover.out {{.CLI_ARGS}}
     vars:
       PWD:
         sh: echo '$(pwd)'
 
+  test:cover:
+    cmds:
+      - go tool cover -html=cover.out
+
+  test:cover:total:
+    cmds:
+      - task: test
+      - go tool cover -func cover.out
+
   build:
     cmds:
       - templ generate