Skip to content

Commit 414baad

Browse files
v2.6.7
1 parent 402f616 commit 414baad

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+771
-1093
lines changed

evaluate_javascript/Default (Linux)_disabled.sublime-keymap renamed to Default (Linux).sublime-keymap

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
[
2+
{
3+
"keys": ["ctrl+super+c"],
4+
"command": "find_description"
5+
},
26
{
37
"keys": ["ctrl+super+s"],
48
"command": "evaluate_javascript",
@@ -16,5 +20,9 @@
1620
{
1721
"keys": ["ctrl+super+j"],
1822
"command": "show_code_highlights_eval"
23+
},
24+
{
25+
"keys": ["ctrl+alt+w"],
26+
"command": "can_i_use"
1927
}
20-
]
28+
]

evaluate_javascript/Default (OSX)_disabled.sublime-keymap renamed to Default (OSX).sublime-keymap

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
[
2+
{
3+
"keys": ["ctrl+super+c"],
4+
"command": "find_description"
5+
},
26
{
37
"keys": ["ctrl+super+s"],
48
"command": "evaluate_javascript",
@@ -16,5 +20,9 @@
1620
{
1721
"keys": ["ctrl+super+j"],
1822
"command": "show_code_highlights_eval"
23+
},
24+
{
25+
"keys": ["ctrl+alt+w"],
26+
"command": "can_i_use"
1927
}
20-
]
28+
]

evaluate_javascript/Default (Windows)_disabled.sublime-keymap renamed to Default (Windows).sublime-keymap

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
[
2+
{
3+
"keys": ["ctrl+super+c"],
4+
"command": "find_description"
5+
},
26
{
37
"keys": ["ctrl+super+s"],
48
"command": "evaluate_javascript",
@@ -16,5 +20,9 @@
1620
{
1721
"keys": ["ctrl+super+j"],
1822
"command": "show_code_highlights_eval"
23+
},
24+
{
25+
"keys": ["ctrl+alt+w"],
26+
"command": "can_i_use"
1927
}
20-
]
28+
]

