From 03c5263757afb6f066a4ec2fbf9faa363af5bf51 Mon Sep 17 00:00:00 2001 From: Kim K Date: Sat, 30 Nov 2019 15:30:58 +0800 Subject: [PATCH] feat: Rename doge#generate#pattern() -> doge#pattern#generate() --- autoload/doge.vim | 13 ++++--------- autoload/doge/{generate.vim => pattern.vim} | 2 +- autoload/doge/token.vim | 2 +- doc/doge.txt | 6 +++--- doc/tags | 2 +- 5 files changed, 10 insertions(+), 15 deletions(-) rename autoload/doge/{generate.vim => pattern.vim} (99%) diff --git a/autoload/doge.vim b/autoload/doge.vim index 1e3a4b3a..f5e761e6 100644 --- a/autoload/doge.vim +++ b/autoload/doge.vim @@ -17,8 +17,6 @@ function! doge#generate(arg) abort \) endif - let l:success = 0 - " Store old search register. let s:oldsearch = @/ @@ -40,15 +38,12 @@ function! doge#generate(arg) abort if exists('b:doge_patterns') for l:pattern in get(b:doge_patterns, b:doge_doc_standard) - if doge#generate#pattern(l:pattern) == v:false + if doge#pattern#generate(l:pattern) == v:false continue - else - let l:success = v:true - endif - if l:success == v:true - call doge#activate() endif - return l:success + + call doge#activate() + return 1 endfor endif endfunction diff --git a/autoload/doge/generate.vim b/autoload/doge/pattern.vim similarity index 99% rename from autoload/doge/generate.vim rename to autoload/doge/pattern.vim index 7e0c9d2e..623ac7e0 100644 --- a/autoload/doge/generate.vim +++ b/autoload/doge/pattern.vim @@ -6,7 +6,7 @@ let s:comment_placeholder = doge#helpers#placeholder() "" " @public " Generates a comment based on a given pattern. -function! doge#generate#pattern(pattern) abort +function! doge#pattern#generate(pattern) abort " Assuming multiline function expressions won't be longer than 15 lines. let l:lines_raw = getline('.', line('.') + 15) let l:lines = map(l:lines_raw, { key, line -> diff --git a/autoload/doge/token.vim b/autoload/doge/token.vim index 05f1dc1e..587cb513 100644 --- a/autoload/doge/token.vim +++ b/autoload/doge/token.vim @@ -91,7 +91,7 @@ function! s:token_replace(tokens, text) abort " For JSDoc we replace the type hints 'typeA | type B' with 'typeA|typeB'. let l:text = substitute(l:text, '\m\s*|\s*', '|', 'g') - " Empty lines will be added to the empty in the doge#generate#pattern() + " Empty lines will be added to the empty in the doge#pattern#generate() " function and to indicate it should be prevented from rendering we have to " add some kind of format. We use a dash '-' as an indication that it should " be removed. diff --git a/doc/doge.txt b/doc/doge.txt index c038abbd..e49d66e1 100644 --- a/doc/doge.txt +++ b/doc/doge.txt @@ -129,9 +129,6 @@ doge#comment#deactivate_when_done() *doge#comment#deactivate_when_done()* and will deactivate doge when there are no more TODO items left. Requires |g:doge_comment_interactive| to be enabled. -doge#generate#pattern({pattern}) *doge#generate#pattern()* - Generates a comment based on a given pattern. - doge#helpers#count({word} [, {lnum_start}, {lnum_end} ]) *doge#helpers#count()* Returns the amount of occurences of a word. @@ -171,6 +168,9 @@ doge#helpers#deepextend() *doge#helpers#deepextend()* doge#indent#add({lnum}, {text}) *doge#indent#add()* Indent a string based on a given line its indent, based on the user setting. +doge#pattern#generate({pattern}) *doge#pattern#generate()* + Generates a comment based on a given pattern. + doge#python#file({path}, {args}) *doge#python#file()* Run a python file using the py[3]file command. diff --git a/doc/tags b/doc/tags index c4295ab1..33cf04ef 100644 --- a/doc/tags +++ b/doc/tags @@ -10,7 +10,6 @@ doge#comment#deactivate_when_done() doge.txt /*doge#comment#deactivate_when_done doge#comment#jump() doge.txt /*doge#comment#jump()* doge#comment#update_interactive_comment_info() doge.txt /*doge#comment#update_interactive_comment_info()* doge#deactivate() doge.txt /*doge#deactivate()* -doge#generate#pattern() doge.txt /*doge#generate#pattern()* doge#generate() doge.txt /*doge#generate()* doge#helpers#count() doge.txt /*doge#helpers#count()* doge#helpers#deepextend() doge.txt /*doge#helpers#deepextend()* @@ -19,6 +18,7 @@ doge#helpers#keyseq() doge.txt /*doge#helpers#keyseq()* doge#helpers#placeholder() doge.txt /*doge#helpers#placeholder()* doge#helpers#trim() doge.txt /*doge#helpers#trim()* doge#indent#add() doge.txt /*doge#indent#add()* +doge#pattern#generate() doge.txt /*doge#pattern#generate()* doge#python#file() doge.txt /*doge#python#file()* doge#token#extract() doge.txt /*doge#token#extract()* doge#token#replace() doge.txt /*doge#token#replace()*