From dd92d0faf4b2699af3f09b49a5bc730788a9c437 Mon Sep 17 00:00:00 2001
From: Alex Chen <pdckxd@gmail.com>
Date: Tue, 23 Nov 2021 08:28:59 +0800
Subject: [PATCH] [Build] Enhance windows build instruction and cargo make
 scripts

1. doc\BUILD_ON_WINDOWS.md
  - add command for building development version
2. .vscode\tasks.json
  - Enable vscode to launch debug session on windows
3. frontend\scripts\makefile\env.toml
  - Fix "Command : dart not found." on windows
4. frontend\Makefile.toml
  - Change profile name "env.development-windows" to "env.development-desktop-windows-x86"
---
 doc/BUILD_ON_WINDOWS.md                |  6 ++++--
 frontend/Makefile.toml                 |  2 +-
 frontend/app_flowy/.vscode/tasks.json  | 12 +++++++++++-
 frontend/scripts/build_sdk.cmd         |  3 +++
 frontend/scripts/makefile/desktop.toml | 12 ++++++++++++
 frontend/scripts/makefile/env.toml     |  3 ++-
 6 files changed, 33 insertions(+), 5 deletions(-)
 create mode 100644 frontend/scripts/build_sdk.cmd

diff --git a/doc/BUILD_ON_WINDOWS.md b/doc/BUILD_ON_WINDOWS.md
index 219adc76f7..b10a25bdbc 100644
--- a/doc/BUILD_ON_WINDOWS.md
+++ b/doc/BUILD_ON_WINDOWS.md
@@ -51,13 +51,15 @@ cargo make -p development-windows pb
 ```
 10. Build flowy-sdk (dart-ffi)
 ```shell
-# TODO: for development
+# for development
+cargo make --profile development-desktop-windows-x86 flowy-sdk-dev
 # for production
 cargo make --profile production-desktop-windows-x86 flowy-sdk-release
 ```
 11. Build app_flowy
 ```shell
-# TODO: for development
+# for development
+cargo make -p development-desktop-windows-x86 appflowy-windows-dev
 # for production
 cargo make -p production-desktop-windows-x86 appflowy-windows
 ```
diff --git a/frontend/Makefile.toml b/frontend/Makefile.toml
index 3b47fe42bb..b7b73101c7 100644
--- a/frontend/Makefile.toml
+++ b/frontend/Makefile.toml
@@ -42,7 +42,7 @@ FLUTTER_OUTPUT_DIR = "Release"
 PRODUCT_EXT = "app"
 
 
-[env.development-windows]
+[env.development-desktop-windows-x86]
 TARGET_OS = "windows"
 RUST_COMPILE_TARGET = "x86_64-pc-windows-msvc"
 BUILD_FLAG = "debug"
diff --git a/frontend/app_flowy/.vscode/tasks.json b/frontend/app_flowy/.vscode/tasks.json
index 1baace0f14..0011a00fb7 100644
--- a/frontend/app_flowy/.vscode/tasks.json
+++ b/frontend/app_flowy/.vscode/tasks.json
@@ -2,7 +2,7 @@
 	"version": "2.0.0",
 	// https://code.visualstudio.com/docs/editor/tasks
 			//https://gist.github.com/deadalusai/9e13e36d61ec7fb72148
-			
+
 			// ${workspaceRoot}: the root folder of the team
 			// ${file}: the current opened file
 			// ${fileBasename}: the current opened file's basename
@@ -13,6 +13,16 @@
 		{
 			"type": "shell",
 			"command": "sh ./scripts/build_sdk.sh",
+			"windows": {
+				"options": {
+					"shell": {
+						"executable": "cmd.exe",
+						"args": [
+							"/d", "/c", ".\\scripts\\build_sdk.cmd"
+						]
+					}
+				}
+			},
 			"group": "build",
 			"options": {
 				"cwd": "${workspaceFolder}/../"
diff --git a/frontend/scripts/build_sdk.cmd b/frontend/scripts/build_sdk.cmd
new file mode 100644
index 0000000000..e27b4cd3e4
--- /dev/null
+++ b/frontend/scripts/build_sdk.cmd
@@ -0,0 +1,3 @@
+echo "Start building rust sdk"
+rustup show
+cargo make --profile development-desktop-windows-x86 flowy-sdk-dev
\ No newline at end of file
diff --git a/frontend/scripts/makefile/desktop.toml b/frontend/scripts/makefile/desktop.toml
index 895de94a1d..981e4a89ce 100644
--- a/frontend/scripts/makefile/desktop.toml
+++ b/frontend/scripts/makefile/desktop.toml
@@ -41,6 +41,18 @@ script = [
 ]
 script_runner = "@shell"
 
+[tasks.sdk-build.windows]
+private = true
+script = [
+  """
+    cd rust-lib
+    echo cargo build --package=dart-ffi --target ${RUST_COMPILE_TARGET} --features=${FEATURES}
+    exec cargo build --package=dart-ffi --target ${RUST_COMPILE_TARGET} --features=${FEATURES}
+    cd ..
+  """,
+]
+script_runner = "@duckscript"
+
 #
 [tasks.flowy-sdk-release]
 description = "Build flowy sdk in release mode"
diff --git a/frontend/scripts/makefile/env.toml b/frontend/scripts/makefile/env.toml
index 4b5c41f277..5d060231bc 100644
--- a/frontend/scripts/makefile/env.toml
+++ b/frontend/scripts/makefile/env.toml
@@ -10,6 +10,7 @@ output = exec powershell -Command "Get-CimInstance MSFT_VSInstance | select -Exp
 stdout = set ${output.stdout}
 pos = last_indexof ${stdout} .
 new_str = substring ${stdout} 0 ${pos}
+# TODO: will raise error if there are more than 1 visual studio installation
 newer = semver_is_newer ${new_str} 16.11.0
 assert ${newer} "Visual studio 2019 is not installed or version is lower than 16.11.0"
 """
@@ -101,7 +102,7 @@ if is_empty ${ret}
 end
 ret = which protoc-gen-dart
 if is_empty ${ret}
-    dart pub global activate protoc_plugin
+    exec cmd.exe /c dart pub global activate protoc_plugin
     home_dir = get_home_dir
     echo Please add '${home_dir}\\\\AppData\\\\Local\\\\Pub\\\\Cache\\\\bin' into PATH env var
     exit -1