Add a set of g:pymode_lint_*_symbol options.

kdeldycke · kdeldycke · commit 879e81ab60c0 · 2013-10-07T18:04:39.000+02:00
[Inspired by Syntastic](https://github.com/scrooloose/syntastic/blob/master/plugin/syntastic/signs.vim#L10-L24), this feature allows users to set, in their `~/.vimrc` file, a custom set of error symbols.
diff --git a/AUTHORS b/AUTHORS
@@ -30,3 +30,4 @@ Contributors:
 * Lowe Thiderman (thiderman);
 * Naoya Inada (naoina);
 * Anler Hp (ikame);
+* Kevin Deldycke (kdeldycke);
diff --git a/Changelog.rst b/Changelog.rst
@@ -7,6 +7,7 @@ Changelog
 * Support 'pudb' in breakpoints;
 * Pyrun can now operate on a range of lines, and does not need to save (c) lawrenceakka
 * Update pylama to version 1.5.0
+* Add a set of `g:pymode_lint_*_symbol` options;
 
 ## 2013-05-15 0.6.18
 --------------------
diff --git a/README.rst b/README.rst
@@ -193,6 +193,13 @@ Default values: ::
     " Maximal height of pylint error window
     let g:pymode_lint_maxheight = 6
 
+    " Symbol definition
+    let g:pymode_lint_todo_symbol = 'WW'
+    let g:pymode_lint_comment_symbol = 'CC'
+    let g:pymode_lint_visual_symbol = 'RR'
+    let g:pymode_lint_error_symbol = 'EE'
+    let g:pymode_lint_info_symbol = 'II'
+    let g:pymode_lint_pyflakes_symbol = 'FF'
 
 .. note::
     Pylint options (ex. disable messages) may be defined in ``$HOME/pylint.rc``
diff --git a/autoload/pymode/troubleshooting.vim b/autoload/pymode/troubleshooting.vim
@@ -60,6 +60,12 @@ fun! pymode#troubleshooting#Test() "{{{
             call append('$', 'let pymode_lint_cwindow = ' . string(g:pymode_lint_cwindow))
             call append('$', 'let pymode_lint_message = ' . string(g:pymode_lint_message))
             call append('$', 'let pymode_lint_signs = ' . string(g:pymode_lint_signs))
+            call append('$', 'let pymode_lint_todo_symbol = ' . string(g:pymode_lint_todo_symbol))
+            call append('$', 'let pymode_lint_comment_symbol = ' . string(g:pymode_lint_comment_symbol))
+            call append('$', 'let pymode_lint_visual_symbol = ' . string(g:pymode_lint_visual_symbol))
+            call append('$', 'let pymode_lint_error_symbol = ' . string(g:pymode_lint_error_symbol))
+            call append('$', 'let pymode_lint_info_symbol = ' . string(g:pymode_lint_info_symbol))
+            call append('$', 'let pymode_lint_pyflakes_symbol = ' . string(g:pymode_lint_pyflakes_symbol))
             call append('$', 'let pymode_lint_jump = ' . string(g:pymode_lint_jump))
             call append('$', 'let pymode_lint_hold = ' . string(g:pymode_lint_hold))
             call append('$', 'let pymode_lint_minheight = ' .  string(g:pymode_lint_minheight))
diff --git a/doc/pymode.txt b/doc/pymode.txt
@@ -76,6 +76,18 @@ PythonMode. These options should be set in your vimrc.
 
 |'pymode_lint_signs'|               Place signs
 
+|'pymode_lint_todo_symbol'|         Todo symbol
+
+|'pymode_lint_comment_symbol'|      Comment symbol
+
+|'pymode_lint_visual_symbol'|       Visual symbol
+
+|'pymode_lint_error_symbol'|        Error symbol
+
+|'pymode_lint_info_symbol'|         Info symbol
+
+|'pymode_lint_pyflakes_symbol'|     PyFlakes' info symbol
+
 |'pymode_lint_jump'|                Auto jump to first error
 
 |'pymode_lint_hold'|                Hold cursor in current window
@@ -296,6 +308,49 @@ Default: 1.
 
 If this option is set to 0 then pylint will not place error signs.
 
+------------------------------------------------------------------------------
+                                                     *'pymode_lint_todo_symbol'*
+Values: Symbol for todo signs.
+Default: "WW".
+
+This option sets the symbol to use in the gutter to display todo signs.
+
+------------------------------------------------------------------------------
+                                                  *'pymode_lint_comment_symbol'*
+Values: Symbol for comment signs.
+Default: "CC".
+
+This option sets the symbol to use in the gutter to display comment signs.
+
+------------------------------------------------------------------------------
+                                                   *'pymode_lint_visual_symbol'*
+Values: Symbol for visual signs.
+Default: "RR".
+
+This option sets the symbol to use in the gutter to display visual signs.
+
+------------------------------------------------------------------------------
+                                                    *'pymode_lint_error_symbol'*
+Values: Symbol for error signs.
+Default: "EE".
+
+This option sets the symbol to use in the gutter to display error signs.
+
+------------------------------------------------------------------------------
+                                                     *'pymode_lint_info_symbol'*
+Values: Symbol for info signs.
+Default: "II".
+
+This option sets the symbol to use in the gutter to display info signs.
+
+------------------------------------------------------------------------------
+                                                 *'pymode_lint_pyflakes_symbol'*
+Values: Symbol for PyFlakes' info signs.
+Default: "FF".
+
+This option sets the symbol to use in the gutter to display PyFlakes' info
+signs.
+
 ------------------------------------------------------------------------------
                                                             *'pymode_lint_jump'*
 Values: 0 or 1.
diff --git a/ftplugin/python/init-pymode.vim b/ftplugin/python/init-pymode.vim
@@ -108,16 +108,34 @@ if !pymode#Default("g:pymode_lint", 1) || g:pymode_lint
     " errors ruller, even if there's no errors.
     call pymode#Default("g:pymode_lint_signs_always_visible", 0)
 
+    " OPTION: g:pymode_lint_todo_symbol -- string. Todo symbol.
+    call pymode#Default("g:pymode_lint_todo_symbol", "WW")
+
+    " OPTION: g:pymode_lint_comment_symbol -- string. Comment symbol.
+    call pymode#Default("g:pymode_lint_comment_symbol", "CC")
+
+    " OPTION: g:pymode_lint_visual_symbol -- string. Visual symbol.
+    call pymode#Default("g:pymode_lint_visual_symbol", "RR")
+
+    " OPTION: g:pymode_lint_error_symbol -- string. Error symbol.
+    call pymode#Default("g:pymode_lint_error_symbol", "EE")
+
+    " OPTION: g:pymode_lint_info_symbol -- string. Info symbol.
+    call pymode#Default("g:pymode_lint_info_symbol", "II")
+
+    " OPTION: g:pymode_lint_pyflakes_symbol -- string. PyFlakes' info symbol.
+    call pymode#Default("g:pymode_lint_pyflakes_symbol", "FF")
+
     " OPTION: g:pymode_lint_signs -- bool. Place error signs
     if (!pymode#Default("g:pymode_lint_signs", 1) || g:pymode_lint_signs) && has('signs')
 
         " DESC: Signs definition
-        sign define PymodeW text=WW texthl=Todo
-        sign define PymodeC text=CC texthl=Comment
-        sign define PymodeR text=RR texthl=Visual
-        sign define PymodeE text=EE texthl=Error
-        sign define PymodeI text=II texthl=Info
-        sign define PymodeF text=FF texthl=Info
+        execute 'sign define PymodeW text=' . g:pymode_lint_todo_symbol     . " texthl=Todo"
+        execute 'sign define PymodeC text=' . g:pymode_lint_comment_symbol  . " texthl=Comment"
+        execute 'sign define PymodeR text=' . g:pymode_lint_visual_symbol   . " texthl=Visual"
+        execute 'sign define PymodeE text=' . g:pymode_lint_error_symbol    . " texthl=Error"
+        execute 'sign define PymodeI text=' . g:pymode_lint_info_symbol     . " texthl=Info"
+        execute 'sign define PymodeF text=' . g:pymode_lint_pyflakes_symbol . " texthl=Info"
 
         if !pymode#Default("g:pymode_lint_signs_always_visible", 0) || g:pymode_lint_signs_always_visible
             " Show the sign's ruller if asked for, even it there's no error to show
