Create valid symbolic link to output dir (#226)

JordanMartinez · web-flow · commit 8cd250b95f70 · 2021-05-29T12:30:23.000-07:00
* Use workaround to ensure one ln command works on MacOS _and_ Linux

Using `ln -s output ../client/public/js/output` works on MacOS, but not Linux. The equivalent on Linux would be to add a `--relative` flag, but this doesn't exist for MacOS. MacOS uses BSD `ln` whereas Linux uses GNU ln`. The `"$PWD" works around this limitation

* Prevent the symbolic link from being committed accidentally
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@ cabal.sandbox.config
 *.chs.h
 *.lksh*
 bundle/
+client/public/js/output
diff --git a/README.md b/README.md
@@ -98,8 +98,8 @@ stack build
 cd staging
 spago build
 
-# Ensure the compiled JavaScript is available to the client
-ln -s output ../client/public/js/output
+# Ensure the compiled JavaScript is available to the client via symbolic link.
+ln -s "$PWD/output" "$PWD/../client/public/js/output"
 
 # Then, start the server.
 #

-Original file line number
+Diff line change
 *.chs.h
 *.lksh*
 bundle/
 +client/public/js/output
Original file line number	Diff line number	Diff line change
`@@ -98,8 +98,8 @@ stack build`
`98`	`98`	`cd staging`
`99`	`99`	`spago build`
`100`	`100`
`101`		`-# Ensure the compiled JavaScript is available to the client`
`102`		`-ln -s output ../client/public/js/output`
	`101`	`+# Ensure the compiled JavaScript is available to the client via symbolic link.`
	`102`	`+ln -s "$PWD/output" "$PWD/../client/public/js/output"`
`103`	`103`
`104`	`104`	`# Then, start the server.`
`105`	`105`	`#`