Add rc/auto-pairs #1295

alexherbo2 · 2017-03-24T18:20:09Z

Usage

hook global WinCreate .* %{
  auto-pairs-enable
}

map global user s :auto-pairs-surround<ret>

Status line integration

set global modelinefmt '… %opt(block_auto_pairs) …'

decl str block_auto_pairs

def -hidden block-update-auto-pairs %{ %sh{
  if [ $kak_opt_auto_pairs_surround_enabled = true ]; then
    text=surround
  else
    text="''"
  fi
  echo set window block_auto_pairs $text
}}

hook global WinCreate .* %{
  hook window InsertBegin .* block-update-auto-pairs
  hook window NormalBegin .* block-update-auto-pairs
}

Commands

auto-pairs-enable: enable automatic closing of pairs
auto-pairs-disable: disable automatic closing of pairs
auto-pairs-toggle: toggle automatic closing of pairs
auto-pairs-surround: enable automatic closing of pairs on selection boundaries for the whole insert session

Options

auto_pairs str-list: list of pairs (default: (,):{,}:[,]:<,>:",":',':<grave-quote>,<grave-quote>)
auto_pairs_enabled bool: information about the way auto-pairs is active (read-only)
auto_pairs_surround_enabled bool: information about the way auto-pairs-surround is active (read-only)

srghma · 2017-03-24T18:25:37Z

@alexherbo2 , wow, it's like Christmas, thank you so much

lenormf · 2017-03-24T18:38:55Z

I don't think this belongs in the upstream repository, it's better off as an extra script.

lenormf · 2017-03-25T11:44:38Z

rc/base/auto-pairs.kak

+def -hidden auto-pairs-insert-backspace %{
+  try %{
+    %sh{
+      regex='\Q'$(echo "$kak_opt_auto_pairs" | sed s/:/'\\E|\\Q'/g';'s/,//g)


I think it would be wiser to use printf '%s\n' with arbitrary strings. Same remark for the following calls to echo.

lenormf · 2017-03-25T11:45:26Z

rc/base/auto-pairs.kak

+  %sh{
+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do
+      opener=$(echo $pair | cut --delimiter , --fields 1)
+      closer=$(echo $pair | cut --delimiter , --fields 2)


Long options are not defined by the standard, we better use -d and -f here. Same remark for the following calls.

alexherbo2 · 2017-03-29T17:08:50Z

I added some fixes that @casimir pointed out, notably his trick to preserve the selections

alexherbo2 · 2017-03-29T19:49:31Z

I changed the whole implementation to use hooks instead of maps

alexherbo2 · 2017-03-29T21:05:54Z

I added basic support for quotes

danr · 2017-03-30T08:49:54Z

Surely there should be some tests for this feature and PR?

casimir · 2017-03-30T10:51:52Z

Long options for fold and tail are GNU-specific and don't work on macOS.

alexherbo2 · 2017-03-30T11:06:49Z

@casimir Does it work for you now?

alexherbo2 · 2017-03-30T11:20:52Z

Following our discussion on IRC, 😺 @mawww added InsertDelete hook, so we can get rid of <backspace> mapping now.

casimir · 2017-03-30T12:03:17Z

It works now but I get a weird selection when I insert a pair, one char to the right.

alexherbo2 · 2017-03-30T12:25:29Z

@danr Done :)

srghma · 2017-03-30T17:30:18Z

I love it, I love it very much))
One more feature that seems for me indispensable is (from auto-pairs)

Insert new indented line after Return

input: {|} (press <CR> at |)
output: {
    |
}

srghma · 2017-03-30T17:31:22Z

And I think Insert spaces before closing characters, only for [], (), {} would be nice to have too

alexherbo2 · 2017-03-30T20:25:22Z

@BjornMelgaard Done :)

alexherbo2 · 2017-03-30T20:27:11Z

Not polished yet though

srghma · 2017-04-02T12:04:46Z

error running hook InsertChar( )/auto-pairs-insert: 1:1: 'auto-pairs-insert-space' 1:1: 'exec' no selections remaining
recursive call of hook InsertChar/
, not executing

Also waiting for implementation of idea that you told )

alexherbo2 · 2017-04-10T12:32:32Z

@BjornMelgaard I think the surround functionality could be superseded by the auto-pairs, using the selection set plus normal insertion

srghma · 2017-04-10T15:53:55Z

@alexherbo2 yeah, I'm looking forward to it)

alexherbo2 · 2017-05-29T17:05:11Z

@BjornMelgaard I added the surround functionality

To use, craft your selections then execute :auto-pairs-surround command to enable automatic closing of pairs on selection boundaries for the whole insert session.

