Skip to content

Commit 3d7e091

Browse files
committed
Bump version + minor updates for Awk, Shell & TCL support
1 parent bf32f32 commit 3d7e091

File tree

3 files changed

+32
-21
lines changed

3 files changed

+32
-21
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ There's just one problem: You have to manually keep your tags files up-to-date a
1010

1111
Unzip the most recent [ZIP archive] [download] file inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). Now try it out: Edit any file type supported by Exuberant Ctags and within ten seconds the plug-in should create/update your tags file (`~/.vimtags` on UNIX, `~/_vimtags` on Windows) with the tags defined in the file you just edited! This means that whatever file you're editing in Vim (as long as it's on the local file system), tags will always be available by the time you need them!
1212

13-
Additionally if the file you just opened is a C, C++, Objective-C, Java, Lua, Python, PHP, Ruby or Vim source file you should also notice that the function and type names defined in the file have been syntax highlighted.
13+
Additionally if the file you just opened is an AWK, C#, C, C++, Objective-C, Java, Lua, PHP, Python, Ruby, Shell, Tcl or Vim source file you should also notice that the function and type names defined in the file have been syntax highlighted.
1414

1515
The `easytags.vim` plug-in is intended to work automatically once it's installed, but if you want to change how it works there are several options you can change and commands you can execute from your own mappings and/or automatic commands. These are all documented below.
1616

@@ -175,14 +175,17 @@ This option defines the pathname of the script that contains the Python implemen
175175

176176
The easytags plug-in defines new highlighting groups for dynamically highlighted tags. These groups are linked to Vim's default groups so that they're colored out of the box, but if you want you can change the styles. To do so use a `highlight` command such as the ones given a few paragraphs back. Of course you'll need to change the group name. Here are the group names used by the easytags plug-in:
177177

178+
* **AWK**: `awkFunctionTag`
179+
* **C#:** `csClassOrStructTag`, `csMethodTag`
180+
* **C, C++, Objective C:** `cTypeTag`, `cEnumTag`, `cPreProcTag`, `cFunctionTag`, `cMemberTag`
181+
* **Java:** `javaClassTag`, `javaMethodTag`
178182
* **Lua:** `luaFuncTag`
179-
* **C:** `cTypeTag`, `cEnumTag`, `cPreProcTag`, `cFunctionTag`, `cMemberTag`
180183
* **PHP:** `phpFunctionsTag`, `phpClassesTag`
181-
* **Vim:** `vimAutoGroupTag`, `vimCommandTag`, `vimFuncNameTag`, `vimScriptFuncNameTag`
182184
* **Python:** `pythonFunctionTag`, `pythonMethodTag`, `pythonClassTag`
183-
* **Java:** `javaClassTag`, `javaMethodTag`
184-
* **C#:** `csClassOrStructTag`, `csMethodTag`
185185
* **Ruby:** `rubyModuleNameTag`, `rubyClassNameTag`, `rubyMethodNameTag`
186+
* **Shell**: `shFunctionTag`
187+
* **Tcl**: `tclCommandTag`
188+
* **Vim:** `vimAutoGroupTag`, `vimCommandTag`, `vimFuncNameTag`, `vimScriptFuncNameTag`
186189

187190
As you can see each of these names ends in `Tag` to avoid conflicts with the syntax modes shipped with Vim. And about the singular/plural confusion: I've tried to match the existing highlighting groups defined by popular syntax modes (except of course for the `Tag` suffix).
188191

autoload/xolox/easytags.vim

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
" Vim script
22
" Author: Peter Odding <peter@peterodding.com>
3-
" Last Change: September 27, 2011
3+
" Last Change: October 1, 2011
44
" URL: http://peterodding.com/code/vim/easytags/
55

6-
let g:xolox#easytags#version = '2.6.1'
6+
let g:xolox#easytags#version = '2.7'
77

88
" Public interface through (automatic) commands. {{{1
99

