]> git.wincent.com - docvim.git/commitdiff
Use --build-watch and document how to use it
authorGreg Hurrell <greg@hurrell.net>
Thu, 24 Mar 2016 16:04:13 +0000 (09:04 -0700)
committerGreg Hurrell <greg@hurrell.net>
Thu, 24 Mar 2016 16:04:13 +0000 (09:04 -0700)
Along with some other tricks that I've learned.

.tmux
README.md

diff --git a/.tmux b/.tmux
index 63df1af588f324cac6079cabd70221de24ff1e64..67e0fb1a7373acd0a1134fd35b2651fb7a4c99ef 100755 (executable)
--- a/.tmux
+++ b/.tmux
@@ -16,7 +16,11 @@ tmux send-keys -t docvim:vim "vim -c CommandT" Enter
 tmux new-window -t docvim -n repl
 tmux send-keys -t docvim:repl "stack repl" Enter
 
-# 3. General shell use.
+# 3. Build
+tmux new-window -t docvim -n build
+tmux send-keys -t docvim:build "stack build --file-watch" Enter
+
+# 4. General shell use.
 tmux new-window -t docvim
 
 tmux attach -t docvim:vim
index 2123246e6d4b3ca5973b27c0d1fbc46bf3f33b68..ac9f0b939aec7f134801d5c95a6c1963d2366f10 100644 (file)
--- a/README.md
+++ b/README.md
@@ -61,6 +61,12 @@ cabal repl`
 > pp "let l:test=1" -- pretty-prints AST
 ```
 
+### Building
+
+```bash
+stack build --file-watch
+```
+
 ### Building and viewing the code-level documentation
 
 ```bash
@@ -77,22 +83,36 @@ open dist/doc/html/docvim/docvim/index.html
 
 ```bash
 # Stack:
-stack test
+stack test        # Runs all test suites, including linting.
+stack test :tasty # Runs just the Tasty test suite.
+
+# Cabal:
+cabal test       # Runs all test suites, including linting.
+cabal test tasty # Runs just the Tasty test suite.
+```
+
+#### Updating "golden" files
+
+```bash
+# Stack:
+stack test --test-arguments=--accept          # Runs all test suites.
+stack test :tasty --test-arguments=--accept   # Runs just the Tasty test suite.
 
 # Cabal:
-cabal test
+cabal test --test-options=---accept           # Runs all test suites.
+cabal test tasty --test-options=---accept     # Runs just the Tasty test suite.
 ```
 
 ### Linting
 
 ```bash
 # Stack:
-stack test              # Runs linter as part of overall suite.
-stack test :hlint       # Runs the linter alone.
+stack test              # Runs linter as part of overall set of suites.
+stack test :hlint       # Runs linter alone.
 
 # Cabal:
 cabal install hlint     # (First-time only).
-cabal test              # Runs linter as part of overall suite.
+cabal test              # Runs linter as part of overall set of suites.
 cabal test hlint        # Runs linter alone.
 
 hlint src               # If you have HLint installed under $PATH.