|
1 | 1 | // Place your settings in the file "User/CTags.sublime-settings", which
|
2 | 2 | // overrides the settings in here.
|
3 | 3 | {
|
4 |
| - // Enable debugging |
| 4 | + // Enable debugging. |
| 5 | + // |
| 6 | + // When enabled, this will result in debug output being printed to the |
| 7 | + // console. This can be useful for debugging issues. |
5 | 8 | "debug": false,
|
6 | 9 |
|
7 |
| - // Enable autocomplete |
| 10 | + // Enable auto-complete. |
| 11 | + // |
| 12 | + // When enabled, this turns on a basic "auto-complete" feature, similar to |
| 13 | + // a very rudimentary "Intellisense(TM)". This is useful for providing |
| 14 | + // better suggestions than stock Sublime Text could provide. |
8 | 15 | "autocomplete": false,
|
9 | 16 |
|
| 17 | + // Path to ctags executable. |
| 18 | + // |
10 | 19 | // Alter this value if your ctags command is not in the PATH, or if using
|
11 | 20 | // a different version of ctags to that in the path (i.e. for OSX).
|
12 | 21 | //
|
13 | 22 | // NOTE: You *should not* place entire commands here. These commands are
|
14 |
| - // built automatically using the values below. For example: |
15 |
| - // GOOD: "command": "/usr/bin/ctags" |
16 |
| - // BAD: "command": "ctags -R -f .tags --exclude=some/path" |
| 23 | + // built automatically using the values below. For example, this is OK: |
| 24 | + // |
| 25 | + // "command": "/usr/bin/ctags" |
| 26 | + // |
| 27 | + // This, on the other hand, won't work! |
| 28 | + // |
| 29 | + // "command": "ctags -R -f .tags --exclude=some/path" |
| 30 | + // |
17 | 31 | "command": "",
|
18 | 32 |
|
19 |
| - // Set to false to disable recursive search for ctag generation. This |
20 |
| - // translates the `-R` parameter |
| 33 | + // Enable recursive searching of directories when building tag files. |
| 34 | + // |
| 35 | + // When enabled, this is equivalent to `-R` parameter. Set to true to |
| 36 | + // enable recursive search of directories when generating tag files. |
21 | 37 | "recursive" : true,
|
22 | 38 |
|
23 |
| - // Default read/write location of the tags file. This translates to the |
24 |
| - // `-f [FILENAME]` parameter |
| 39 | + // Default read/write location of the tags file. |
| 40 | + // |
| 41 | + // This is equivalent to the `-f [FILENAME]` parameter. There is likely no |
| 42 | + // reason to change this unless you have a large number of existing tags |
| 43 | + // files you'd like to use that already have a different name. In this |
| 44 | + // case perhaps consider using the 'extra_tag_files' setting instead. |
25 | 45 | "tag_file" : ".tags",
|
26 | 46 |
|
27 |
| - // Additional options to pass to ctags, i.e. |
28 |
| - // ["--exclude=some/path", "--exclude=some/other/path", ...] |
| 47 | + // Additional tag files names to search. |
| 48 | + // |
| 49 | + // These are searched in addition to the file name given in 'tag_file' |
| 50 | + "extra_tag_files": [".gemtags", "tags"], |
| 51 | + |
| 52 | + // Additional options to pass to ctags. |
| 53 | + // |
| 54 | + // Any addition options you may wish to pass to the ctags executable. For |
| 55 | + // example: |
| 56 | + // |
| 57 | + // ["--exclude=some/path", "--exclude=some/other/path", ...] |
29 | 58 | "opts" : [],
|
30 | 59 |
|
| 60 | + // Tag "kind"s to ignore. |
| 61 | + // |
| 62 | + // A ctags tagfile describes a number of different "kind"s, described in |
| 63 | + // tag FORMAT file found here: |
| 64 | + // |
| 65 | + // http://ctags.sourceforge.net/FORMAT |
| 66 | + // |
| 67 | + // These can be filtered (i.e. ignored). For example - 'import' statements |
| 68 | + // should be ignored in Python. These are of kind "i", e.g. |
| 69 | + // |
| 70 | + // "type":"^i$" |
31 | 71 | //
|
32 | 72 | "filters": {
|
33 | 73 | "source.python": {"type":"^i$"}
|
34 | 74 | },
|
35 | 75 |
|
| 76 | + // Definition "kind"s to ignore. |
36 | 77 | //
|
| 78 | + // This is very similar to the 'filters' option. However, this only |
| 79 | + // applies to the process that is used to find a definition. All filters |
| 80 | + // placed here will be used when the plugin is searching for a definition |
| 81 | + // in the file. |
37 | 82 | "definition_filters": {
|
38 | 83 | "source.php": {"type":"^v$"}
|
39 | 84 | },
|
40 | 85 |
|
| 86 | + // Enable the ctags menu in the context menus. |
| 87 | + "show_context_menus": true, |
| 88 | + |
| 89 | + // Paths to additional tag files to include in tag search. |
41 | 90 | //
|
42 |
| - "definition_current_first": true, |
| 91 | + // This is a list of items in the following format: |
| 92 | + // |
| 93 | + // [["language", "platform"], "path"] |
| 94 | + // |
| 95 | + "extra_tag_paths": [ |
| 96 | + [["source.python", "windows"], "C:\\Python27\\Lib\\tags"] |
| 97 | + ], |
43 | 98 |
|
44 |
| - // Show the ctags menu in the context menus |
45 |
| - "show_context_menus": true, |
| 99 | + // Enable highlighting of selected symbol. |
| 100 | + // |
| 101 | + // When enabled, searched symbols will be highlighted when found. This |
| 102 | + // can be irritating in some instances, e.g. when in Vintage mode. In |
| 103 | + // these cases, setting this to false will disable this highlighting. |
| 104 | + "select_searched_symbol": true, |
46 | 105 |
|
47 |
| - // Paths to additional tag files to include in tag search. This is a list |
48 |
| - // of items in the form [["language", "platform"], "path"] |
49 |
| - "extra_tag_paths": [[["source.python", "windows"], "C:\\Python27\\Lib\\tags"]], |
| 106 | + // Set to false to not open an error dialog while tags are building |
| 107 | + "display_rebuilding_message": true, |
50 | 108 |
|
51 |
| - // Additional tag files to search |
52 |
| - "extra_tag_files": [".gemtags", "tags"], |
| 109 | + // Rank Manager language syntax regex and character sets |
| 110 | + // |
| 111 | + // Ex: Python 'and' ignore exp --> '\sand\s' - it must have whitespace |
| 112 | + // around it so it is not part of real name: gates.Nand.evaluate() |
| 113 | + "language_syntax": { |
| 114 | + "splitters" : [".", "::", "->"], |
| 115 | + "source.js": { |
| 116 | + "member_exp": { |
| 117 | + "chars": "[A-Za-z0-9_$]", |
| 118 | + "splitters": ["\\."], |
| 119 | + "open": ["\\{", "\\[", "\\("], |
| 120 | + "close": ["\\}", "\\]" , "\\)"], //close[i] must match open[i] |
| 121 | + "ignore": ["&", "\\|", "\\?", ":", "\\!", "'", "=", "\""], |
| 122 | + "stop": ["\\s", ","], |
| 123 | + "this": ["this", "me", "self", "that"] |
| 124 | + }, |
| 125 | + "reference_types": { |
| 126 | + "__symbol__(\\.call|\\.apply){0,1}\\s*?\\(": ["f", "fa"], |
| 127 | + "\\.fire\\s*?\\(\\s*?\\[\\'\"]__symbol__\\[\\'\"\\]": [ |
| 128 | + "eventHandler" |
| 129 | + ] |
| 130 | + } |
| 131 | + }, |
| 132 | + "source.python": { |
| 133 | + //python settings inherit JavaScript, with some overrides |
| 134 | + "inherit": "source.js", |
| 135 | + "member_exp": { |
| 136 | + "ignore": ["\\sand\\s", "\\sor\\s", "\\snot\\s", ":", "\\!", |
| 137 | + "'", "=", "\""], |
| 138 | + "this" : ["self"] |
| 139 | + } |
| 140 | + }, |
| 141 | + "source.java": { |
| 142 | + "inherit": "source.js", |
| 143 | + "member_exp": { |
| 144 | + "this" : ["this"] |
| 145 | + } |
| 146 | + }, |
| 147 | + "source.cs": { |
| 148 | + "inherit": "source.js", |
| 149 | + "member_exp": { |
| 150 | + "this" : ["this"] |
| 151 | + } |
| 152 | + } |
| 153 | + }, |
53 | 154 |
|
54 |
| - // Set to false so as not to select searched symbol (in Vintage mode) |
55 |
| - "select_searched_symbol": true |
| 155 | + // Scope Filters |
| 156 | + // |
| 157 | + // Tags file may optionally contain tagfield for the scope of the tag. For |
| 158 | + // example: |
| 159 | + // |
| 160 | + // item .\fileHelper.js 420;" vp lineno:420 scope:420:19-422:9 |
| 161 | + // |
| 162 | + // The re is used to extract 'scope:/beginLine:beginCol-endLine:endCol/' |
| 163 | + // |
| 164 | + // Different tags generators may generate this non-standard field in |
| 165 | + // different formats |
| 166 | + "scope_re": "(\\d.*?):(\\d.*?)-(\\d.*?):(\\d.*?)" |
56 | 167 | }
|
0 commit comments