Refactor repository to be managed by a Makefile

Author: sylver

.travis.yml

@@ -6,7 +6,7 @@ notifications:
 sudo: false
 
 script:
-  - shellcheck asimov *.sh
+  - shellcheck asimov scripts/*.sh
 
 matrix:
   fast_finish: true

Makefile

@@ -0,0 +1,9 @@
+all: install
+
+.PHONY: install
+install:
+	@scripts/install.sh
+
+.PHONY: uninstall
+uninstall:
+	@scripts/uninstall.sh

README.md

@@ -18,10 +18,16 @@ To get started with Asimov, clone the repository or download and extract an arch
 $ git clone git@github.com:stevegrunwell/asimov.git
 ```
 
-After you've cloned the repository, run the `install.sh` script to automatically:
-* Symlink Asimov to `/usr/local/bin`, making it readily available from anywhere.
-* Schedule Asimov to run once a day, ensuring new projects' dependencies are quickly excluded from Time Machine backups.
-* Run Asimov for the first time, finding all current project dependencies adding them to Time Machine's exclusion list.
+After you've cloned the repository :
+* [optional] before installing, you can edit `com.stevegrunwell.asimov.plist` to change the scheduling of Asimov (default to once a day)
+* run a `make` command to automatically :
+  * Copy Asimov to `/usr/local/bin`, making it readily available from anywhere.
+  * Schedule Asimov, ensuring new projects' dependencies are quickly excluded from Time Machine backups.
+  * Run Asimov for the first time, finding all current project dependencies adding them to Time Machine's exclusion list.
+
+## Uninstall
+
+Simply run `make uninstall` from your cloned repository.
 
 ## How it works
 

TODO.md

@@ -0,0 +1,7 @@
+# TODO
+
+- exclude `.Trash` from scanning
+- ensure exclusions from `.vscode` modules does not break them once restored
+- ensure exclusions from Applications based on node with a `node_modules` folder does not break them once restored
+- Add a parameter to the `install.sh` script to set the `StartInterval`
+- Make a brew formulae

com.stevegrunwell.asimov.plist

@@ -7,7 +7,11 @@
         <key>Program</key>
         <string>/usr/local/bin/asimov</string>
         <key>StartInterval</key>
-        <!-- 24 hours = 60 * 60 * 24 -->
+        <!-- 24 hours = 60 * 60 * 24 = 86400 -->
+        <!-- 12 hours = 60 * 60 * 12 = 43200 -->
+        <!-- 6 hours = 60 * 60 * 6 = 21600 -->
+        <!-- 2 hours = 60 * 60 * 2 = 7200 -->
+        <!-- 1 hour = 60 * 60 = 3600 -->
         <integer>86400</integer>
     </dict>
 </plist>

install.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+
+# Install Asimov as a launchd daemon.
+#
+# @author  Steve Grunwell
+# @license MIT
+
+# shellcheck source=vars.sh
+source "$(pwd -P)/$(dirname $0)/vars.sh"
+
+# Verify that Asimov is executable.
+chmod +x "${DIR}/asimov"
+
+# Copy Asimov into /usr/local/bin.
+echo -e "\\033[0;36mInstalling to ${BIN}\\033[0m"
+cp -a "${DIR}/asimov" "${BIN}"
+
+# Ensure daemon is not already loaded.
+if launchctl list | grep -q com.stevegrunwell.asimov; then
+  echo -e "\\n\\033[0;36mUnloading current instance of ${PLIST}\\033[0m";
+  launchctl unload "${DIR}/${PLIST}"
+fi
+
+# Load the .plist file.
+launchctl load "${DIR}/${PLIST}" && echo -e "\\n\\033[0;32mAsimov daemon has been loaded!\\033[0m";
+
+# Run Asimov for the first time.
+
+echo -e "\\nRun Asimov immediately with \\033[0;35m${BIN}\\033[0m"

scripts/install.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# Uninstall Asimov.
+#
+# @author  Steve Grunwell
+# @license MIT
+
+# shellcheck source=vars.sh
+source "$(pwd -P)/$(dirname $0)/vars.sh"
+
+echo -e "\\n\\033[0;36mRemoving command ${BIN}\\033[0m";
+[[ -f ${BIN} ]] && rm "${BIN}"
+
+if launchctl list | grep -q com.stevegrunwell.asimov; then
+  echo -e "\\n\\033[0;36mUnloading current instance of ${PLIST}\\033[0m";
+  launchctl unload "${DIR}/${PLIST}"
+fi
+
+echo -e "\\n\\033[0;32mAsimov has been successfully uninstalled.\\033[0m";

scripts/uninstall.sh

@@ -0,0 +1,3 @@
+DIR="$(pwd -P)"
+BIN="/usr/local/bin/asimov"
+PLIST="com.stevegrunwell.asimov.plist"