Batch 1: Github Actions, Brew recipe, linting suggestions, fish completion etc

.github/workflows/build.yml

@@ -0,0 +1,22 @@
+on: [push]
+name: build
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+      - name: build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+      - name: test
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+      - name: lint
+        uses: actions-rs/clippy-check@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

.vscode/launch.json

@@ -7,12 +7,12 @@
         {
             "type": "lldb",
             "request": "launch",
-            "name": "Debug executable 'cookbook'",
+            "name": "Debug executable 'tome'",
             "cargo": {
                 "args": [
                     "build",
-                    "--bin=cookbook",
-                    "--package=cookbook"
+                    "--bin=tome",
+                    "--package=tome"
                 ],
                 "filter": {
                     "kind": "bin"
@@ -24,13 +24,13 @@
         {
             "type": "lldb",
             "request": "launch",
-            "name": "Debug unit tests in executable 'cookbook'",
+            "name": "Debug unit tests in executable 'tome'",
             "cargo": {
                 "args": [
                     "test",
                     "--no-run",
-                    "--bin=cookbook",
-                    "--package=cookbook"
+                    "--bin=tome",
+                    "--package=tome"
                 ],
                 "filter": {
                     "kind": "bin"

CONTRIBUTING.md

@@ -0,0 +1 @@
+docs/CONTRIBUTING.md

Cargo.toml

@@ -3,6 +3,7 @@ name = "tome"
 version = "0.1.0"
 authors = ["Yusuke Tsutsumi <yusuke@tsutsumi.io>"]
 edition = "2018"
+license = "MIT"
 
 [dependencies]
 tui = "0.3.0"

HomebrewFormula

@@ -0,0 +1 @@
+pkg/brew

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Yusuke Tsutsumi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1 @@
+docs/index.md

bin/release

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+set -eou pipefail
+set -x
+
+readonly TARGETS=(x86_64-unknown-linux-musl x86_64-apple-darwin)
+
+source <(./bin/setenv)
+
+for target in "${TARGETS[@]}";do
+  cargo build --release --target "$target"
+done

bin/setenv

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+# USAGE: ./bin/setenv
+# SUMMARY: Set env outputs the correct environmental variables to cross compile to
+# linux and darwin from either a build platform of linux or darwin.
+# Run this script before trying to do cross compilation.
+# Credit: http://timryan.org/2018/07/27/cross-compiling-linux-binaries-from-macos.html
+
+set -eou pipefail
+
+# Build platform
+OS="$(uname -a | awk '{print tolower($1)}')"
+
+case "$OS" in
+  "darwin")
+    echo export CARGO_TARGET_X86_64_UNKNOWN_LINUX_MUSL_LINKER="x86_64-linux-musl-gcc"
+    ;;
+  "linux")
+    echo export CARGO_TARGET_X86_64_APPLE_DARWIN_LINKER="x86_64-apple-darwin15-clang"
+    echo export CARGO_TARGET_X86_64_APPLE_DARWIN_AR="x86_64-apple-darwin15-ar"
+    ;;
+  *)
+    echo -e "Unknown build platform, only darwin and linux are supported"
+    exit 1
+    ;;
+esac

docs/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+### Testing
+
+`cargo test`
+
+### Linting
+
+`cargo clippy`
+
+### Compiling for build platform (ie linux on linux)
+
+```
+# debug
+cargo build
+# release
+cargo build --release
+```
+
+### Cross compile (linux on darwin) release builds
+
+This is a portable script that sets up ENV variables to allow for cross compiling
+from darwin to linux or reverse.
+
+```
+./bin/release
+```

docs/index.md

@@ -1,11 +1,18 @@
 # Introduction
 
+## Quickstart
+- Download binary for platform from Releases
+- Add init command to your shell init: ie for zsh add to ~/.zshrc
+```
+eval "$(tome init my-commands ~/my-scripts zsh)"
+```
+- `my-commands --help`
+
 ## What is Tome?
 
-Tome provides easy organization
-and execution of collections of command line scripts.
+Tome provides easy organization and execution of collections of command line scripts.
 
-Basically take a directory of scripts like this:
+With a directory of scripts like this:
 
 ```
 root/
@@ -20,7 +27,7 @@ root/
       provision-my-service
 ```
 
-And be able run them like:
+Tome allows for executing them like:
 
 ```
 $ my-command go-to-workspace
@@ -35,7 +42,7 @@ And add in some features for discoverability:
 
 * tab-completion
 * search all available commands (just enter your command with no arguments)
-* TODO: help commands
+* help commands
 
 ## Why?
 
@@ -47,6 +54,9 @@ This works well for a small group, but once you're trying to share scripts acros
 * namespacing: how do I find commands that relate to what I'm working on?
 * completion: It's nice
 
+### Prior Art & Inspiration
+https://github.com/basecamp/sub
+
 ## Getting Started
 
 ### 1. Download Tome
@@ -72,7 +82,7 @@ root/
 
 (keeping these in version control is recommended)
 
-Put them in a well known, persistent location as well (e.g. ~/my-scripts). 
+Put them in a well known, persistent location as well (e.g. ~/my-scripts).
 
 ### 3. Put The Initialization Code in your .rc file
 
@@ -81,12 +91,25 @@ to be named "my-commands" you'd put the following in your .bashrc or .zshrc:
 
 ```
 # posix example, e.g. .bashrc
-eval "`~/bin/tome init my-commands ~/my-scripts $0`"
+eval "$(tome init my-commands ~/my-scripts bash)"
+
+# zsh
+eval "$(tome init my-commands ~/my-scripts zsh)"
+```
+
+For fish shell:
+```
+# in ~/.config/fish/conf.d/tome.fish
+tome init my-commands ~/my_script_dir $0 | source
 ```
 
 *NOTE*: make sure to include the double quotes with the nested backticks. This ensures that newlines are captured
 and evaluated appropriately.
 
 ### 4. Start a New Shell
 
-Once installed, start a new shell and you should have your new command!
+Once installed, start a new shell and you should have your new command!
+
+## Developing Tome
+
+See CONTRIBUTING.md

pkg/brew/tome.rb

@@ -0,0 +1,18 @@
+class Tome < Formula
+  HOMEPAGE = "https://github.com/toumorokoshi/tome"
+
+  desc "Modern replacement for 'sub'"
+  homepage HOMEPAGE
+  url HOMEPAGE
+  license "MIT"
+  version '0.1.0'
+  revision 1
+
+  head "#{HOMEPAGE}.git"
+
+  depends_on "rust" => :build
+
+  def install
+    system "cargo", "install", *std_cargo_args
+  end
+end

src/commands/help.rs

@@ -21,11 +21,11 @@ pub fn help(root: &str, mut _args: Peekable<Iter<String>>) -> io::Result<String>
             escape_slashes(&script.summary_string)
         ))
     }
-    return Ok(format!(
+    Ok(format!(
         help_template!(),
         root,
         commands_with_help.join("\\n")
-    ));
+    ))
 }
 
 // escape slash characters with posix-compatible quotes. Helps if the echo