feat: Validate patterns when generating

kkoomen · Nov 29, 2019 · 27df1d3 · 27df1d3
1 parent 7133b70
commit 27df1d3
Show file tree

Hide file tree

Showing 16 changed files with 10 additions and 120 deletions.
diff --git a/autoload/doge.vim b/autoload/doge.vim
@@ -7,6 +7,16 @@ set cpoptions&vim
 "
 " arg: Either a count (0 by default) or a string (empty by default).
 function! doge#generate(arg) abort
+  " Immediately validate if the doc standard is allowed.
+  if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
+    echoerr printf(
+    \  '[DoGe] "%s" is not a valid %s doc standard, available doc standard are: %s',
+    \  b:doge_doc_standard,
+    \  &filetype,
+    \  join(b:doge_supported_doc_standards, ', ')
+    \)
+  endif
+
   let l:success = 0
 
   " Store old search register.

diff --git a/ftplugin/c.vim b/ftplugin/c.vim
@@ -24,14 +24,6 @@ let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards([
       \ 'kernel_doc'
       \ ])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('c')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid C doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/coffee.vim b/ftplugin/coffee.vim
@@ -12,14 +12,6 @@ let b:doge_pattern_multi_line_comment = '\m###.\{-}###'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['jsdoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('coffee')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid CoffeeScript doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/cpp.vim b/ftplugin/cpp.vim
@@ -17,14 +17,6 @@ let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards([
       \ 'doxygen_qt_no_asterisk',
       \ ])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('cpp')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid C++ doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/groovy.vim b/ftplugin/groovy.vim
@@ -13,14 +13,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['javadoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('groovy')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Groovy doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/java.vim b/ftplugin/java.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['javadoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('java')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Java doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/javascript.vim b/ftplugin/javascript.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['jsdoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('javascript')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid JavaScript doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/kotlin.vim b/ftplugin/kotlin.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['kdoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('kotlin')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Kotlin doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/lua.vim b/ftplugin/lua.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m--\+[[.\{-}]]--\+'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['ldoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('lua')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Lua doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/php.vim b/ftplugin/php.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['phpdoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('php')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid PHP doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/python.vim b/ftplugin/python.vim
@@ -19,14 +19,6 @@ let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards([
       \ 'sphinx',
       \ ])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('python')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-        \ '[DoGe] %s is not a valid Python doc standard, available doc standard are: %s',
-        \ b:doge_doc_standard,
-        \ join(b:doge_supported_doc_standards, ', ')
-        \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/r.vim b/ftplugin/r.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m#.\{-}$'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['roxygen2'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('r')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid R doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/ruby.vim b/ftplugin/ruby.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\(=begin.\{-}=end\|<<-DOC.\{-}DOC\)'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['YARD'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('ruby')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Ruby doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/scala.vim b/ftplugin/scala.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['scaladoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('scala')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Scala doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/sh.vim b/ftplugin/sh.vim
@@ -11,14 +11,6 @@ let b:doge_pattern_multi_line_comment = '\m#.\{-}$'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['google'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('sh')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid Shell doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================

diff --git a/ftplugin/typescript.vim b/ftplugin/typescript.vim
@@ -14,14 +14,6 @@ let b:doge_pattern_multi_line_comment = '\m\/\*.\{-}\*\/'
 
 let b:doge_supported_doc_standards = doge#buffer#get_supported_doc_standards(['jsdoc'])
 let b:doge_doc_standard = doge#buffer#get_doc_standard('typescript')
-if index(b:doge_supported_doc_standards, b:doge_doc_standard) < 0
-  echoerr printf(
-  \ '[DoGe] %s is not a valid TypeScript doc standard, available doc standard are: %s',
-  \ b:doge_doc_standard,
-  \ join(b:doge_supported_doc_standards, ', ')
-  \ )
-endif
-
 let b:doge_patterns = doge#buffer#get_patterns()
 
 " ==============================================================================