chore(version): bump, and update roadmap + changelog

olets · May 9, 2020 · 9b02288 · 9b02288
1 parent d1d84cd
commit 9b02288
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 237 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+# [v3.3.0](https://github.com/olets/zsh-abbr/compare/v3.2.3...v3.3.0) (2020-05-09)
+
+Prettier output. Suppress output with `--quiet`. Don't add an abbreviation if it would interfere with an existing command. Add it anyway with `--force`.
+
+### Features
+
+* **add:** support forcing add over system command ([57eb4a8](https://github.com/olets/zsh-abbr/commit/57eb4a8671df10f30cf24e49cad3be1156511f40))
+* **add:** warn if a command exists ([0311ecf](https://github.com/olets/zsh-abbr/commit/0311ecf6db742df733f20c583d0c27afeb3ecff3))
+* **dry run:** helper message more visible ([cce33fc](https://github.com/olets/zsh-abbr/commit/cce33fcf6cb37bd0f36dfdbfddb3d9f689bdbe4d))
+* **import aliases:** respect type ([c000975](https://github.com/olets/zsh-abbr/commit/c000975526a798498e1b1cbdb679e1a796ed1943))
+* **import git aliases:** warning gives key not full key+value ([cbe4074](https://github.com/olets/zsh-abbr/commit/cbe4074ef5c795d4d641715bf0bf5490a75087ab))
+* **quiet, exit status:** output to stdout or stderr with quiet option ([e671a87](https://github.com/olets/zsh-abbr/commit/e671a8794f9b1abcd0976583c0727a8ebf18caf9))
+
+
 # [v3.2.3](https://github.com/olets/zsh-abbr/compare/v3.2.2...v3.2.3) (2020-04-23)
 
 

diff --git a/ROADMAP.md b/ROADMAP.md
@@ -15,12 +15,7 @@ Key:
 ## 3.x
 
 - [ ] testing framework?
-- [x] log message about what change was made
-- [ ] Git status-like: when job finishes, list actions taken by group (added, erased, couldn't add (already exists), could erase (doesn't exist), didn't add (e.g. git function alias))
-  - [ ] color coded
-- [x] support --quiet option and ZSH_ABBR_QUIET env variable
 - [ ] maybe split abbr into its own file, and autoload it
-- [ ] sync as last step of initialization
 
 Chrome
 

diff --git a/man/abbr.txt b/man/abbr.txt
@@ -1,228 +0,0 @@
-ZSH-ABBR(1)                      User Commands                     ZSH-ABBR(1)
-
-
-
-NAME
-       zsh-abbr - manage zsh abbreviations
-
-SYNOPSIS
-       abbr (--add | -a) [scope] [--force] <abbreviation> <expansion>
-
-       abbr (--clear-session | -c)
-
-       abbr (--erase | -e) [scope] <abbreviation>
-
-       abbr (--expand | -x) <abbreviation>
-
-       abbr (--export-aliases | -o) <scope> [<destination>]
-
-       abbr --import-aliases [scope]
-
-       abbr --import-fish <file>
-
-       abbr --import-git-aliases
-
-       abbr --list
-
-       abbr (--list-abbreviations | -l)
-
-       abbr (--list-commands | -L | --show | -s)
-
-       abbr (--rename | -R) [scope] <old_abbreviation> <new_abbreviation>
-
-       abbr (--help | -h)
-
-       abbr (--version | -v)
-
-
-DESCRIPTION
-       abbr  manages abbreviations - user-defined words that are replaced with
-       longer phrases after they are entered.
-
-       For example, a frequently-run command like git checkout can be abbrevi-
-       ated to gco. After entering gco and pressing [Space], the full text git
-       checkout will appear in the command line.
-
-       To prevent expansion, press [CTRL-SPACE] in place of [SPACE].
-
-
-Options
-       The following options are available:
-
-
-       o      --add abbreviation expansion or -a abbreviation expansion
-
-              Adds a new abbreviation, causing abbreviation to be expanded  as
-              expansion.
-
-              Will error rather than overwrite an existing abbreviation.
-
-              Will warn if the abbreviation would replace an existing command.
-              To add in spite of the warning, use [--force].
-
-
-       o      --clear-session or -c
-
-              Erases all session abbreviations.
-
-
-       o      --erase abbreviation or -e abbreviation
-
-              Erases the abbreviation abbreviation .
-
-
-       o      --expand abbreviation or -x abbreviation
-
-              Returns the expansion of the abbreviation abbreviation.
-
-
-       o      --export-aliases [<destination>]
-
-              Exports a list of alias command for user abbreviations, suitable
-              for  pasting or piping to whereever you keep aliases. If a <des-
-              tination> is provided, the commands will be appended to it.
-
-
-       o      --import-aliases
-
-              Adds abbreviations for all aliases.
-
-
-       o      --import-fish <file>
-
-              Adds abbreviations exported from fish.
-
-
-       o      --import-git-aliases
-
-              Adds two abbreviations for each git alias: a  regular  abbrevia-
-              tion, and a "g"-prefixed global abbreviation.
-
-
-       o      abbr --list
-
-              Lists  the  available  abbreviations  without  their expansions.
-              Equivalent to fish's `abbr --list`.
-
-
-       o      --list-abbreviations or -l
-
-              Lists all abbreviations.
-
-
-       o      --list-commands or -L (or --show or -s as in fish)
-
-              Lists all abbreviations as  commands  suitable  for  export  and
-              import.
-
-
-       o      --rename  old_abbreviation  new_abbreviation or -R old_abbrevia-
-              tion new_abbreviation
-
-              Renames an abbreviation, from old_abbreviation to  new_abbrevia-
-              tion.
-
-
-       o      --version or -v
-
-              Show the current version.
-
-
-       All options except for --clear-session and --expand can take a scope:
-
-              o      --session or -S
-
-                     Abbreviations available in the current session only.
-
-
-              o      --user or -U
-
-                     Abbreviations  available  to  all current and future ses-
-                     sions.
-
-
-       All except for --clear-session, --expand, --import-fish, and  --import-
-       git-aliases can take a type:
-
-
-              o      --global or -g
-
-                     Abbreviation  will expand anywhere on a line, rather than
-                     only in command (first word) position.
-
-
-              o      --regular or -r (default)
-
-                     Abbreviation will expand in command (first word) position
-                     only.
-
-
-       All  except  for  --clear-session,  --expand, --export-aliases, --list-
-       abbreviations, and --list-commands can be tried without making changes:
-
-
-              o      --dry-run  Show whats the result of the command would be.
-
-
-       All except for  --clear-session,  --expand,  --export-aliases,  --list-
-       abbreviations, and --list-commands can be run with reduced output:
-
-
-              o      --quiet Do not log success, warning, or error messages.
-
-
-       See INTERNALS for more information.
-
-
-EXAMPLES
-       abbr gco="git checkout"
-
-              "gco"  will  be  expanded as "git checkout" when it is the first
-              word in the command, in all open and future sessions.
-
-
-       abbr -g gco="git checkout"
-
-              "gco" will be replaced with "git checkout" anywhere on the line,
-              in all open and future sessions.
-
-
-       abbr -g -S gco="git checkout"
-
-              "gco" will be replaced with "git checkout" anywhere on the line,
-              in the current session.
-
-
-       abbr -e -S -g gco;
-
-              Erase the global session abbreviation "gco". Note  that  because
-              expansion is triggered by [SPACE] and [ENTER], the semicolon (;)
-              is necessary to  prevent  expansion  when  operating  on  global
-              abbreviations.
-
-
-       abbr -e -g gco;
-
-              Erase the global user abbreviation "gco".
-
-
-       abbr -e gco
-
-              Erase the regular user abbrevation "gco".
-
-
-       abbr -R -g gco gch
-
-              Rename an existing global user abbreviation from "gco" to "gch".
-
-
-HISTORY
-       Inspired by fish shell's abbr.
-
-
-AUTHORS
-       Henry Bley-Vroman <olets@olets.dev>
-
-
-
-abbr 3.2.3                       April 22 2020                     ZSH-ABBR(1)

diff --git a/man/man1/abbr.1 b/man/man1/abbr.1
@@ -1,4 +1,4 @@
-.TH "ZSH-ABBR" 1 "April 22 2020" "abbr 3.2.3" "User Commands"
+.TH "ZSH-ABBR" 1 "May 9 2020" "abbr 3.3.0" "User Commands"
 .SH NAME
 zsh\-abbr \- manage zsh abbreviations
 .SH SYNOPSIS

diff --git a/zsh-abbr.zsh b/zsh-abbr.zsh
@@ -1,6 +1,6 @@
 # fish shell-like abbreviation management for zsh.
 # https://github.com/olets/zsh-abbr
-# v3.2.3
+# v3.3.0
 # Copyright (c) 2019-2020 Henry Bley-Vroman
 
 
@@ -27,10 +27,10 @@ _zsh_abbr() {
     force=${ZSH_ABBR_FORCE:-0}
     number_opts=0
     quiet=${ZSH_ABBR_QUIET:-0}
-    release_date="April 22 2020"
+    release_date="May 9 2020"
     text_bold="\\033[1m"
     text_reset="\\033[0m"
-    version="zsh-abbr version 3.2.3"
+    version="zsh-abbr version 3.3.0"
 
     if (( ZSH_ABBR_INITIALIZING )); then
       quiet=1