docs: updated documentation for hooks

Author: Travis Davis

README.md

@@ -29,4 +29,5 @@ authors = [
     { signature = "Paul Delafosse", username = "oknozor" },
     { signature = "Dustin Speckhals", username = "DSpeckhals" },
     { signature = "Lucas Declercq", username = "lucas-dclrcq" },
-]
+    { signature = "Travis Davis", username = "travisdavis-ops" },
+]

cog.toml

@@ -37,7 +37,7 @@ link = "https://googlechrome.github.io/lighthouse/viewer/?gist=7731347bb8ce999ef
 
 [[extra.home.list]]
 title = "Installation hooks"
-content = "Live reload your window manager components with post installation hooks"
+content = "Live reload your window manager components with pre and post installation hooks"
 
 [[extra.home.list]]
 title = "Themes and profiles"

website/config.toml

@@ -20,7 +20,7 @@ top = false
 
 ## Config imports
 
-Instead of having all your configs defined in a single toml file, you can split it into multiple file : 
+Instead of having all your configs defined in a single toml file, you can split it into multiple file :
 
 ```toml
 
@@ -35,15 +35,15 @@ path = "sway/sway.toml"
 path = "i3/i3.toml"
 ```
 
-In this example we have defined our `i3` and `sway` profile in separate files : 
+In this example we have defined our `i3` and `sway` profile in separate files :
 
 ```toml
 # {dotfile_dir}/i3/i3.toml
 [profiles.i3]
-hooks = ["i3-msg reload"]
+posthooks = ["i3-msg reload"]
 
 [profiles.i3.dots]
 i3 =  { source = "i3/wm", target = ".config/i3" }
 polybar =  { source = "i3/polybar", target = ".config/polybar" }
 rofi =  { source = "i3/rofi", target = ".config/rofi" }
-```
+```

website/content/docs/config-import/import.md

@@ -16,10 +16,10 @@ top = false
 
 ## Installation
 
-Toml Bombadil is a single rust binary. Currently, you can install it via [cargo](https://doc.rust-lang.org/cargo/), 
-the rust package manager, or via the Arch User Repository if you use an Arch based distro. 
+Toml Bombadil is a single rust binary. Currently, you can install it via [cargo](https://doc.rust-lang.org/cargo/),
+the rust package manager, or via the Arch User Repository if you use an Arch based distro.
 
-### Cargo 
+### Cargo
 
 ```bash
 cargo install toml-bombadil
@@ -34,7 +34,7 @@ yay -S bombadil-bin
 
 ### Setup
 
-If you already have some dotfiles on a git repository, no need to start from scratch : 
+If you already have some dotfiles on a git repository, no need to start from scratch :
 
 ```bash
 git clone https://github.com/my_org/dotfiles
@@ -55,12 +55,12 @@ For Bombadil to be able to run from any directory and use different config files
 bombadil install -c my_dotfiles/bombadil.toml
 ```
 
-⚠️ : Toml Bombadil will generate a copy of your dotfiles under `.dots`. If you use git to manage your dotfiles, 
+⚠️ : Toml Bombadil will generate a copy of your dotfiles under `.dots`. If you use git to manage your dotfiles,
 you need to add `.dots` to your `.gitignore`.
 
 ### Configuration
 
-Toml Bombadil obviously uses the toml configuration format. here is a sample configuration : 
+Toml Bombadil obviously uses the toml configuration format. here is a sample configuration :
 
 ```toml
 # {dotfiles}/bombadil.toml
@@ -70,31 +70,31 @@ dotfiles_dir = "my_dotfiles"
 
 [settings]
 # An array of toml files paths containing the variables to inject in your templatized dotfiles
-# You can have multiple var files as long as variable names does not colide. 
+# You can have multiple var files as long as variable names does not colide.
 vars = [ "vars.toml" ]
 
 # An array of post install shell commands
-hooks = [ "sway reload" ]
+posthooks = [ "sway reload" ]
 
 [settings.dots]
 
-# A dot entry representing a symlink, `source` is relative to `dotfiles_dir` 
+# A dot entry representing a symlink, `source` is relative to `dotfiles_dir`
 # and `target` shall be relative to $HOME directory or absolute.
 sway = { source = "sway", target = ".config/sway" }
 
 # You can have as many dot entry as you want, linking files or directories
 alacritty = { source = "alacritty", target = ".config/alacritty/alacritty.yml" }
 ```
 
-Once you are satisfied with your config, you can install your dotfiles : 
+Once you are satisfied with your config, you can install your dotfiles :
 
 ```bash
 bombadil link
 ```
 
 ### Clean up
 
-If you want to remove symlinks generated by Toml Bombadil run the following : 
+If you want to remove symlinks generated by Toml Bombadil run the following :
 ```bash
 bombadil unlink
 ```
@@ -106,9 +106,9 @@ to their target locations. Instead, Toml Bombadil will create a copy of your dot
 those copy.
 
 The idea behind this is to inject variables into your dotfiles and allow you to compose various themes and profiles.
-Because of this, you will need to reload your dotfiles with `bombadil link` whenever you make change. 
+Because of this, you will need to reload your dotfiles with `bombadil link` whenever you make change.
 
