Add 'g C-a' like incremental increment functionality, support block selections, and more

CHANGELOG.org

@@ -0,0 +1,49 @@
+#+TITLE: Evil Numbers CHANGELOG
+
+* 0.7
+
+** Additions
+   + =evil-numbers-use-cursor-at-end-of-number= option to match numbers directly before the cursor
+     (diverging from VIM's default behavior).
+
+** Changes
+   + Use =message= instead of =error= when no number is found
+     (don't error since VIM doesn't use an error in this case).
+
+** Fixes
+   + Fix #27 Number directly before the cursor manipulated when the cursor can't move forward.
+
+* 0.6
+
+** Additions
+   + Add =evil-numbers-separator-chars= option to support separator characters,
+     such as =16_777_216= or =4,294,967,296=.
+   + Add =evil-numbers-case= option for the case to use for hexadecimal values (defaults to the current case).
+
+** Fixes
+   + Fix #25 increment steps to the next line.
+   + Fix #24 hexadecimal values case changes when incrementing/decrementing.
+   + Fix padding being ignored with block selection.
+   + Fix #21 increment w/ selection ignores items before the cursor.
+   + Fix padded argument is ignored on non-decimal types.
+   + Fix #20 The cursor moves when increment/decrement fails.
+   + Fix #18 operating on bin/hex/octal failed w/ the cursor at the start.
+   + Fix #17 bin/octal/hex numbers don't support becoming negative.
+   + Fix hyphen-separated numbers handling.
+   + Fix auto-loading evil macros.
+
+* 0.5
+
+** Additions
+   + Make padding optional.
+   + Add support for block selections.
+   + Add support for subscript and superscript numbers.
+   + Add g C-a like functionality
+     (i.e. increment first number in selection by 1, second one by 2 and so on).
+   + Pad negative numbers and add a plus sign if a negative number is turned into
+     a positive number (if padding is enabled).
+
+** Fixes
+   + Fix numbers being pushed out of selections.
+
+     (e.g. calling inc-at-pt on =^9 9$= where =^$= denote the start and end of the selection would result in =10 9=).

Makefile

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+test:
+	./tests/evil-numbers-tests.sh

README.org

@@ -1,47 +1,108 @@
-* Evil Numbers
-  - Increment / Decrement binary, octal, decimal and hex literals
+#+TITLE: Evil Numbers
 
-  - works like C-a/C-x in vim, i.e. searches for number up to eol and then
-    increments or decrements and keep zero padding up (unlike in vim)
+* Features
+  - Increment / Decrement binary, octal, decimal and hex literals.
+
+  - Works like =C-a= / =C-x= in VIM, i.e. searches for number up to =eol= and then
+    increments or decrements.
 
   - When a region is active, as in evil's visual mode, all the
-    numbers within that region will be incremented/decremented (unlike
-    in vim)
+    numbers within that region will be incremented/decremented (unlike in VIM).
+
+  - Increment/decrement numbers incrementally like =g C-a= / =g C-x= in VIM.
+
+  - Optionally keep zero padding (off by default).
+
 
 ** Detected Literals
-    - binary, e.g. =0b0101=, =0B0101=
-    - octal, e.g. =0o755=, =0O700=
-    - hexadecimal, e.g. =0xDEADBEEF=, =0XCAFE=
+   - Binary, e.g. =0b0101=, =0B0101=.
+   - Octal, e.g. =0o755=, =0O700=.
+   - Hexadecimal, e.g. =0xDEADBEEF=, =0XCAFE=.
+   - Unicode superscript and subscript, e.g. =²= and =₁=.
+
+* Usage
+  Once this package is installed, all you need to do is bind keys to
+  =evil-numbers/inc-at-pt= and =evil-numbers/dec-at-pt=.
+
+  Position cursor over or before the literal and play with your numbers!
+
+  You may also want to bind keys to the incremental versions of these functions.
+
+** Customization
+
+   - =evil-numbers-pad-default= ::
+     Set  to =t= if you want numbers to be padded with zeros (numbers with a leading zero are always padded).
+     If you want both behaviors, all commands take an optional argument =padded=.
+
+   - =evil-numbers-separator-chars= ::
+     This option to support separator characters, set to "_" or "," to support numeric literals such as:
+     =16_777_216= or =4,294,967,296=.
+
+     You may wish to set this as a buffer local variable to enable this only for languages that support separators.
 
-** Install
-   Put in =load-path=, =(require 'evil-numbers)= and bind, for example:
+   - =evil-numbers-case= ::
+     The case to use for hexadecimal numbers.
+
+     - =nil= Current case (default).
+     - '=upcase= Always upper case.
+     - '=downcase= Always lower case.
+
+   - =evil-numbers-use-cursor-at-end-of-number= ::
+     Support matching numbers directly before the cursor.
+
+     This is off by default as it doesn't follow VIM's behavior.
+
+** Key Bindings
+   Example key bindings:
 
    #+BEGIN_SRC emacs-lisp
      (global-set-key (kbd "C-c +") 'evil-numbers/inc-at-pt)
      (global-set-key (kbd "C-c -") 'evil-numbers/dec-at-pt)
+     (global-set-key (kbd "C-c C-+") 'evil-numbers/inc-at-pt-incremental)
+     (global-set-key (kbd "C-c C--") 'evil-numbers/dec-at-pt-incremental)
+   #+END_SRC
+
+   or only in evil's =normal= & =visual= states:
+
+   #+BEGIN_SRC emacs-lisp
+     (evil-define-key '(normal visual) 'global (kbd "C-c +") 'evil-numbers/inc-at-pt)
+     (evil-define-key '(normal visual) 'global (kbd "C-c -") 'evil-numbers/dec-at-pt)
+     (evil-define-key '(normal visual) 'global (kbd "C-c C-+") 'evil-numbers/inc-at-pt-incremental)
+     (evil-define-key '(normal visual) 'global (kbd "C-c C--") 'evil-numbers/dec-at-pt-incremental)
    #+END_SRC
 
-   or only in evil's normal state:
+   Keypad =+= and =-= present an alternative that can be directly bound without shadowing the regular =+= and =-=:
 
    #+BEGIN_SRC emacs-lisp
-    (define-key evil-normal-state-map (kbd "C-c +") 'evil-numbers/inc-at-pt)
-    (define-key evil-normal-state-map (kbd "C-c -") 'evil-numbers/dec-at-pt)
+     (evil-define-key '(normal visual) 'global (kbd "<kp-add>") 'evil-numbers/inc-at-pt)
+     (evil-define-key '(normal visual) 'global (kbd "<kp-subtract>") 'evil-numbers/dec-at-pt)
+     (evil-define-key '(normal visual) 'global (kbd "C-<kp-add>") 'evil-numbers/inc-at-pt-incremental)
+     (evil-define-key '(normal visual) 'global (kbd "C-<kp-subtract>") 'evil-numbers/dec-at-pt-incremental)
    #+END_SRC
 
-   For window system users the keypad =+= and =-= present an alternative that can be
-   directly bound without shadowing the regular =+= and =-=:
+* Install
+
+** Basic Installation
+   Put in =load-path=, =(require 'evil-numbers)= and set key bindings.
+
+** Use Package
+   Assuming you have the =melpa= repository enabled, =use-package= can be used as follows.
 
    #+BEGIN_SRC emacs-lisp
-   (define-key evil-normal-state-map (kbd "<kp-add>") 'evil-numbers/inc-at-pt)
-   (define-key evil-normal-state-map (kbd "<kp-subtract>") 'evil-numbers/dec-at-pt)
+     (use-package evil-numbers)
    #+END_SRC
 
-** Usage
-   Position cursor on literal and play with your numbers!
+* Known Bugs
+  See http://github.com/juliapath/evil-numbers/issues
 
-** Known Bugs
-   See http://github.com/cofi/evil-numbers/issues
+* Similar Packages
+  - [[https://melpa.org/#/mouse-slider-mode][Mouse Slider Package]]
+  - [[https://melpa.org/#/number][Number Package]]
+  - [[https://melpa.org/#/shift-number][Shift Number Package]]
+  - [[https://www.emacswiki.org/emacs/IncrementNumber][Emacs Wiki (Increment Number)]]
 
-** Contributors
-   - Matthew Fidler <[email protected]>
-   - Michael Markert <[email protected]>
+* Contributors
+  - Matthew Fidler <[email protected]>
+  - Michael Markert <[email protected]>
+  - Julia Path <[email protected]>
+  - Campbell Barton <[email protected]>