srghma · 2017-05-29T17:06:59Z

@alexherbo2 finnaly, I will look at it right now )

alexherbo2 · 2017-05-30T22:28:12Z

@mawww I think the plug-in is ready to merge now.

Here is a recap on how to use it.

hook global WinCreate .* %{
  auto-pairs-enable
}

map global user s :auto-pairs-surround<ret>

Delapouite · 2017-06-01T10:35:35Z

This script is nice! Thanks to everyone involved.

May I suggest a few additions?

auto-pairs-toggle: to easily switch between auto-pairs-enable <-> auto-pairs-disable
auto-pairs-enabled readonly boolean option. This way in modelinefmt, one could display %opt{auto-pairs-enabled} as a visual signal that auto-pairs is currently active.
auto-pairs-surround-enabled same as above.

Delapouite · 2017-06-01T10:39:29Z

Also a minor observation.

There are currently autowrap and autorestore scripts. Should this script be renamed autopairs (without the dash) to be consistent with previous commands?
This difference in the naming convention is mainly visible while using the fuzzy finder.

lenormf · 2017-06-01T10:43:37Z

rc/base/auto-pairs.kak

+def -hidden auto-pairs-insert-new-line %{ try %{
+  %sh{
+    regex=$(printf '\Q%s\E' "$kak_opt_auto_pairs" | sed s/:/'\\E|\\Q'/g';'s/'<,>'/'<lt>,<gt>'/g';'s/,/'\\E\\n\\h*\\Q'/g)
+    echo "exec -draft %(;KGl<a-k>$regex<ret>)"


Since the $regex variable contains backslashes, passing this string to echo is risky, better use printf.

alexherbo2 · 2017-06-01T13:58:50Z

@Delapouite I added the toggle command.

Commands:

auto-pairs-toggle

Options:

auto_pairs_enabled
auto_pairs_surround_enabled

And for the name, I prefer real word command / option names (#806).

alexherbo2 · 2017-06-10T13:23:10Z

Some tests were failing due to not being POSIX.

I fixed them thanks to @lenormf.

Delapouite · 2017-06-16T13:40:53Z

Threre seems to be an issue remaining on the auto_pairs_was_enabled bool.

Here's what I observed:

:auto-pairs-toggle
:auto-pairs-surround
<esc>
echo %opt{auto_pairs_enabled}
-> false

lenormf · 2017-06-10T12:16:01Z

rc/base/auto-pairs.kak

+
+def -hidden -params 2 auto-pairs-insert-opener %{ try %{
+  %sh{
+    if [ $1 = $2 ]; then


Needs quotes around expansions.

lenormf · 2017-06-10T12:16:31Z

rc/base/auto-pairs.kak

+def -hidden auto-pairs-delete-new-line %{ try %{
+  %sh{
+    regex=$(printf '\Q%s\E' "$kak_opt_auto_pairs" | sed s/:/'\\E|\\Q'/g';'s/'<,>'/'<lt>,<gt>'/g';'s/,/'\\E\\n\\h*\\Q'/g)
+    echo "exec -draft %(;JGi<a-k>$regex<ret>)"


printf is better here.

lenormf · 2017-06-10T12:16:36Z

rc/base/auto-pairs.kak

+def -hidden auto-pairs-insert-space %{ try %{
+  %sh{
+    regex=$(printf '\Q%s\E' "$kak_opt_auto_pairs" | sed s/:/'\\E|\\Q'/g';'s/'<,>'/'<lt>,<gt>'/g';'s/,/'\\E\\h\\Q'/g)
+    echo "exec -draft %(;2H<a-k>$regex<ret>)"


printf is better here.

lenormf · 2017-06-10T12:16:39Z

rc/base/auto-pairs.kak

+def -hidden auto-pairs-delete-space %{ try %{
+  %sh{
+    regex=$(printf '\Q%s\E' "$kak_opt_auto_pairs" | sed s/:/'\\E|\\Q'/g';'s/'<,>'/'<lt>,<gt>'/g';'s/,/'\\E\\h\\Q'/g)
+    echo "exec -draft %(;l2H<a-k>$regex<ret>)"


printf is better here.

lenormf · 2017-06-10T12:16:45Z

rc/base/auto-pairs.kak

+def auto-pairs-enable -docstring 'Enable automatic closing of pairs' %{
+  %sh{
+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do
+      opener=$(echo $pair | cut -d , -f 1)


printf is better here, also quotes around the expansion.

lenormf · 2017-06-10T12:17:40Z

rc/base/auto-pairs.kak

+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do
+      opener=$(echo $pair | cut -d , -f 1)
+      closer=$(echo $pair | cut -d , -f 2)
+      echo "hook window InsertChar \Q$opener -group auto-pairs-insert %(auto-pairs-insert-opener %-$opener- %-$closer-)"


printf is better here.

lenormf · 2017-06-10T12:17:57Z

rc/base/auto-pairs.kak

+
+def auto-pairs-surround -docstring 'Enable automatic closing of pairs on selection boundaries for the whole insert session' %{
+  %sh{
+    if [ $kak_opt_auto_pairs_enabled = yes ]; then


Needs quotes around expansions.

lenormf · 2017-06-10T12:18:05Z

rc/base/auto-pairs.kak

+    else
+      echo set window auto_pairs_was_enabled no
+    fi
+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do


printf is better here.

lenormf · 2017-06-10T12:18:16Z

rc/base/auto-pairs.kak

+      echo set window auto_pairs_was_enabled no
+    fi
+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do
+      opener=$(echo $pair | cut -d , -f 1)


printf is better here, also quotes around the expansion.

lenormf · 2017-06-10T12:18:19Z

rc/base/auto-pairs.kak

+    fi
+    for pair in $(echo "$kak_opt_auto_pairs" | tr : '\n'); do
+      opener=$(echo $pair | cut -d , -f 1)
+      closer=$(echo $pair | cut -d , -f 2)


printf is better here, also quotes around the expansion.

alexherbo2 · 2017-06-16T14:37:38Z

@Delapouite I can reproduce, but I did not isolate the bug yet.

@lenormf I added the POSIX changes you requested.

Delapouite

I think I found the issues:

a echo was missign from a %sh{} block
internally kakoune turn yes/no booleans into true/false booleans. So it has undesirable effects when comparing yes with a true.

So I would recommend to never use yes/no booleans, and always sticks with good ol' true/false

Delapouite · 2017-06-16T15:21:21Z

rc/base/auto-pairs.kak

+  hook window InsertEnd .* -group auto-pairs-surround-insert-end %{
+    %sh{
+      if [ "$kak_opt_auto_pairs_was_enabled" = yes ]; then
+        auto-pairs-enable


missing echo

Delapouite · 2017-06-16T15:21:54Z

rc/base/auto-pairs.kak

@@ -0,0 +1,131 @@
+decl str-list auto_pairs %((,):{,}:[,]:<,>:",":',':`,`)
+decl bool auto_pairs_enabled no


use false for this 3 booleans

Delapouite · 2017-06-16T15:22:18Z

rc/base/auto-pairs.kak

+  hook window InsertDelete \n -group auto-pairs-delete auto-pairs-delete-new-line
+  hook window InsertChar \h -group auto-pairs-insert auto-pairs-insert-space
+  hook window InsertDelete \h -group auto-pairs-delete auto-pairs-delete-space
+  set window auto_pairs_enabled yes


Delapouite · 2017-06-16T15:22:24Z

rc/base/auto-pairs.kak

+}
+
+def auto-pairs-toggle -docstring 'Toggle automatic closing of pairs' %{ %sh{
+  if [ "$kak_opt_auto_pairs_enabled" = yes ]; then


Delapouite · 2017-06-16T15:22:30Z

rc/base/auto-pairs.kak

+
+def auto-pairs-surround -docstring 'Enable automatic closing of pairs on selection boundaries for the whole insert session' %{
+  %sh{
+    if [ "$kak_opt_auto_pairs_enabled" = yes ]; then


Delapouite · 2017-06-16T15:22:46Z

rc/base/auto-pairs.kak

+  }
+  hook window InsertEnd .* -group auto-pairs-surround-insert-end %{
+    %sh{
+      if [ "$kak_opt_auto_pairs_was_enabled" = yes ]; then


Delapouite · 2017-06-16T15:23:06Z

rc/base/auto-pairs.kak

+def auto-pairs-disable -docstring 'Disable automatic closing of pairs' %{
+  remove-hooks window auto-pairs-insert
+  remove-hooks window auto-pairs-delete
+  set window auto_pairs_enabled no


use false

Delapouite · 2017-06-16T15:23:45Z

rc/base/auto-pairs.kak

+    remove-hooks window auto-pairs-surround-insert
+    remove-hooks window auto-pairs-surround-delete
+    remove-hooks window auto-pairs-surround-insert-end
+    set window auto_pairs_surround_enabled no


use false

Delapouite · 2017-06-16T15:23:46Z

rc/base/auto-pairs.kak

+    set window auto_pairs_surround_enabled no
+  }
+  auto-pairs-disable
+  set window auto_pairs_surround_enabled yes


Delapouite · 2017-06-16T15:23:55Z

rc/base/auto-pairs.kak

+    if [ "$kak_opt_auto_pairs_enabled" = yes ]; then
+      echo set window auto_pairs_was_enabled yes
+    else
+      echo set window auto_pairs_was_enabled no


use false

lenormf · 2017-06-16T17:03:27Z

This is a bit drastic, all that needs to be done is compare the shell boolean variables to true, the rest can still use yes/no/true/false.

alexherbo2 · 2017-06-16T17:30:12Z

@Delapouite Thanks!

Delapouite · 2017-06-16T17:33:02Z

This is a bit drastic

Well, as in other languages like YAML or Coffeescript, which support similar booleans niceties, it turns out to be source of errors (plainly demonstrated here) for no real benefits in term of lisibility or human confort.

alexherbo2 · 2017-06-16T17:58:49Z

Boolean niceties are not a problem in general, but you’re right in the case of Kakoune, because it targets POSIX shell which has no boolean type.

alexherbo2 · 2017-06-16T18:00:06Z

@Delapouite Did you mind opening an issue on that?

alexherbo2 · 2017-06-24T14:30:27Z

https://github.com/alexherbo2/auto-pairs.kak

alexherbo2 · 2017-06-26T09:57:02Z

#1333 (comment)

lenormf · 2017-06-26T10:12:11Z

Reviving #561 eh?

alexherbo2 · 2017-06-26T11:40:11Z

I still not fond of decentralizing a whole repository, like kakoune-extra.

But cherry-picking an extension to have a life on his own.

alexherbo2 mentioned this pull request Mar 24, 2017

Auto-pairs functionality #1284

Closed

lenormf suggested changes Mar 25, 2017

View reviewed changes

alexherbo2 mentioned this pull request May 30, 2017

Add vim-surround-like feature #1025

Closed

lenormf reviewed Jun 1, 2017

View reviewed changes

alexherbo2 changed the title ~~add rc/auto-pairs.kak~~ Add rc/auto-pairs Jun 8, 2017

lenormf suggested changes Jun 16, 2017

View reviewed changes

Delapouite suggested changes Jun 16, 2017

View reviewed changes

Add rc/auto-pairs

012cd32

alexherbo2 closed this Jun 24, 2017

alexherbo2 deleted the rc-auto-pairs branch June 24, 2017 14:30

		@@ -0,0 +1,131 @@
		decl str-list auto_pairs %((,):{,}:[,]:<,>:",":',':`,`)
		decl bool auto_pairs_enabled no

Add rc/auto-pairs #1295

Add rc/auto-pairs #1295

Conversation

alexherbo2 commented Mar 24, 2017 • edited

Usage

Status line integration

Commands

Options

srghma commented Mar 24, 2017 • edited

lenormf commented Mar 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexherbo2 commented Mar 29, 2017

alexherbo2 commented Mar 29, 2017

alexherbo2 commented Mar 29, 2017

danr commented Mar 30, 2017

casimir commented Mar 30, 2017 • edited

alexherbo2 commented Mar 30, 2017

alexherbo2 commented Mar 30, 2017

casimir commented Mar 30, 2017

alexherbo2 commented Mar 30, 2017

srghma commented Mar 30, 2017

srghma commented Mar 30, 2017

alexherbo2 commented Mar 30, 2017

alexherbo2 commented Mar 30, 2017

srghma commented Apr 2, 2017 • edited

alexherbo2 commented Apr 10, 2017

srghma commented Apr 10, 2017

alexherbo2 commented May 29, 2017

srghma commented May 29, 2017

alexherbo2 commented May 30, 2017

Delapouite commented Jun 1, 2017 • edited

Delapouite commented Jun 1, 2017

Choose a reason for hiding this comment

alexherbo2 commented Jun 1, 2017

alexherbo2 commented Jun 10, 2017

Delapouite commented Jun 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexherbo2 commented Jun 16, 2017

Delapouite left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lenormf commented Jun 16, 2017

alexherbo2 commented Jun 16, 2017

Delapouite commented Jun 16, 2017

alexherbo2 commented Jun 16, 2017

alexherbo2 commented Jun 16, 2017

alexherbo2 commented Jun 24, 2017

alexherbo2 commented Jun 26, 2017

lenormf commented Jun 26, 2017

alexherbo2 commented Jun 26, 2017

alexherbo2 commented Mar 24, 2017 •

edited

srghma commented Mar 24, 2017 •

edited

casimir commented Mar 30, 2017 •

edited

srghma commented Apr 2, 2017 •

edited

Delapouite commented Jun 1, 2017 •

edited