-A convenient way to work with Toml Bombadil would be to add a keyboard shortcut for `bombadil link` in your window manager. 
+A convenient way to work with Toml Bombadil would be to add a keyboard shortcut for `bombadil link` in your window manager.
 
 ### Going further
 

website/content/docs/getting-started/quick-start.md

@@ -1,6 +1,6 @@
 +++
 title = "Hooks"
-description = "Manage post install hook"
+description = "Manage pre & post install hook"
 date = 2021-05-16
 updated = 2021-05-16
 template = "docs/section.html"

website/content/docs/hooks/_index.md

@@ -10,8 +10,8 @@ template = "docs/page.html"
 
 [extra]
 lead = """
-Bombadil's hooks are shell commands invoked after your dotfiles have been symlinked. They are useful if you need
-to reload some component manually after updating your dotfiles. 
+Bombadil's hooks are shell commands invoked before and after your dotfiles have been symlinked. They are useful if you need
+to reload some component manually after updating your dotfiles.
 """
 toc = true
 top = false
@@ -21,50 +21,54 @@ top = false
 
 ## Default profile hook
 
-Hooks are defined under the default profile section in Bombadil's configuration. In the example above, 
+Hooks are defined under the default profile section in Bombadil's configuration. In the example above,
 `sway reload` will run when running `bombadil link` to update any changes made to sway UI.
 
 ```toml
 dotfiles_dir = "bombadil-example.toml"
 
 [settings]
-hooks = [ "sway reload" ]
+prehooks = [ "echo \"Updating dots\""]
+posthooks = [ "sway reload" ]
 ```
 
 The default hooks will always run regardless of the activated profiles.
 
 ## Profile hooks
 
-If you maintain a profile per window manager you might want to leave the default profile hooks empty and manage 
-per profile hooks : 
+If you maintain a profile per window manager you might want to leave the default profile hooks empty and manage
+per profile hooks :
 
 ```toml
 [settings]
-hooks = [ "echo \"Default profile\"" ]
+prehooks = [ "echo \"Updating dots\""]
+posthooks = [ "echo \"Default profile\"" ]
 
 [profiles.sway]
-hooks = [ "sway reload", "echo \"Sway profile\"" ]
+prehooks = [ "echo \"Sway profile\"" ]
+posthooks = [ "sway reload" ]
 
 [profiles.i3]
-hooks = [ "i3-msg reload", "echo \"i3 profile\"" ]
+prehooks = [ "echo \"i3 profile\"" ]
+posthooks = [ "i3-msg reload" ]
 ```
 
 ### Limitations
 
 - Hooks run in a sub-shell therefore, **command meant to change your current shell environment won't work** :
 
 ```toml
-hooks = [ "source /home/user/.zshrc" ] # This does not work ! 
+posthooks = [ "source /home/user/.zshrc" ] # This does not work !
 ```
 
 - Environment variables won't be expanded unless you explicitly call a sub-shell :
 
 ```toml
-hooks = [ "echo $HOME" ] # This will print "$HOME"
+posthooks = [ "echo $HOME" ] # This will print "$HOME"
 ```
 
 ```toml
-hooks = [ "zsh -c \"echo $HOME\"" ] # This works
+posthooks = [ "zsh -c \"echo $HOME\"" ] # This works
 ```
 
-That's it for hooks, in the next chapter we will see how to split your Bombadil config into multiple files. 
+That's it for hooks, in the next chapter we will see how to split your Bombadil config into multiple files.

website/content/docs/hooks/hooks.md

@@ -26,7 +26,7 @@ Bombadil allow you two do this in several ways :
 - add hooks to the profile.
 
 
-Before going further, let's take a look at a real life example. In the following config, we have defined some 
+Before going further, let's take a look at a real life example. In the following config, we have defined some
 post-install hooks and dot entries for two profiles : `sway` and `i3`.
 
 ```toml
@@ -38,7 +38,7 @@ alacritty = { source = "alacritty", target = ".config/alacritty" }
 
 [profiles.sway]
 # Sway profile hook : running `bombadil link -p sway` will exectute `sway reload`
-hooks = ["sway reload"]
+posthooks = ["sway reload"]
 
 # Sway profile dot entries
 [profiles.sway.dots]
@@ -48,7 +48,7 @@ wofi = { source = "sway/wofi", target = ".config/wofi" }
 
 # i3 profile hook : running `bombadil link -p i3` will exectute `i3-msg reload`
 [profiles.i3]
-hooks = ["i3-msg reload"]
+posthooks = ["i3-msg reload"]
 
 # i3 profile dot entries
 [profiles.i3.dots]
@@ -73,7 +73,7 @@ OPTIONS:
     -p, --profiles <profiles>...    A list of comma separated profiles to activate [possible values: sway, i3]
 ```
 
-Alternatively the `bombadil get profiles` produce a one profiles per line output, suited for shell scripting : 
+Alternatively the `bombadil get profiles` produce a one profiles per line output, suited for shell scripting :
 ```
 ❯ bombadil get profiles
 sway