@@ -889,7 +889,7 @@ highlight def link rubyMethodName Function
889889
call xolox#easytags#define_tagkind({
890890
\ 'filetype': 'awk',
891891
\ 'hlgroup': 'awkFunctionTag',
892-
\ 'tagkinds': '[f]'})
892+
\ 'tagkinds': 'f'})
893893

894894
highlight def link awkFunctionTag Function
895895

@@ -898,7 +898,7 @@ highlight def link awkFunctionTag Function
898898
call xolox#easytags#define_tagkind({
899899
\ 'filetype': 'sh',
900900
\ 'hlgroup': 'shFunctionTag',
901-
\ 'tagkinds': '[f]'})
901+
\ 'tagkinds': 'f'})
902902

903903
highlight def link shFunctionTag Operator
904904

@@ -907,7 +907,7 @@ highlight def link shFunctionTag Operator
907907
call xolox#easytags#define_tagkind({
908908
\ 'filetype': 'tcl',
909909
\ 'hlgroup': 'tclCommandTag',
910-
\ 'tagkinds': '[p]'})
910+
\ 'tagkinds': 'p'})
911911

912912
highlight def link tclCommandTag Operator
913913

doc/easytags.txt

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@ with the tags defined in the file you just edited! This means that whatever
3535
file you're editing in Vim (as long as it's on the local file system), tags
3636
will always be available by the time you need them!
3737

38-
Additionally if the file you just opened is a C, C++, Objective-C, Java, Lua,
39-
Python, PHP, Ruby or Vim source file you should also notice that the function
40-
and type names defined in the file have been syntax highlighted.
38+
Additionally if the file you just opened is an AWK, C#, C, C++, Objective-C,
39+
Java, Lua, PHP, Python, Ruby, Shell, Tcl or Vim source file you should also
40+
notice that the function and type names defined in the file have been syntax
41+
highlighted.
4142

4243
The 'easytags.vim' plug-in is intended to work automatically once it's
4344
installed, but if you want to change how it works there are several options
@@ -352,23 +353,30 @@ do so use a 'highlight' command such as the ones given a few paragraphs back.
352353
Of course you'll need to change the group name. Here are the group names used
353354
by the easytags plug-in:
354355

355-
- Lua: 'luaFuncTag'
356+
- AWK: 'awkFunctionTag'
356357

357-
- C: 'cTypeTag', 'cEnumTag', 'cPreProcTag', 'cFunctionTag', 'cMemberTag'
358+
- C#: 'csClassOrStructTag', 'csMethodTag'
358359

359-
- PHP: 'phpFunctionsTag', 'phpClassesTag'
360+
- C, C++, Objective C: 'cTypeTag', 'cEnumTag', 'cPreProcTag', 'cFunctionTag',
361+
'cMemberTag'
360362

361-
- Vim: 'vimAutoGroupTag', 'vimCommandTag', 'vimFuncNameTag',
362-
'vimScriptFuncNameTag'
363+
- Java: 'javaClassTag', 'javaMethodTag'
363364

364-
- Python: 'pythonFunctionTag', 'pythonMethodTag', 'pythonClassTag'
365+
- Lua: 'luaFuncTag'
365366

366-
- Java: 'javaClassTag', 'javaMethodTag'
367+
- PHP: 'phpFunctionsTag', 'phpClassesTag'
367368

368-
- C#: 'csClassOrStructTag', 'csMethodTag'
369+
- Python: 'pythonFunctionTag', 'pythonMethodTag', 'pythonClassTag'
369370

370371
- Ruby: 'rubyModuleNameTag', 'rubyClassNameTag', 'rubyMethodNameTag'
371372

373+
- Shell: 'shFunctionTag'
374+
375+
- Tcl: 'tclCommandTag'
376+
377+
- Vim: 'vimAutoGroupTag', 'vimCommandTag', 'vimFuncNameTag',
378+
'vimScriptFuncNameTag'
379+
372380
As you can see each of these names ends in 'Tag' to avoid conflicts with the
373381
syntax modes shipped with Vim. And about the singular/plural confusion: I've
374382
tried to match the existing highlighting groups defined by popular syntax

0 commit comments

Comments
 (0)