Skip to content

Commit

Permalink
Merge pull request #10 from lambdalisue/recommend-magic
Browse files Browse the repository at this point in the history
`\m` を前置するようにドキュメント誘導
  • Loading branch information
lambdalisue authored Feb 22, 2023
2 parents f946811 + 8a3f68d commit a2550ea
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const pattern = await denops.dispatch("kensaku", "query", "kensaku");

```vim
function! Search(value) abort
let @/ = a:value
let @/ = '\m' .. a:value
normal! n
endfunction
Expand All @@ -83,14 +83,13 @@ call Search(kensaku#query('kensaku'))

```vim
function! Search(value) abort
let @/ = a:value
let @/ = '\m' .. a:value
normal! n
endfunction
call kensaku#query_async(
\ 'kensaku',
\ { v -> Search(v) },
\)
call kensaku#query_async('kensaku', {
\ 'failure': { v -> Search(v) },
\})
```

## v2 との違い
Expand All @@ -99,8 +98,9 @@ Kensaku [v2](https://github.com/lambdalisue/kensaku.vim/tree/v2) までは
`kensaku#query()` などで返す正規表現は JavaScript のものだったため `\v`
を前置することで Very magic を指定する必要がありました。 Kensaku v3 からは
`kensaku#query()` は Vim script の正規表現を返すように変更されたので `\v`
の前置が不要になりました。 なおプラグイン作者などが利用する `denops.dispatch()`
経由での呼び出しは依然として JavaScript の正規表現を返します。
の代わりに `\m` を前置します。 なおプラグイン作者などが利用する
`denops.dispatch()` 経由での呼び出しは依然として JavaScript
の正規表現を返します。

## 参考情報

Expand Down
2 changes: 1 addition & 1 deletion autoload/kensaku.vim
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
function! kensaku#query(value) abort
function! kensaku#query(value, ...) abort
if denops#plugin#wait('kensaku') isnot# 0
return ''
endif
Expand Down
4 changes: 2 additions & 2 deletions doc/kensaku.jax
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ kensaku#query({value}[, {option}])
{value} をローマ字として解釈し、検索するための正規表現を返します。
>
function! Search(value) abort
let @/ = a:value
let @/ = '\m' .. a:value
normal! n
endfunction
Expand Down Expand Up @@ -124,7 +124,7 @@ kensaku#query_async({value}, {success}[, {option}])
"failure" エラー時に呼ばれるコールバック関数です。
>
function! Search(value) abort
let @/ = a:value
let @/ = '\m' .. a:value
normal! n
endfunction
Expand Down
2 changes: 1 addition & 1 deletion plugin/kensaku.vim
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ call s:define(
if !exists('g:kensaku_disable_v3_migration_warning')
echohl WarningMsg
echomsg '[kensaku] BREAKING CHANGES:'
echomsg '[kensaku] Kensaku v3 returns Vim script regex from `kensaku#query()` function so users no longer need to prepend `\v` (very magic).'
echomsg '[kensaku] Kensaku v3 returns Vim script regex from `kensaku#query()` function so users need to prepend `\m` instead of `\m`.'
echomsg '[kensaku] Additionally, Optional arguments of `kensaku#query_async()` has slightly changed. See help for more detail.'
echomsg '[kensaku] Disable this message by `let g:kensaku_disable_v3_migration_warning = 1` or wait until the next release.'
echohl None
Expand Down

0 comments on commit a2550ea

Please sign in to comment.