Merge pull request #2 from grael/doc

Documentation, workflow and minor fix

.github/workflows/rust-ci.yml

@@ -1,25 +1,36 @@
-name: Rust
+name: Rust CI
 
-on: [push]
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - 'master'
+
+env:
+  CARGO_TERM_COLOR: always
 
 jobs:
   build-mac:
     runs-on: macos-latest
-
     steps:
     - uses: actions/checkout@v2
 
     - name: Build
       run: cargo build --release
 
+    - name: Run tests
+      run: cargo test --verbose
+
     - uses: actions/upload-artifact@v2
       with:
         name: copyrat-macos.zip
         path: ./target/release/*copyrat
 
+
   build-linux:
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
 
@@ -31,6 +42,9 @@ jobs:
     - name: Build
       run: cargo build --release
 
+    - name: Run tests
+      run: cargo test --verbose
+
     - uses: actions/upload-artifact@v2
       with:
         name: copyrat-linux.zip

.travis.yml

@@ -1,21 +0,0 @@
-language: rust
-cache: cargo
-dist: trusty
-os:
-  - linux
-  - osx
-
-rust:
-  - nightly
-  - stable
-
-before_script:
-  - rustup component add rustfmt
-  - cargo install --force cargo-audit
-  - cargo generate-lockfile
-
-script:
-  - cargo fmt --all -- --check
-  - cargo build
-  - cargo test
-  - cargo audit

README.md

@@ -1,8 +1,8 @@
-# tmux-thumbs
+# tmux-copyrat
 
-![](https://travis-ci.com/fcsonline/tmux-thumbs.svg?branch=master)
+![Rust](https://github.com/graelo/tmux-copyrat/workflows/Rust/badge.svg)
 
-A lightning fast version of [tmux-fingers](https://github.com/Morantron/tmux-fingers) written in [Rust](https://www.rust-lang.org/) for copy pasting with vimium/vimperator like hints.
+A hommage to [tmux-copyrat](https://github.com/tmux-plugins/tmux-copycat), written in [Rust](https://www.rust-lang.org/) for copy pasting within [tmux](http://tmux.github.io).
 
 ## Usage
 
@@ -38,20 +38,20 @@ more with `--regexp` parameter.
 Clone the repo:
 
 ```
-git clone https://github.com/fcsonline/tmux-thumbs ~/.tmux/plugins/tmux-thumbs
+git clone https://github.com/graelo/tmux-copyrat ~/.tmux/plugins/tmux-copyrat
 ```
 
 Compile it with [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html):
 
 ```
-cd ~/.tmux/plugins/tmux-thumbs
+cd ~/.tmux/plugins/tmux-copyrat
 cargo build --release
 ```
 
 Source it in your `.tmux.conf`:
 
 ```
-run-shell ~/.tmux/plugins/tmux-thumbs/tmux-thumbs.tmux
+run-shell ~/.tmux/plugins/tmux-copyrat/tmux-copyrat.tmux
 ```
 
 Reload TMUX conf by running:
@@ -65,7 +65,7 @@ tmux source-file ~/.tmux.conf
 You can add this line to your list of [TPM](https://github.com/tmux-plugins/tpm) plugins in `.tmux.conf`:
 
 ```
-set -g @plugin 'fcsonline/tmux-thumbs'
+set -g @plugin 'graelo/tmux-copyrat'
 ```
 
 To be able to install the plugin just hit <kbd>prefix</kbd> + <kbd>I</kbd>. You should now be able to use
@@ -73,26 +73,26 @@ the plugin!
 
 ## Configuration
 
-If you want to customize how is shown your tmux-thumbs hints those all available
+If you want to customize how is shown your tmux-copyrat hints those all available
 parameters to set your perfect profile.
 
 NOTE: for changes to take effect, you'll need to source again your `.tmux.conf` file.
 
-* [@thumbs-key](#thumbs-key)
+- [@copyrat-key](#thumbs-key)
-* [@thumbs-alphabet](#thumbs-alphabet)
+- [@copyrat-alphabet](#thumbs-alphabet)
-* [@thumbs-reverse](#thumbs-reverse)
+- [@copyrat-reverse](#thumbs-reverse)
-* [@thumbs-unique](#thumbs-unique)
+- [@copyrat-unique](#thumbs-unique)
-* [@thumbs-position](#thumbs-position)
+- [@copyrat-position](#thumbs-position)
-* [@thumbs-regexp-N](#thumbs-regexp-N)
+- [@copyrat-regexp-N](#thumbs-regexp-N)
-* [@thumbs-command](#thumbs-command)
+- [@copyrat-command](#thumbs-command)
-* [@thumbs-upcase-command](#thumbs-upcase-command)
+- [@copyrat-upcase-command](#thumbs-upcase-command)
-* [@thumbs-bg-color](#thumbs-bg-color)
+- [@copyrat-bg-color](#thumbs-bg-color)
-* [@thumbs-fg-color](#thumbs-fg-color)
+- [@copyrat-fg-color](#thumbs-fg-color)
-* [@thumbs-hint-bg-color](#thumbs-hint-bg-color)
+- [@copyrat-hint-bg-color](#thumbs-hint-bg-color)
-* [@thumbs-hint-fg-color](#thumbs-hint-fg-color)
+- [@copyrat-hint-fg-color](#thumbs-hint-fg-color)
-* [@thumbs-select-fg-color](#thumbs-select-fg-color)
+- [@copyrat-select-fg-color](#thumbs-select-fg-color)
-* [@thumbs-select-bg-color](#thumbs-select-bg-color)
+- [@copyrat-select-bg-color](#thumbs-select-bg-color)
-* [@thumbs-contrast](#thumbs-contrast)
+- [@copyrat-contrast](#thumbs-contrast)
 
 ### @thumbs-key
 
@@ -291,8 +291,6 @@ This is the list of available colors:
 
 This is the list of available alphabets:
 
-- `numeric`: 1234567890
-- `abcd`: abcd
 - `qwerty`: asdfqwerzxcvjklmiuopghtybn
 - `qwerty-homerow`: asdfjklgh
 - `qwerty-left-hand`: asdfqwerzcxv
@@ -326,7 +324,7 @@ This is the known list of versions of `tmux` compatible with `tmux-thumbs`:
 
 | Version | Compatible |
 |:-------:|:----------:|
-|   3.0a  |     ✅     |
+|   3.0b  |     ✅     |
 |   2.9a  |     ✅     |
 |   2.8   |      ❓    |
 |   2.7   |      ❓    |

src/ui.rs

@@ -35,7 +35,7 @@ impl<'a> Ui<'a> {
         let lookup_trie = model::Model::build_lookup_trie(&matches);
         let focus_index = if model.reverse { matches.len() - 1 } else { 0 };
 
-        let (term_width, _) = termion::terminal_size().expect("Cannot read the terminal size.");
+        let (term_width, _) = termion::terminal_size().unwrap_or((80u16, 30u16)); // .expect("Cannot read the terminal size.");
         let line_offsets = get_line_offsets(&model.lines, term_width);
 
         Ui {