javascript_completions/JavaScript-Completions.sublime-settings renamed to JavaScript-Completions.sublime-settings

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
{
2-
"enable_key_map": false,
32
"enable_on_hover_description": true,
3+
"enable_can_i_use_menu_option": true,
4+
"jsdoc_conf_file": "conf.json",
5+
"node_js_custom_path": "",
6+
"npm_custom_path": "",
47
"completion_active_list": {
58
"jQuery": false,
69
"description-jQuery": false,

Main.sublime-menu

Lines changed: 117 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,133 @@
11
[
22
{
3-
"caption": "JavaScript Completions Tools",
4-
"mnemonic": "J",
5-
"id": "javascript_completions_tools",
6-
"children":[
3+
"id": "tools",
4+
"children": [
75
{
8-
"caption": "Search on \"Can I use\" list",
9-
"command": "can_i_use",
10-
"args": {"from": "main-menu"}
11-
},
12-
{ "caption": "-" },
13-
{
14-
"caption": "JSDoc",
15-
"id": "jsdoc",
16-
"children": [
6+
"caption": "JavaScript Completions",
7+
"mnemonic": "J",
8+
"id": "javascript_completions_tools",
9+
"children":[
10+
{
11+
"caption": "Search on \"Can I use\" list",
12+
"command": "can_i_use",
13+
"args": {"from": "main-menu"}
14+
},
15+
{ "caption": "-" },
1716
{
18-
"caption": "Generate Documentation",
19-
"command": "generate_jsdoc"
17+
"caption": "JSDoc",
18+
"id": "jsdoc",
19+
"children": [
20+
{
21+
"caption": "Generate Documentation",
22+
"command": "generate_jsdoc"
23+
},
24+
{
25+
"caption": "Add jsdoc configuration file to the current project folder",
26+
"command": "add_jsdoc_conf_to_curr_project_folder"
27+
},
28+
{ "caption": "-" },
29+
{
30+
"caption": "Go to JSDoc Site",
31+
"command": "open_url",
32+
"args": {"url": "http://usejsdoc.org/"}
33+
}
34+
]
2035
},
36+
{ "caption": "-" },
2137
{
22-
"caption": "Add jsdoc-settings.json to the current project folder",
23-
"command": "add_jsdoc_settings_to_curr_project_folder"
38+
"caption": "Go to Node.js site",
39+
"command": "open_url",
40+
"args": {
41+
"url": "https://nodejs.org",
42+
"platform": "Windows"
43+
}
2444
},
2545
{ "caption": "-" },
2646
{
27-
"caption": "Go to JSDoc Site",
47+
"caption": "GitHub Project",
2848
"command": "open_url",
29-
"args": {"url": "http://usejsdoc.org/"}
49+
"args": {"url": "https://github.com/pichillilorenzo/JavaScript-Completions"}
3050
}
3151
]
32-
},
33-
{ "caption": "-" },
34-
{
35-
"caption": "Go to Node.js site",
36-
"command": "open_url",
37-
"args": {
38-
"url": "https://nodejs.org",
39-
"platform": "Windows"
40-
}
41-
},
42-
{ "caption": "-" },
52+
}
53+
]
54+
},
55+
{
56+
"caption": "Preferences",
57+
"mnemonic": "n",
58+
"id": "preferences",
59+
"children": [
4360
{
44-
"caption": "GitHub Project",
45-
"command": "open_url",
46-
"args": {"url": "https://github.com/pichillilorenzo/JavaScript-Completions"}
61+
"caption": "Package Settings",
62+
"mnemonic": "P",
63+
"id": "package-settings",
64+
"children": [
65+
{
66+
"caption": "JavaScript Completions",
67+
"children": [
68+
{
69+
"caption": "Settings - Default",
70+
"command": "open_file",
71+
"args": {"file": "${packages}/JavaScript Completions/JavaScript-Completions.sublime-settings"}
72+
},
73+
{
74+
"caption": "Settings - User",
75+
"command": "open_file",
76+
"args": {"file": "${packages}/User/JavaScript-Completions.sublime-settings"}
77+
},
78+
{ "caption": "-" },
79+
{
80+
"command": "open_file",
81+
"args": {
82+
"file": "${packages}/JavaScript Completions/Default (OSX).sublime-keymap",
83+
"platform": "OSX"
84+
},
85+
"caption": "Key Bindings – Default"
86+
},
87+
{
88+
"command": "open_file",
89+
"args": {
90+
"file": "${packages}/JavaScript Completions/Default (Linux).sublime-keymap",
91+
"platform": "Linux"
92+
},
93+
"caption": "Key Bindings – Default"
94+
},
95+
{
96+
"command": "open_file",
97+
"args": {
98+
"file": "${packages}/JavaScript Completions/Default (Windows).sublime-keymap",
99+
"platform": "Windows"
100+
},
101+
"caption": "Key Bindings – Default"
102+
},
103+
{
104+
"command": "open_file",
105+
"args": {
106+
"file": "${packages}/User/Default (OSX).sublime-keymap",
107+
"platform": "OSX"
108+
},
109+
"caption": "Key Bindings – User"
110+
},
111+
{
112+
"command": "open_file",
113+
"args": {
114+
"file": "${packages}/User/Default (Linux).sublime-keymap",
115+
"platform": "Linux"
116+
},
117+
"caption": "Key Bindings – User"
118+
},
119+
{
120+
"command": "open_file",
121+
"args": {
122+
"file": "${packages}/User/Default (Windows).sublime-keymap",
123+
"platform": "Windows"
124+
},
125+
"caption": "Key Bindings – User"
126+
},
127+
{ "caption": "-" }
128+
]
129+
}
130+
]
47131
}
48132
]
49133
}

README.md

Lines changed: 32 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,11 @@ You can ENABLE or DISABLE completions! Just go to Preferences -> Package Setting
5555

5656
<strong>Supported only by Sublime Text 3</strong>
5757

58-
<strong>key-map</strong> of this feature disabled by default!
59-
6058
You can check the description of function/property/method by selecting the word (or, in case, it will take the first word near the blinking cursor) you want find. "right-click" on your mouse and click on "Find JavaScript Description".
6159

6260
It will show a popup with the list of possible descriptions or, in some case, the direct description.
6361

64-
In case, you can also use "key-map"! Just go to Preferences -> Package Settings -> JavaScript Completions and enable it.
62+
Key-Map list: Preferences -> Package Settings -> JavaScript Completions -> Key Bindings - Default.
6563

6664
<img src="https://s17.postimg.io/stsylwwn3/Schermata_2016_09_18_alle_17_41_17.png" alt="example #1 Find JavaScript Description Feature">
6765

@@ -87,17 +85,9 @@ Example:
8785

8886
<strong>Supported only by Sublime Text 3</strong>
8987

90-
This feature uses node.js (v6.6.0) executable.
91-
92-
You can change the node version on Preferences -> Package Settings -> Evaluate JavaScript settings
93-
94-
It will download automaticaly the binary for your OS.
88+
This feature uses node.js installed locally by this plugin.
9589

96-
A message will appear on the "status bar" of Sublime Text.
97-
98-
<strong>context menu option</strong> of this feature disabled by default!
99-
100-
<strong>key-map</strong> of this feature disabled by default!
90+
You can change the path of "node.js" and "npm" on Preferences -> Package Settings -> JavaScript Completions -> Settings - Default
10191

10292
You can evaluate the entire text selection or the current line!
10393
If you select a text region and evaluate it, in the gutter of the editor will appear 2 white dots.
@@ -111,9 +101,7 @@ There are two main mode to evaluate code:
111101
- [eval](https://nodejs.org/dist/latest-v6.x/docs/api/cli.html#cli_e_eval_script)
112102
- [print](https://nodejs.org/dist/latest-v6.x/docs/api/cli.html#cli_p_print_script)
113103

114-
To enable this feature on context menu, go to Preferences -> Package Settings -> Evaluate JavaScript and enable it.
115-
116-
In case, you can also use "key-map"! Just go to Preferences -> Package Settings -> Evaluate JavaScript and enable it.
104+
Key-Map list: Preferences -> Package Settings -> JavaScript Completions -> Key Bindings - Default.
117105

118106
<img src="https://s17.postimg.io/c7becu3pb/Schermata_2016_09_18_alle_18_07_00.png" alt="example #1 Evaluate JavaScript Feature">
119107

@@ -132,11 +120,11 @@ You can use this feature in HTML, CSS and JavaScript context!
132120

133121
Just put the cursor on the word you want to check, "right-click" -> <code>"Can I use?"</code> and it will appear an input panel with all items that have a name matching with the word.
134122

135-
You can use key-map: <code>ctrl+alt+w</code>. You can also change it. Just go to Preferences -> Package Settings -> JavaScript Completions Tools -> Key Bindings - User.
123+
You can use key-map: <code>ctrl+alt+w</code>. Key-Map list: Preferences -> Package Settings -> JavaScript Completions -> Key Bindings - Default.
136124

137125
After selecting an item from the list, it will appear a popup with all information from the [http://caniuse.com](http://caniuse.com) support tables.
138126

139-
You can also use the menu <code>JavaScript Completions Tools</code> on the top and select <code>Search on "Can I use" list</code> to search what you want.
127+
You can find it under <code>"Tools"</code> menu -> <code>"JavaScript Completions"</code> -> <code>Search on "Can I use" list</code>.
140128

141129
Example :
142130

@@ -155,35 +143,47 @@ Example :
155143

156144
This feature uses [https://github.com/jsdoc3/jsdoc](https://github.com/jsdoc3/jsdoc) to generate API documentation.
157145

158-
You can find it under <code>"JavaScript Completions Tools"</code> menu -> <code>JSDoc</code>.
146+
You can find it under <code>"Tools"</code> menu -> <code>"JavaScript Completions"</code>.
159147

160148
There are 2 main menu items:
161149
- Generate Documentation
162-
- Add jsdoc-settings.json to the current project folder
150+
- Add jsdoc configuration file to the current project folder
163151

164152
<strong>These items can be used only with a project folder opened.</strong>
165153

166154
<code>"Generate Documentation"</code> uses the jsdoc command line to generate documentation.
167155

168-
It uses <code>jsdoc-settings.json</code> file for configuration or, alternately, it will use default configuration.
156+
It uses the defaukt <code>conf.json</code> file for configuration.
169157

170158
The options (with default values) availables are:
171159
```json
172160
{
173-
"jsdoc_conf_file": "conf.json",
174-
"destination_folder": "out",
175-
"display_symbols_access_property": "all",
176-
"search_within_subdirectories": false,
177-
"encoding_when_reading_all_source_files": "utf-8",
178-
"template_path": "",
179-
"tutorials_path": "",
180-
"include_symbols_marked_with_the_private_tag": false,
181-
"pedantic_mode": false,
182-
"query_string_to_parse_and_store_in_global_variable": ""
161+
"tags": {
162+
"allowUnknownTags": true,
163+
"dictionaries": ["jsdoc","closure"]
164+
},
165+
"source": {
166+
"include": [ ],
167+
"exclude": [ ],
168+
"includePattern": ".+\\.js(doc|x)?$",
169+
"excludePattern": "(^|\\/|\\\\)_"
170+
},
171+
"opts": {
172+
"template": "templates/default",
173+
"encoding": "utf8",
174+
"destination": "./out/",
175+
"recurse": true,
176+
"tutorials": ""
177+
},
178+
"plugins": [],
179+
"templates": {
180+
"cleverLinks": false,
181+
"monospaceLinks": false
182+
}
183183
}
184184
```
185185

186-
<code>"Add jsdoc-settings.json to the current project folder"</code> will add a <code>jsdoc-settings.json</code> file with default values to the current project folder.
186+
<code>"Add jsdoc configuration file to the current project folder"</code> will add a <code>conf.json</code> file with default values to the current project folder.
187187

188188
How to use JSDoc: [http://usejsdoc.org/](http://usejsdoc.org/)
189189

@@ -209,16 +209,12 @@ You can surround code with:
209209
- for statement
210210
- try catch statement
211211
- try catch finally statement
212-
- Multi-line comment
213-
- Single-line comment
214212

215213
This option works also on multiple selections at once.
216214

217215
<h4 id="delete-surround">Delete Surrounded</h4>
218216

219217
Options are:
220-
- Delete multi-line comment
221-
- Delete single-line comment
222218
- Strip quoted string
223219

224220
This option works also on multiple selections at once.

0 commit comments

Comments
 (0)