CudaText plugins: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## Comments
2	2
3	3		You can add/remove code comments, via "Comments" plugin. Plugin is preinstalled in CudaText. It gives about 6 commands in menu "Plugins / Comments". Plugin supports only adding/removing of comments, not syntax highlighting for them (highlighting is lexer's work).
4	4
5	5		- Line comments: from some position to the nearest end-of-line. E.g. in C lexer: "//text here", in Python lexer: "# text here".
6	6		- Comments for range (Stream comments): from some text position to some bigger text position, often in the different line. E.g. in C lexer: "/* text here */".
7	7		- Comments for full lines: from newline to another newline, ie comment for several whole lines. Rarely used, e.g. used in PowerShell.
8	8
9	9		For example, Python lexer supports only line comment, and don't support stream comments. PowerShell lexer supports comments for full lines, while don't support comments for any range.
10	10
11	11		Comment chars are editable in SynWrite editor, in dialog "Lexer properties" (after you install the same lexer to SynWrite). In dialog tab "Commenting" you'll see input fields.
12	12
13	13		Command "Toggle stream comment" in plugin adds/removes comments of last 2 types: for range, for full lines (plugin chooses needed kind).
14	14
15	15		Where comment chars are stored:
16	16
17	17		- Line comments: in lexer file data/lexlib/*.lcf.
18	18		- Range comments: in additional file data/lexlib/*.cuda-lexmap.
19	19
20	20		### Commenting options
21	21
22	22		Plugin "Comments" has several options, and it gives the dialog to change them: menu item "Options / Settings-plugins / Comments / Config".
23	23
24	24		(Line commands) Try to keep text position after (un)commenting
25	25
26	26		Affects all commands for line-comments.
27	27
28	28		With option on, plugin tries to insert comment chars into leading space-area of the line. For example, with C++ (line comment chars "//"), line with 4 leading spaces:
29	29
30	30		` code();`
31	31
32	32		will be changed to line with 2 leading spaces:
33	33
34	34		` //code();`
35	35
36	36		After uncommenting, line will be restored to original, with 4 leading spaces.
37	37
38	38		(Line "at non-space") If selected few lines, insert comment at maximal common indent
39	39
40	40		Affects commands:
41	41
42	42		- "Toggle line comment, at non-space char"
43	43		- "Add line comment, at non-space char"
44	44
45	45		With option on, this selected block of lines in C++:
46	46
47	47		` code1();`\
48	48		` code2();`\
49	49		` code3();`
50	50
51	51		will be changed to:
52	52
53	53		` // code1();`\
54	54		` //code2();`\
55	55		` // code3();`
56	56
57	57		With option off, block will be changed to:
58	58
59	59		` //code1();`\
60	60		` //code2();`\
61	61		` //code3();`
62	62
63	63		(All) Move caret to next line
64	64
65	65		Affects commands for line-comments, when they are called without selection.
66	66
67	67		With option on, caret will be moved 1 line down. This allows to call the command many times repeatedly, to change many lines.
68	68
69	69		(Line commands) Skip blank lines
70	70
71	71		Affects commands for line-comments, when they are called without selection.
72	72
73	73		With option on, and the previous option "Move caret to next line" on, command will skip lines containing only space/tab chars.
74	74
75	75		"Toggle line comment" detects action by first non-blank line
76	76
77	77		Affects command "Toggle line comment".
78	78
79	79		With option on, command detects its action (to comment or to uncomment) by the first non-blank line of the selected multi-line block.
80	80
81	81		Here is selected block of code, selection is shown by square brackets, first selected line is blank line:
82	82
83	83		`[`\
84	84		` `\
85	85		` //code1();`\
86	86		` code2();`\
87	87		` //code3();`\
88	88		` code4();`\
89	89		`]`
90	90
91	91		With option off, block will be changed it to:
92	92
93	93		`[//`\
94	94		`//`\
95	95		` //code1();`\
96	96		` //code2();`\
97	97		` //code3();`\
98	98		` //code4();`\
99	99		`]`
100	100
101	101		With option on, block will be changed to:
102	102
103	103		`[`\
104	104		` `\
105	105		` code1();`\
106	106		` code2();`\
107	107		` code3();`\
108	108		` code4();`\
109	109		`]`
110	110
111	111		## Macros
112	112
113	113		Macro is a sequence of CudaText actions, which can be saved to a file and invoked later by some command. To use macros, you must install plugin "Macros" from Addon Manager. It adds "Macros" menu to CudaText main menu bar. This menu gives items:
114	114
115	115		- Macros...
116	116		- Start/stop recording
117	117		- Playback last recorded macro
118	118		- Export...
119	119		- Import...
120	120		- items for saved macros
121	121
122		-	~~<figure>~~
123		-	~~<img src="cudatext-macro-menu.png" title="cudatext-macro-menu.png" />~~
124		-	~~<figcaption>cudatext-macro-menu.png</figcaption>~~
125		-	~~</figure>~~
	122	+	![](/wiki-images/a/a3/Cudatext-macro-menu.png)
126	123
127	124		To record a macro:
128	125
129	126		- Call menu item "Macros / Start/stop recording", or use dialog "Macros / Macros..." which gives the button for this.
130	127		- Perform some actions in CudaText:
131	128		- built-in commands, plugin commands (invoked by hotkey, by menu, by Command Palette)
132	129		- some mouse actions (clicks/selections, they save/playback relative to caret position)
133	130		- calling of Find/Replace dialog, "Go to" dialog
134	131		- actions in Find/Replace dialog
135	132		- Call menu item "Macros / Start/stop recording" again, plugin will ask for macro name.
136	133
137	134		During recording, CudaText shows reddish border around the editor field.
138	135
139		-	~~<figure>~~
140		-	~~<img src="cudatext-macro-border.png" title="cudatext-macro-border.png" />~~
141		-	~~<figcaption>cudatext-macro-border.png</figcaption>~~
142		-	~~</figure>~~
	136	+	![](/wiki-images/4/4c/Cudatext-macro-border.png)
143	137
144	138		Macro saves action(s) performed inside its original editor ui-tab (but not other ui-tabs). Calling of additional dialogs (including plugin dialogs) will be recorded too. But macro doesn't save actions inside those dialogs.
145	139
146	140		To playback macro:
147	141
148	142		- Call menu item "Macros / macro_name", the end of this menu lists all available/saved macros.
149	143		- Or call dialog "Macros / Macros...", which allows to run all available macros:
150	144		- running 1 time
151	145		- running specified count of times
152	146		- running in the loop, by options:
153	147		- While text changes
154	148		- Until caret on last line
155	149
156	150		### Macro example
157	151
158	152		For example, we have text line with HTML tags like this ("\\|" shows the caret):
159	153
160	154		`....<tag>....\|...........</tag>....`
161	155
162	156		For example, we need a macro which selects text from lefter "\>" char to righter "\<" char (ie text inside HTML tag). This action can be done via "markers" commands in Command Palette: "drop marker at caret" and "select to last marker".
163	157
164	158		So, during macro recording, run these commands:
165	159
166	160		- call Find dialog (or focus it with mouse), search for "\>" with "Find previous" button
167	161		- right-arrow key (to reset the selection)
168	162		- "markers: drop marker at caret"
169	163		- call Find dialog again (or focus it with mouse), search for "\<" with "Find next" button
170	164		- left-arrow key, 2 times (to reset the selection)
171	165		- "markers: select to last marker"
172	166		- "markers: remove all"
173	167
174	168		## Project Manager
175	169
176	170		This plugin is preinstalled in CudaText. It shows panel "Project" in the sidebar (to show this panel, call plugin by any command, or call "File / Open folder..." menu item which opens any folder as a "project"). On the project panel, on its tree-view, you can add several "root nodes", each node must be existing file or folder. For folder nodes, plugin auto shows all nested folders. You cannot add nodes on other levels, sub-nodes are auto populated from root folder nodes.
177	171
178	172		Plugin has context menu on its panel, with items:
179	173
180	174		- Project file
181	175		- New project
182	176		- Open project
183	177		- Recent projects
184	178		- Save project as...
185	179		- Go to file... - this shows menu with all project files, and then tree-view selection jumps on selected file
186	180		- Project properties... - this shows dialog with current project's options
187	181		- Config... - this shows dialog with global Project Manager options
188	182		- Root nodes - commands for nodes on the project's root level
189	183		- Add folder...
190	184		- Add file...
191	185		- Clear project
192	186		- Remove node
193	187		- Selected file - it's shown only for files
194	188		- Selected directory - it's shown only for folders
195	189		- Refresh - it re-reads state of files/folders from disk
196	190
197	191		To manage the selected file/folder, use context menu items "Selected file"/"Selected directory". They give useful sub-items for file operations, like shown on the picture:
198	192
199		-	~~<figure>~~
200		-	~~<img src="cudatext-project-seldir.png" title="cudatext-project-seldir.png" />~~
201		-	~~<figcaption>cudatext-project-seldir.png</figcaption>~~
202		-	~~</figure>~~
	193	+	![](/wiki-images/a/a7/Cudatext-project-seldir.png)
203	194
204	195		Any project can have main file, you can choose it in the context menu: "Selected file / Set as main file". Main file's path is used by plugin External Tools, when some tool is configured with macro {ProjMainFile}. This allows tools to run compilation of the main file.
205	196
206	197		Sometimes you may want to forget the "temporary" project which CudaText may create from Windows Explorer context menu. To do this, just call "Project file / New project" from the right-click menu over the project panel. This does not delete the file "settings/temporary.cuda-proj", but that file will be overwritten soon.
207	198
208	199		### Project Manager options dialog
209	200
210	201		"Ignore files"
211	202		";"-separated shell wildcards, which are [documented here](https://docs.python.org/3/library/fnmatch.html). If file name (without path) matches any of these wildcards, it will not be listed in the treeview.
212	203
213	204		"Ignore folders"
214	205		";"-separated shell wildcards. If folder name matches any of these wildcards, it will not be listed in the treeview.
215	206
216	207		"Ignore all hidden files/folders"
217	208		Additionally don't list all hidden items. On Unix, hidden mean "beginning with dot". On Windows, hidden means having file-system "hidden" attribute.
218	209
219	210		"Open file after "Go to file" command"
220	211		If turned on, command "Project Manager: Go to file" will not only jump to chosen file in the treeview, but also open that file in editor.
221	212
222	213		"Use 'preview tab' on item clicking"
223	214		If option is on, single click on treeview file item, will open file in "preview tab". Preview tab is single such tab, it's shared by all files, it has italic+underlined tab title. If option is off, clicking file item will open normal tab, separate normal tabs per each file.
224	215
225	216		"Open files by double-click"
226	217		If turned on, only double-click in the treeview will open file for editing, but not the single click.
227	218
228	219		"On opening file in Git/SVN repo..."
229	220		On opening a file in CudaText, Project Manager will check if this file is in the Git/SVN repository (by presence of the folder ".git" or ".svn" near the file, or in upper level folders). If yes, Project Manager will create the project from that repository and open it. This gives some slowdown of course.
230	221
231	222		"Suggest to close tabs not belonging to project"
232	223		See #Sessions embedded to project.
233	224
234	225		And options for icons:
235	226
236	227		"File type icons"
237	228		Set of file/folder icons for treeview. You can install additional themes from Addons Manager, see category "filetypeicons" there. Example of such theme: "VSCode Material 24x24". This option shows themes, which are present in the folder "data/filetypeicons".
238	229
239	230		"Toolbar icons"
240	231		Set of icons for Project Manager toolbar buttons. You can install additional themes from Addon Manager, see the category "projtoolbaricons" there. This option shows themes, which are present in the folder "data/projtoolbaricons".
241	232
242	233		### Preview tab
243	234
244	235		To see the "preview tab", call "File / Open folder" and choose a folder with some files. Folder will be opened in the side panel "Project". Make single click on a file in this project, it will open in the "preview tab". Single "preview tab" is shared by all clicked (in the project) files. It has italic font style of the caption (font style is customizable). When you begin to edit file in the "preview tab", tab becomes "normal" and looses its special status.
245	236
246	237		"Preview tab" is always created in the first tab-group, even if the focused editor is located in different tab-group. It was made on purpose, to avoid the situation when "preview tab" jumps from one tab-group to another.
247	238
248	239		Again, if you click different items in the Project Manager, and files are opened in the first tab-group, it's not a bug. If you need to open clicked files in different tab-groups, you can do it - by unchecking the option "Use preview tab on item clicking" in the Project Manager options.
249	240
250	241		"Preview tab" can be dragged to another tab-group, it should work there too.
251	242
252	243		### Switch between projects
253	244
254	245		1\) To switch to different project, Plugin Manager gives the context menu: "Project File / Recent projects / name.cuda-proj".
255	246
256	247		2\) Another way is using the plugin "Favorites". It gives the dialog (can be called by a hotkey), with 2 tabs: "Files" and "Projects", so you can choose one of your favorite projects from a listbox.
257	248
258	249		3\) There is also a way to quickly switch between projects:
259	250
260	251		- Install plugins: "Config Toolbar", "External Tools" and "Session Manager". Restart CudaText.
261	252		- Set CudaText option "ui_one_instance": true.
262	253		- In "External Tools" make a tool which starts CudaText (yes, from within CudaText) with parameter: full path of a project. The command line can look like: "c:\Apps\cudatext.exe "c:\Apps\some_project.cuda-proj"". You can add here additional parameter: full path of a session file, .cuda-session / .json. So this external tool will open given project (and maybe a session too). It will open it inside the same CudaText instance (because "ui_one_instance":true).
263	254		- Add more such tools in the "External Tools", for different projects (and maybe sessions).
264	255
265		-	~~<figure>~~
266		-	~~<img src="cudatext-tools-and-projects.png" title="cudatext-tools-and-projects.png" />~~
267		-	~~<figcaption>cudatext-tools-and-projects.png</figcaption>~~
268		-	~~</figure>~~
	256	+	![](/wiki-images/5/58/Cudatext-tools-and-projects.png)
269	257
270	258		- In the plugin "Config Toolbar", add the toolbar drop-down menu, with menu-items referring to different tools. Or add the individual menu-items for separate tools.
271	259
272		-	~~<figure>~~
273		-	~~<img src="cudatext-tools-and-projects-config.png" title="cudatext-tools-and-projects-config.png" />~~
274		-	~~<figcaption>cudatext-tools-and-projects-config.png</figcaption>~~
275		-	~~</figure>~~
	260	+	![](/wiki-images/9/9b/Cudatext-tools-and-projects-config.png)
276	261
277	262		4\)
278	263
279	264		- Install plugin "Config Toolbar" (only 1 plugin here, comparing to the previous method).
280	265		- CudaText option "ui_one_instance" can be any.
281	266		- In the plugin "Config Toolbar", add the toolbar button which will switch the project and/or session. The properties of this button are tricky. In the "Command" property of the button, you must enter "exec=path_of_project_file path_of_session file". You cannot type this directly to the dialog field, but you should press the "Enter command line..." button in the dialog and enter the command line contents (full path of .cuda-proj file and/or full path of .cuda-session file). "Config Toolbar" will store your command line with the "exec=" prefix.
282	267		- CudaText will use the new command-line which you entered after "exec=".
283	268
284	269		### Sessions embedded to project
285	270
286	271		CudaText supports sessions which are not separate JSON files (.cuda-session or .json) but are embedded into project file (*.cuda-proj). Session is still having the same JSON format, but it's nested 2 levels into the project JSON file. Such embedded sessions are visible only to the Project Manager. When an embedded session is active, CudaText window title shows this in curly brackets: "{project_name:session_name}".
287	272
288	273		To control sessions, use the "gear" button on the Project Manager toolbar. Several menu items are there:
289	274
290	275		- "Project session: name". One or more menu items, one item per each session.
291	276		- "Save session...". Shows text input prompt, to name a session (you will be warned if you use incorrect characters or session already exists).
292	277		- "Delete session". Shows menu to choose which session to delete from the project.
293	278		- "Set default session". After you choose a session here, it will be marked in the project file, and will be auto-loaded on next project opening.
294	279		- "Forget session, close all tabs".
295	280
296	281		Project Manager has the option checkbox "Suggest to close tabs not belonging to project". When option is on, you will see such confirmation message box:
297	282
298	283		`CudaText has opened 3 tab(s) not belonging to the project "name". Close them?`\
299	284		`/path/to/file1`\
300	285		`/path2/to/file2`\
301	286		`*Untitled1`
302	287
303	288		You will see this confirmation when doing:
304	289
305	290		- "New project" action (from Project Manager context menu, or from Command Palette)
306	291		- "Save session..." action (from "gear" popup menu, or from Command Palette)
307	292
308	293		You can disable that option (or press "Cancel" in the confirmation), to save even "not belonging" opened files to embedded session.
309	294
310	295		## How to bind a hotkey to insert a snippet
311	296
312	297		You can create plugin to insert any text fragment by any hotkey. First, create the plugin which gives the command to insert your fragment. Next, find this plugin in the Command Palette, press F9 and assign a hotkey there.
313	298
314	299		Let's show how to make a primitive plugin which has 2 primitive commands:
315	300
316	301		- Insert snippet "AA" at the caret position (supporting multi-carets).
317	302		- Surround current line with square brackets.
318	303
319	304		Make a new plugin by calling menu item "Plugins / Make Plugin". Fieds of dialog:
320	305
321	306		- "Plugin name": set to "My plugin".
322	307		- "Python module name": set to "my_snippet".
323	308		- "Commands caption\>method": set 2 lines:
324	309
325	310		`My snippet>my_snippet`\
326	311		`My edit>my_edit`
327	312
328	313		This will generate new plugin with 2 methods in the file "__init__.py": my_snippet and my_edit. Code will be like this:
329	314
330	315		``` python
331	316		def my_snippet(self):
332	317		#
333	318		#
334	319		#
335	320		msg_box(s, MB_OK)
336	321
337	322		def my_edit(self):
338	323		pass
339	324		```
340	325
341	326		At the top of the Python file, near "import" operators, add:
342	327
343	328		``` python
344	329		import cudatext_cmd as cmds
345	330		```
346	331
347	332		Now edit methods my_snippet / my_edit:
348	333
349	334		``` python
350	335		def my_snippet(self):
351	336		''' Insert my snippet '''
352	337		ed.cmd(cmds.cCommand_TextInsert, 'AA')
353	338
354	339		def my_edit(self):
355	340		''' Surround line with brackets '''
356	341		x, y, x1, y1 = ed.get_carets()[0]
357	342		s = ed.get_text_line(y)
358	343		s = '[' + s + ']'
359	344		ed.set_text_line(y, s)
360	345		msg_status('Edited!')
361	346		```
362	347
363	348		All done. Restart CudaText. You must have new menu items:
364	349
365	350		- "Plugins / My plugin / My snippet"
366	351		- "Plugins / My plugin / My edit"
367	352
368	353		In the Command Palette, find these new commands, press F9 to set hotkey for them.
369	354
370	355		## Snippets
371	356
372	357		To use snippets you need:
373	358
374	359		- Plugin "Snippets" (install from Addon Manager)
375	360		- Snippet package for needed lexer (install from Addon Manager)
376	361
377	362		Each snippet has a name (shown in the dialog when Snippets plugin is called) and short id (letters, digits, '_', dot). You can type id in the editor and press the Tab key: snippet for this id will be inserted into text. You can also call the menu of snippets: menu item "Plugins / Snippets / Snippets menu...".
378	363
379	364		Only those snippets are enabled, which are suitable for the current lexer. Snippet's "lexer" property can be "C,C++,Objective C" - then snippet is enabled only when one of these 3 lexers is active. If snippet has empty "lexer" property, it is always enabled.
380	365
381	366		Dialog of Snippets plugin:
382	367
383		-	~~<figure>~~
384		-	~~<img src="cudatext_snippets_menu.png" title="cudatext_snippets_menu.png" />~~
385		-	~~<figcaption>cudatext_snippets_menu.png</figcaption>~~
386		-	~~</figure>~~
	368	+	![](/wiki-images/a/af/Cudatext_snippets_menu.png)
387	369
388	370		Texts of snippets usually have tab-stop(s), e.g. \${1:some_text}. Plugin Snippets finds tab-stops and places "markers" for them. After markers are placed, Tab-key works specially: it jumps to the next marker. See detailed information in the [[CudaText\|CudaText#Markers]].
389	371
390	372		Plugin supports two snippets folder, but formats of data are the same, VSCode JSON format:
391	373
392	374		- CudaText snippets. These are packages with prefix "snippets_ct" in the Addons Manager. They are installed into folder CudaText/data/snippets_ct.
393	375		- VSCode snippets. These are VSCode packages located in the VSCode repositories. Read the separate topic about them below. They are installed to folder CudaText/data/snippets_vs.
394	376
395	377		### Snippets from VSCode
396	378
397	379		Since recent versions, Snippets plugin supports snippets from VSCode editor. It gives menu items in "Plugins / Snippets":
398	380
399	381		- "Install VSCode snippets..." - this suggests to install packages with snippets (packages usually contain more functionality, and CudaText plugin will install only snippets).
400	382
401		-	~~<figure>~~
402		-	~~<img src="cudatext-snippets-add-vscode.png" title="cudatext-snippets-add-vscode.png" />~~
403		-	~~<figcaption>cudatext-snippets-add-vscode.png</figcaption>~~
404		-	~~</figure>~~
	383	+	![](/wiki-images/b/b6/Cudatext-snippets-add-vscode.png)
405	384
406	385		- "Remove VSCode snippets"
407	386		- "Visit homepage of VSCode snippets..."
408	387		- "Convert snippets package from old format" - this takes snippets in old .cuda-snippet format (if you have some old ones) and converts them to VSCode JSON format.
409	388
410	389		Plugin also gives the fully featured snippet editor dialog, in menu item "Add/edit snippets...".
411	390
412		-	~~<figure>~~
413		-	~~<img src="cudatext-snippets-editor.png" title="cudatext-snippets-editor.png" />~~
414		-	~~<figcaption>cudatext-snippets-editor.png</figcaption>~~
415		-	~~</figure>~~
	391	+	![](/wiki-images/b/bc/Cudatext-snippets-editor.png)
416	392
417	393		You can create group of snippets (in the "Manage snippets" dialog) for all lexers. To do so, enter "*" value in the "Group's lexers" field of dialog.
418	394
419	395		Currently most of VSCode/TextMate "macros" are supported in snippets body, but not all. Refer to readme file of the plugin.
420	396
421	397		### Snippets for HTML tags
422	398
423	399		CudaText has preinstalled 120+ snippets for HTML tags. (You still need to install Snippets plugin.) They are enabled with HTML lexer. Just type tag name without a bracket, press Tab, and snippet is inserted. E.g. "a"\<Tab\> will insert:
424	400
425	401		` <a href="http" title="Title" target="_blank"></a>`
426	402
427	403		These snippets have markers, so Tab key jumps to the next marker. Last marker is usually placed after the entire tag, ie after "\>" bracket.
428	404
429	405		### Format of snippet files
430	406
431	407		#### Snippets tab-stops
432	408
433	409		Specify tab-stops in the snippet text like this:
434	410
435	411		- \${NN}
436	412		- \${NN:default text}
437	413
438	414		This places markers (AKA tab-stops) in the editor, marker index NN should be from 0 to 40. After snippet insertion, tab-key goes to next marker(s) and deletes it.
439	415
440	416		- Markers can be listed in any order (e.g. marker 4 can be between 1 and 2).
441	417		- Tab-key first goes to marker 1, 2, 3... and marker 0 is always the last.
442	418		- Markers with the same indexes will place multi-carets.
443	419		- Nested markers (with default text) are allowed, but only with one nesting level, e.g. \${2:text is {\$3:here}}.
444	420		- Marker with default text \${NN:...} can specify multi-line default text (character "}" is on another line of snippet).
445	421
446	422		#### Snippets macros
447	423
448	424		Special macros are handled by Snippets plugin in snippet text:
449	425
450	426		- \${sel} - Text selected before snippet insertion (if snippet called with Tab key, it's empty string)
451	427		- \${cp} - Current clipboard contents
452	428
453	429		- \${cmt_start} - Current lexer's "block comment" start symbols (or empty string)
454	430		- \${cmt_end} - Current lexer's "block comment" end symbols (or empty string)
455	431		- \${cmt_line} - Current lexer's "line comment" symbols (or empty string)
456	432
457	433		- \${fname} - File name only, without path
458	434		- \${fpath} - Full file name, with path
459	435		- \${fdir} - Directory of file
460	436		- \${fext} - Extension of file
461	437		- \${psep} - OS path separator: backslash on Windows, slash on Unix
462	438
463	439		- \${date:nnnn} - Current date/time formatted by string "nnnn"; see [Python docs](http://strftime.org/)
464	440		- \${env:nnnn} - Value of OS environment variable "nnnn"
465	441		- \${cmd:nnnn} - Execute shell command "nnnn" and get its output (space-separated arguments are supported, '~' for home-directory is supported on Unix)
466	442
467	443		The following macros from Sublime Text editor are supported. They can be written as \$NAME or as \${NAME}.
468	444
469	445		- \$TM_SELECTED_TEXT - The currently selected text or the empty string
470	446		- \$TM_CURRENT_LINE - The contents of the current line
471	447		- \$TM_CURRENT_WORD - The contents of the word under cursor or the empty string
472	448		- \$TM_LINE_INDEX - The zero-based line number
473	449		- \$TM_LINE_NUMBER - The one-based line number
474	450		- \$TM_FILEPATH - The full file path of the current document
475	451		- \$TM_DIRECTORY - The directory of the current document
476	452		- \$TM_FILENAME - The filename of the current document
477	453		- \$TM_FILENAME_BASE - The filename of the current document without its extensions
478	454		- \$CLIPBOARD - The contents of your clipboard
479	455		- \$WORKSPACE_NAME - The name of the opened workspace or folder
480	456
481	457		- \$BLOCK_COMMENT_START - Current lexer's "block comment" start symbols (or empty string)
482	458		- \$BLOCK_COMMENT_END - Current lexer's "block comment" end symbols (or empty string)
483	459		- \$LINE_COMMENT - Current lexer's "line comment" symbols (or empty string)
484	460
485	461		For inserting the current date and time:
486	462
487	463		- \$CURRENT_YEAR - The current year
488	464		- \$CURRENT_YEAR_SHORT - The current year's last two digits
489	465		- \$CURRENT_MONTH - The month as two digits (e.g. '02')
490	466		- \$CURRENT_MONTH_NAME - The full name of the month (e.g. 'July')
491	467		- \$CURRENT_MONTH_NAME_SHORT - The short name of the month (e.g. 'Jul')
492	468		- \$CURRENT_DATE - The day of the month
493	469		- \$CURRENT_DAY_NAME - The name of day (e.g. 'Monday')
494	470		- \$CURRENT_DAY_NAME_SHORT - The short name of the day (e.g. 'Mon')
495	471		- \$CURRENT_HOUR - The current hour in 24-hour clock format
496	472		- \$CURRENT_MINUTE - The current minute
497	473		- \$CURRENT_SECOND - The current second
498	474		- \$CURRENT_SECONDS_UNIX - The number of seconds since the Unix epoch
499	475
500	476		## Snippet Panel
501	477
502	478		Plugin "Snippet Panel" is preinstalled in CudaText. It gives an alternative way to use short text fragments (only simple ones) in editor. It adds button to sidebar, and command "Plugins / Snippet Panel". When called, plugin shows panel in the sidebar, with a drop-down list of folders, which contain several "snippets". You can double-click snippets to insert them into text (multi-carets are supported).
503	479
504	480		Preinstalled folders:
505	481
506	482		- Arrows
507	483		- Currency symbols
508	484		- Greek alphabet (lower)
509	485		- Greek alphabet (upper)
510	486		- HTML - Arrows
511	487		- HTML - Color names
512	488		- HTML - Color names+values
513	489		- HTML - Letters
514	490		- HTML - Math symbols
515	491		- HTML - Special characters
516	492		- Math symbols
517	493		- Quote selection
518	494		- Special characters
519	495
520	496		Plugin looks for its folders in two places:
521	497
522	498		- Folder "clips" in the plugin folder.
523	499		- Folder CudaText/data/clips, which is absent by default, for custom user folders.
524	500
525	501		Each snippet folder can contain one or more .txt files, in UTF-8 (no BOM) or UTF-16 (with BOM) encoding. Files have snippet per line, in the form "name=value" or simply "name" (if value missed, it equals to name). Each snippet can be simple short string, or string with \${sel} macro to replace selected text. This allows to quote currently selected text by calling snippets from "Quote selection" folder.
526	502
527	503		## CudaLint
528	504
529	505		CudaLint plugin allows to check correctness of documents in many syntaxes. It was initially ported from SublimeLinter 2.x plugin for Sublime Text. Each lexer must be supported with additionally installed linter, for example:
530	506
531	507		- JavaScript is supported with linter based on JSLint tool,
532	508		- HTML is supported with linter based on HTML Tidy tool,
533	509		- CSS is supported with linter based on CSSLint tool,
534	510		- etc
535	511
536	512		You will find all linters in the Addon Manager: "Plugins / Addon Manager / Install". Linters are installable like other plugins but they don't add commands, they only add folders "\[CudaText\]/py/cuda_lint_*", which are automatically used by CudaLint. After you install a linter, see readme in its folder, maybe how-to-use info is written there.
537	513
538	514		### Linters - usage
539	515
540	516		To run linting, use menu item "Plugins / CudaLint / Lint", or set hotkey to this command (in CudaText Command Palette, press F9). You will see statusbar message, which tells how many errors linter found. For each found error, you'll see yellow/red bookmark (you can use usual commands for these bookmarks). Plugin also shows list of errors in the "Validate" panel (to show Validate panel, click V icon on the CudaText sidebar).
541	517
542	518		Linting can also be run by events:
543	519
544	520		- after opening file
545	521		- on saving file
546	522		- after text is changed + pause passed
547	523
548	524		Events aren't used by default (to not slowdown usual work). To use events, you must enable them in config. Call config by menu item in "Options / Settings-plugins".
549	525
550	526		### Linters - Node.js
551	527
552	528		Some linters require Node.js, so for those linters, you must install Node first. Those linters are sometimes shipped with Node modules preinstalled (in plugin folder) and sometimes you need to install Node modules via NPM. See linter's readme file for details.
553	529
554	530		- Windows: "node.exe" must be in PATH, command "node -v" must work in console.
555	531		- Linux: "nodejs" package must be installed, command "nodejs -v" must work in terminal.
556	532
557	533		### Linters - authoring
558	534
559	535		To support more lexers, it's a good idea to port linter from SublimeLinter. To port a linter, most you need is:
560	536
561	537		- Fix "imports" to use "cuda_lint" module, instead of SublimeLinter modules. cuda_lint gives almost the same classes which SublimeLinter gives. Except Node.js linter class - it's not supported yet. Usual Linter and PythonLinter classes are supported.
562	538		- Change syntax name (for Sublime Text) to CudaText lexer name, names are often different. If no such lexer for CudaText exists yet, ask for it.
563	539		- Remove in linter usage of Sublime Text API to read settings (often used in linters). You can add usage of settings via CudaText API ini_read, or via json module.
564	540		- If linter was using Node.js, take some code to run Node, from cuda_lint_csslint linter.
565	541
566	542		### Linters - per project
567	543
568	544		How to configure linters per project? In your project (Project Manager plugin), right-click root node of project treeview, call menu item "Project file / Project properties...". In this dialog, in the "Variablies" field, enter variable(s) like this:
569	545
570	546		`linter_css=csslint`
571	547
572	548		Variable prefix "linter_" required, after goes lower-case lexer name (CSS). Value of variable must be name of linter's folder (in "py" folder) without "cuda_lint_". So if linter's folder is py/cuda_lint_aaa, specify value "aaa".
573	549
574	550		In this example, CudaLint plugin allows, for mentioned lexer CSS, only linter "csslint", even if another CSS linter (e.g. "csstree") is installed and found first.
575	551
576	552		### Linters - method split_match
577	553
578	554		Linters have RegEx property in class, which must find named groups:
579	555
580	556		- "line": Line index.
581	557		- "col": Column index.
582	558		- "error": If found then CudaLint will force "error" gutter icon.
583	559		- "warning": If found then CudaLint will force "warning" gutter icon.
584	560		- "message": Message text.
585	561
586	562		Group "file" or "filename" is not used by CudaLint, but it may present for internal linter's handling, e.g. to ignore the line containing wrong filename.
587	563
588	564		Example from SublimeLinter's linter for "Luau":
589	565
590	566		``` python
591	567		class Luau(Linter):
592	568		cmd = 'luau-analyze --formatter=gnu -'
593	569		regex = r'^stdin:(?P<line>\d+)\.(?P<col>\d+)\-(?P<end_line>\d+)\.(?P<end_col>\d+): (?P<code>\w+): (?P<message>.+)'
594	570		```
595	571
596	572		Sometimes, finding "error"/"warning" named groups is hard, and class method "split_match" can help here. Example from SublimeLinter's linter for "Luau":
597	573
598	574		``` python
599	575		def split_match(self, match):
600	576		error = super().split_match(match)
601	577		error['error_type'] = 'error' if error['code'].endswith('Error') else 'warning'
602	578		return error
603	579		```
604	580
605	581		If CudaLint linter uses "split_match" it must be different. We cannot read error\['code'\] and cannot write error\['error_type'\]. We must adapt code to this:
606	582
607	583		``` python
608	584		def split_match(self, match):
609	585		matches, line, col, error, warning, message, near = super().split_match(match)
610	586		is_error = matches.group('code').endswith('Error')
611	587		error = is_error
612	588		warning = not is_error
613	589		return matches, line, col, error, warning, message, ''
614	590		```
615	591
616	592		CudaLint needs 7 tuple items in split_match() result:
617	593
618	594		- matches: RegEx match object
619	595		- line: Line index
620	596		- col: Column index
621	597		- error: Error state; if casted to True, line will have "error" icon (red)
622	598		- warning: Warning state; if casted to True, line will have "warning" icon (yellow)
623	599		- message: Message string
624	600		- near: Ignored in CudaLint
625	601
626	602		Example from CudaLint linter for Java. We override method because javac lints all referenced files, and we only want errors from the linted file.
627	603
628	604		``` python
629	605		def split_match(self, match):
630	606		if match:
631	607		if match.group('file') != self.filename:
632	608		match = None
633	609		return super().split_match(match)
634	610		```
635	611
636	612		Example from CudaLint linter for Haml. We override method to set the line/col to 0 if a linter error occurs and there is no line number.
637	613
638	614		``` python
639	615		def split_match(self, match):
640	616		match, line, col, error, warning, message, near = super().split_match(match)
641	617		if line is None:
642	618		line = col = 0
643	619		return match, line, col, error, warning, message, near
644	620		```
645	621
646	622		Example from CudaLint linter for AutoIt. Here we modify the message/error/warning.
647	623
648	624		``` python
649	625		def split_match(self, match):
650	626		split_match = super(AutoIt, self).split_match(match)
651	627		match, line, col, error, warning, message, near = split_match
652	628		message = '{} (Col {})'.format(message, col)
653	629
654	630		if match and match.group('type') == 'error':
655	631		error = 1
656	632		message = 'Error: ' + message
657	633		elif match and match.group('type') == 'warning':
658	634		warning = 1
659	635		message = 'Warning: ' + message
660	636
661	637		return match, line, col, error, warning, message, ''
662	638		```
663	639
664	640		Example from CudaLint linter for JavaScript using ESLint. We override this method to silent warning by .eslintignore settings.
665	641
666	642		``` python
667	643		def split_match(self, match):
668	644		v1message = 'File ignored because of your .eslintignore file. Use --no-ignore to override.'
669	645		v2message = 'File ignored because of a matching ignore pattern. Use --no-ignore to override.'
670	646
671	647		match, line, col, error, warning, message, near = super().split_match(match)
672	648		if message and (message == v1message or message == v2message):
673	649		return match, None, None, None, None, '', None
674	650
675	651		return match, line, col, error, warning, message, near
676	652		```
677	653
678	654		Example from CudaLint linter for PowerShell using PSScriptAnalyzer. We return the match with \` quotes transformed to '. We supress one message.
679	655
680	656		``` python
681	657		def split_match(self, match):
682	658		match, line, col, error, warning, message, near = super().split_match(match)
683	659
684	660		if message == 'no PowerShell code found at all':
685	661		match = None
686	662		else:
687	663		message = message.replace('`', '\'')
688	664
689	665		# If the message contains a complaint about a function
690	666		# and near looks like a function reference, remove the trailing
691	667		# () so it can be found.
692	668		if 'function \'' in message and near and near.endswith('()'):
693	669		near = near[:-2]
694	670
695	671		return match, line, col, error, warning, message, near
696	672		```
697	673
698	674		Example from CudaLint linter for Ruby. We override method because unrelated library files can throw errors, and we only want errors from the linted file.
699	675
700	676		``` python
701	677		def split_match(self, match):
702	678		if match:
703	679		if match.group('file') != '-':
704	680		match = None
705	681		return super(Ruby,self).split_match(match)
706	682		```
707	683
708	684		Example from CudaLint linter for CSSLint. We override method so that general errors that do not have a line number can be placed at the beginning of the code.
709	685
710	686		``` python
711	687		def split_match(self, match):
712	688		match, line, col, error, warning, message, near = super().split_match(match)
713	689		if line is None and message:
714	690		line = 0
715	691		col = 0
716	692		return match, line, col, error, warning, message, near
717	693		```
718	694
719	695		Example from CudaLint linter for Haskell. We override method to ignore errors reported in imported files.
720	696
721	697		``` python
722	698		def split_match(self, match):
723	699		match, line, col, error, warning, message, near = super().split_match(match)
724	700		match_filename = os.path.basename(match.groupdict()['filename'])
725	701		if not match_filename.startswith('_CudaLint_'):
726	702		return None, None, None, None, None, '', None
727	703		return match, line, col, error, warning, message, near
728	704		```
729	705
730	706		## CudaFormatter
731	707
732	708		CudaFormatter is plugin which uses 2nd-level plugins, "formatters", to change the source code. Each "formatter" supports one or more lexers, and provides one or more actions. For example, the Addon Manager contains two formatters for XML: XML IndentX and XML Pretty Print.
733	709
734	710		CudaFormatter is located in the "plugins" category of Addons Manager install list. 2nd-level "formatters" are located in the "formatter" category of Addons Manager install list.
735	711
736	712		For example, how to format code in XML?
737	713
738	714		- Use "Plugins / Addon Manager / Install" to install the CudaFormatter, and formatter(s) for XML. Restart CudaText.
739	715		- Open XML file (normal or "lite" lexer XML must activate).
740	716		- Use "Plugins / CudaFormatter / Formatter (menu)". This will show the menu of actions from appropriate formatter(s) for the XML (normal or "lite") lexer.
741	717
742	718		Formatters may change the entire file text or only selected text. If selection is made, formatter changes only the selection, otherwise the entire text. And special formatters called "minifiers" puts the resulting text to a separate ui-tab.
743	719
744	720		### CudaFormatter commands
745	721
746	722		Formatter (menu)
747	723		Runs formatter for current editor file. If several suitable formatters are found, menu-like dialog will suggest to choose one of them. If only single formatter is found, it will be run without confirmation.
748	724
749	725		Formatter per-lexer A...D
750	726		Runs formatter for current editor file, which has per-lexer label (A, B, C, D). Labels are configurable by another command. For example, for the label "B" you can have one formatter for C++, another formatter for HTML, and the 3rd one for CSS. All 3 formatters will be callable by the same command "Formatter per-lexer B".
751	727
752	728		Formatter cross-lexer 1...4
753	729		Runs formatter for current editor file, which has cross-lexer label (1, 2, 3, 4). For example, when you have a formatter XY assigned to the label "2", the command "Formatter cross-lexer: 2" always runs XY, ignoring the current lexer.
754	730
755	731		Minify to separate file
756	732		Finds the "minifier" formatter for the current lexer, and runs it. The resulting text is stored to separate file with name like "filename.min.css" (.css for CSS lexer). Command needs that some formatter for the current lexer is marked as "minifier" (in the formatter's install.inf file).
757	733
758	734		Configure on_save
759	735		Chooses which formatters are active on file saving. The first formatter, which is suitable for current lexer, and which has the flag "on_save" attached (via plugin configuration), will be used.
760	736
761	737		Configure per-lexer labels
762	738		Allows to assign per-lexer labels (A, B, C, D) to formatters. Labels allow to use commands "Formatter per-lexer A"..."Formatter per-lexer D", also via hotkeys.
763	739
764	740		Configure formatter
765	741		For those formatters which have configuration file, command will suggest to open global config file (in the folder "settings" of CudaText).
766	742
767	743		Configure formatter (local)
768	744		For those formatters which have configuration file, command will suggest to open "local" config (in the folder of current editor file). If local config not exists, plugin will suggest to create it from the global config.
769	745
770	746		### How to run formatter ESLint on saving
771	747
772	748		- Install from Addons Manager: "CudaFormatter"
773	749		- Install from Addons Manager: "formatter: JavaScript_JSON"
774	750
775	751		You have package "formatter.JavaScript_JSON" installed and this package gives the formatter named "... ESLint" (for JavaScript lexer). How you can auto-run this formatter on saving?
776	752
777	753		- Activate lexer JavaScript in the current document (can be empty).
778	754		- Call menu item "Plugins / CudaFormatter / Configure on_save...".
779	755		- Menu-like dialog appears. Choose item "... ESLint" and see that menu appears again, now showing that "... ESLint" item has "on_save" label. Now cancel the auto-shown menu.
780	756
781		-	~~<figure>~~
782		-	~~<img src="cudatext-fmt-onsave.png" title="cudatext-fmt-onsave.png" />~~
783		-	~~<figcaption>cudatext-fmt-onsave.png</figcaption>~~
784		-	~~</figure>~~
	757	+	![](/wiki-images/4/45/Cudatext-fmt-onsave.png)
785	758
786	759		Now for all documents with JavaScript (and "JavaScript Babel") lexer, file saving will call ESLint formatter. Note: ESLint handles only named files, and files which have ESLint configuration created in the file's folder. Document "(CudaText)/py/cuda_fmt_js/readme/readme.txt" tells more details.
787	760
788	761		### How formatter can know filename
789	762
790	763		Some formatters need to know the processing filename and/or lexer. For example, ESLint formatter must know full filename, to make the temporary file there. How can formatter know it? Module "cuda_fmt" has submodule "fmtconfig", which has variables "ed_filename" and "ed_lexer". Python code:
791	764
792	765		`from cuda_fmt import fmtconfig`\
793	766		`fn = fmtconfig.ed_filename`
794	767
795	768		## External Tools
796	769
797	770		### Introduction to External Tools
798	771
799	772		Plugin "External Tools" (ExtTools) can be installed from Addon Manager. It allows to run external programs, catch their output, and then it can:
800	773
801	774		- Display this output in the Output or Console panel of CudaText.
802	775		- Replace current editor selection with the output.
803	776		- Copy this output to a new document.
804	777		- Copy this output to Clipboard.
805	778		- And more.
806	779
807	780		Plugin adds "Tools" top menu (near "Plugins"), which has menu item "Config" to configure all tools (in the single dialog), and menu items to run all individual tools.
808	781
809		-	~~<figure>~~
810		-	~~<img src="cudatext-tools-menuitem.png" title="cudatext-tools-menuitem.png" />~~
811		-	~~<figcaption>cudatext-tools-menuitem.png</figcaption>~~
812		-	~~</figure>~~
	782	+	![](/wiki-images/8/8d/Cudatext-tools-menuitem.png)
813	783
814	784		Some external tools configs are shown in the Wiki topics below. Enter these strings in the "Tool properties" dialog.
815	785
816		-	~~<figure>~~
817		-	~~<img src="cudatext-tools-props.png" title="cudatext-tools-props.png" />~~
818		-	~~<figcaption>cudatext-tools-props.png</figcaption>~~
819		-	~~</figure>~~
	786	+	![](/wiki-images/8/8e/Cudatext-tools-props.png)
820	787
821	788		Plugin allows to customize hotkeys for all individual tools, or to use the single hotkey for different tools. The single hotkey is the hotkey of the plugin's command "Tools / Run main lexer tool". What is the "main lexer tool"? For example, you have 2 tools for lexer C++, and 3 tools for lexer HTML. You open the "Tool properties" dialog for some C++ tool, and press "Set main" button to mark that tool as "main" for C++. Then you open properties of some HTML tool, press "Set main" button to mark that tool as "main" for HTML. So now the "Tools / Run main lexer tool" can determine what is the main tool for C++ and HTML.
822	789
823		-	~~<figure>~~
824		-	~~<img src="cudatext-tools-mainlexertool.png" title="cudatext-tools-mainlexertool.png" />~~
825		-	~~<figcaption>cudatext-tools-mainlexertool.png</figcaption>~~
826		-	~~</figure>~~
	790	+	![](/wiki-images/0/06/Cudatext-tools-mainlexertool.png)
827	791
828	792		Notes:
829	793
830	794		- The disadvantage of the plugin: it cannot show tool output lines immediately when they appear, it waits until tool is terminated. Use the #Runner plugin which supports that feature.
831	795		- If you see that running of tools makes the Output panel visible, you need to fix the "Capture output" option of those tools, set it to "Ignore".
832	796
833	797		### Tool to compile by GCC
834	798
835	799		You can test how this tool works on any Linux, because GCC is preinstalled. Test the tool on C++ example, which is created from CudaText by menu "File / New from template / C++".
836	800
837	801		Properties:
838	802
839	803		- Name: C - compile
840	804		- File name: gcc
841	805		- Shell command: unchecked
842	806		- Parameters: "{FileNameOnly}" -o "{FileNameNoExt}"
843	807		- Initial folder: {FileDir}
844	808		- Lexers: C,C++
845	809		- Capture output: Output panel
846	810		- Encoding: utf_8
847	811
848	812		Optionally, configure "Pattern", so double click in the Output panel will put caret to the source code. Example of GCC error line in the Output panel, it will be handled by double click: "new.cpp:10:3: error: 'zz' was not declared in this scope".
849	813
850	814		- Pattern: (?P\<file\>\[^:\]+):(?P\<line\>\d+):(?P
851		-	~~<col>~~
852		-
853	815		\d+): .+
854	816
855	817		### Tool to run C program
856	818
857	819		Tool is for Linux, so "File name" don't have an extension. For Windows, change "File name" field to "{FileNameNoExt}.exe".
858	820
859	821		Tool will catch the program output in the Output panel, program text input will not work.
860	822
861	823		- Name: C - run
862	824		- File name: "./{FileNameNoExt}"
863	825		- Shell command: checked
864	826		- Parameters: (empty)
865	827		- Initial folder: {FileDir}
866	828		- Lexers: C,C++
867	829		- Capture output: Output panel
868	830		- Encoding: utf_8
869	831		- Pattern: (empty)
870	832
871	833		### Tool to run C program, on Windows, with input in terminal
872	834
873	835		Tool is for Windows, it allows to run compiled C/C++ program in new console window. Text input will work in this console.
874	836
875	837		Example C++ program:
876	838
877	839		``` C++
878	840		#include <stdio.h>
879	841		int main ()
880	842		{
881	843		int c;
882	844		puts ("Enter text. Include a dot ('.') in a sentence to exit:");
883	845		do {
884	846		c=getchar();
885	847		putchar (c);
886	848		} while (c != '.');
887	849		return 0;
888	850		}
889	851		```
890	852
891	853		Tool props:
892	854
893	855		- Name: C - run
894	856		- File name: cmd
895	857		- Shell command: unchecked
896	858		- Parameters: /K "{FileNameNoExt}.exe"
897	859		- Alternative value: /C "{FileNameNoExt}.exe" && pause
898	860		- Initial folder: {FileDir}
899	861		- Lexers: C,C++
900	862		- Capture output: Ignore
901	863		- Encoding: utf_8
902	864		- Pattern: (empty)
903	865
904	866		### Tool to run C program, on Linux, with input in terminal
905	867
906	868		Tool is for Linux, it allows to run compiled C/C++ program in new terminal window. Text input will work in this terminal window.
907	869
908	870		Example C++ program:
909	871
910	872		``` C++
911	873		#include <stdio.h>
912	874		int main ()
913	875		{
914	876		int c;
915	877		puts ("Enter text. Include a dot ('.') in a sentence to exit:");
916	878		do {
917	879		c=getchar();
918	880		putchar (c);
919	881		} while (c != '.');
920	882		return 0;
921	883		}
922	884		```
923	885
924	886		Tool props:
925	887
926	888		- Name: C - run
927	889		- Variant for xterm:
928	890		- File name: xterm
929	891		- Parameters: -hold -e "./{FileNameNoExt}"
930	892		- Variant for gnome-terminal:
931	893		- File name: gnome-terminal
932	894		- Parameters: -- bash -c "./{FileNameNoExt}; read -s -n1 -r -p 'Press any key... '; echo"
933	895		- Shell command: unchecked
934	896		- Initial folder: {FileDir}
935	897		- Lexers: C,C++
936	898		- Capture output: Ignore
937	899		- Encoding: utf_8
938	900		- Pattern: (empty)
939	901
940	902		### Tool to compile+run C program
941	903
942	904		In the External Tools dialog, press Join button, to join 2 tools created in above steps. Properties of joined tool:
943	905
944	906		- Name: C - make+run
945	907		- Series: C - compile; C - run
946	908		- Lexers: C,C++
947	909
948	910		### Tool to run current Batch file
949	911
950	912		Tool properties:
951	913
952	914		- Name: Run batch file
953	915		- File name: cmd.exe
954	916		- Shell command: unchecked
955	917		- Parameters: /c "{FileName}"
956	918		- Initial folder: {FileDir}
957	919		- Lexers: Batch files
958	920		- Capture output: Output panel
959	921		- Encoding: the same as file's encoding: e.g. utf_8 or cp1251 (cp1251 is Russian ANSI codepage)
960	922
961	923		### Tool to compile by Free Pascal
962	924
963	925		This tool is for Free Pascal 3.x on Linux x64.
964	926
965	927		Properties:
966	928
967	929		- Name: FPC - compile
968	930		- File name:
969	931		- for FPC installed system-wide: fpc
970	932		- for FPC installed via fpcupdeluxe: /home/user/fpcupdeluxe/fpcupdeluxe/fpc/bin/x86_64-linux/fpc.sh
971	933		- Shell command: unchecked
972	934		- Parameters: {FileNameOnly}
973	935		- Initial folder: {FileDir}
974	936		- Lexers: Pascal
975	937		- Capture output: Output panel
976	938		- Encoding: utf_8
977	939
978	940		Optionally, configure "Pattern", so double click in the Output panel will put caret to the source code. In the "Tool properties" dialog, press "Set" button near the "Pattern" and choose there ready preset for Free Pascal.
979	941
980	942		### Tool to call file-compare utility
981	943
982	944		Tools, which call file-compare utility, to compare 2 files: active files in group-1 and group-2.
983	945
984	946		#### WinMerge, KDiff, Kompare
985	947
986	948		- Name: Compare files in G1, G2
987	949		- File name: (full name of executable file)
988	950		- Shell command: unchecked
989	951		- Parameters: "{FileName_g1}" "{FileName_g2}"
990	952		- Initial folder: (empty)
991	953		- Capture output: Ignore
992	954
993	955		#### Meld
994	956
995	957		- Name: Compare files in G1, G2
996	958		- File name: (full name of executable file)
997	959		- Shell command: unchecked
998	960		- Parameters: --newtab "{FileName_g1}" "{FileName_g2}"
999	961		- Initial folder: (empty)
1000	962		- Capture output: Ignore
1001	963
1002	964		#### diff
1003	965
1004	966		- Name: Compare files in G1, G2
1005	967		- File name: diff
1006	968		- Shell command: unchecked
1007	969		- Parameters: -Nau "{FileName_g1}" "{FileName_g2}"
1008	970		- Initial folder: (empty)
1009	971		- Capture output: Copy to new document
1010	972
1011	973		### Tool to run Python scripts
1012	974
1013	975		- Name: Python3
1014	976		- File name:
1015	977		- on Windows: full path to "python.exe"
1016	978		- on Unix: python3
1017	979		- Shell command:
1018	980		- on Windows: checked
1019	981		- on Unix: unchecked
1020	982		- Parameters: "{FileNameOnly}"
1021	983		- Initial folder: {FileDir}
1022	984		- Lexers: Python
1023	985		- Capture output: Output panel
1024	986		- Encoding: utf_8
1025	987		- Pattern: \s*File "(?P\<file\>.+)", line (?P\<line\>\d+)
1026	988
1027	989		### Tool to preview HTML file in Chrome
1028	990
1029	991		- Name: Preview in Chrome
1030	992		- File name:
1031	993		- on Windows: C:\Program Files\Google\Chrome\Application\chrome.exe
1032	994		- Shell command:
1033	995		- on Windows: unchecked
1034	996		- Parameters: "{FileName}"
1035	997		- Initial folder: (empty)
1036	998		- Lexers: HTML
1037	999		- Capture output: Ignore
1038	1000
1039	1001		### Tool to open PHP documentation with given topic
1040	1002
1041	1003		Tool to open PHP documentation, in .chm format, for the word under editor's caret. For Windows only. You need to install KeyHH from <http://keyworks.helpmvp.com/> , it is stable tool mentioned on several sites. Program "keyhh.exe" will be in your system PATH.
1042	1004
1043	1005		Before making the tool, add "\$" char to word chars for PHP lexer. To do it, call "Plugins / Options Editor", in the Options Editor dialog find option "word_chars" and set it to "\$". You must save option to PHP lexer-specific config, so in the dialog you must check flag "For \[x\] Lexer", and choose lexer "PHP", and then write option value "\$" and press Enter.
1044	1006
1045	1007		Download PHP documentation in .chm format from PHP.net, google for "php_manual_en chm", it is 16M file.
1046	1008
1047	1009		Tool properties:
1048	1010
1049	1011		- Name: PHP Help
1050	1012		- File name: keyhh.exe
1051	1013		- Shell command: unchecked
1052	1014		- Parameters: -MyHelp -#klink {CurrentWord} "C:\Work\php_manual_en.chm"
1053	1015		- Initial folder: (empty)
1054	1016		- Lexers: PHP
1055	1017		- Save before: Nothing
1056	1018		- Capture output: Ignore
1057	1019
1058	1020		### Tool to open AutoIt documentation with given topic
1059	1021
1060	1022		Tool to open AutoIt documentation, in .chm format, for the word under editor's caret. For Windows only. You need to install KeyHH from <http://keyworks.helpmvp.com/> , it is stable tool mentioned on several sites. Program "keyhh.exe" will be in your system PATH.
1061	1023
1062	1024		With AutoIt installed, you also have .chm documentation, its path is usually "C:\Program Files (x86)\AutoIt3\AutoIt.chm".
1063	1025
1064	1026		Tool properties:
1065	1027
1066	1028		- Name: AutoIt Help
1067	1029		- File name: keyhh.exe
1068	1030		- Shell command: unchecked
1069	1031		- Parameters: -MyHelp -#klink {CurrentWord} "C:\Program Files (x86)\AutoIt3\AutoIt.chm"
1070	1032		- Initial folder: (empty)
1071	1033		- Lexers: AutoIt
1072	1034		- Save before: Nothing
1073	1035		- Capture output: Ignore
1074	1036
1075	1037		### Tool to open .chm documentation for all lexers
1076	1038
1077	1039		See above example about tool for PHP documentation. Create the similar tool
1078	1040
1079	1041		- File name: keyhh.exe
1080	1042		- Shell command: unchecked
1081	1043		- Parameters: -MyHelp -#klink "{CurrentWord}" "{AppDir}\\..\Docs\\{Lexer}.chm"
1082	1044		- Lexers: (empty)
1083	1045
1084	1046		This tool needs renamed .chm files: for lexer AutoIt it needs "AutoIt.chm" and so on. It needs .chm files in a single folder relative to CudaText folder.
1085	1047
1086	1048		### Tool for Google search
1087	1049
1088	1050		This is URL (special kind of tool). In the External Tools dialog, press the "URL" button, then press "Add" to add a new URL.
1089	1051
1090	1052		- Name: Google find
1091	1053		- URL:
1092	1054
1093	1055		```text
1094	1056		http://google.com/search?q={SelectedText\|q}
1095	1057		```
1096	1058
1097	1059		### Tool to open folder of current file in Windows Explorer
1098	1060
1099	1061		Tool properties:
1100	1062
1101	1063		- Name: Open cur dir in Explorer
1102	1064		- File name: explorer.exe
1103	1065		- Shell command: unchecked
1104	1066		- Parameters: {FileDir}
1105	1067		- Initial folder: {FileDir}
1106	1068
1107	1069		### Tool to go to current file in FreeCommander
1108	1070
1109	1071		- Name: Go to file in FreeCommander
1110	1072		- File name: path\to\FreeCommander.exe
1111	1073		- Shell command: unchecked
1112	1074		- Parameters: "/L={FileName}" /C
1113	1075		- Initial folder: {FileDir}
1114	1076
1115	1077		# Runner
1116	1078
1117	1079		Plugin Runner was written as an alternative to External Tools.
1118	1080
1119	1081		- Runner is more light weight.
1120	1082		- Runner supports Sublime Text 3 build-systems.
1121	1083		- Runner displays tool output immediately line-by-line as it appears (External Tools can only show the entire ready output).
1122	1084
1123	1085		Many build-systems from Sublime Text 3 were packaged and put to add-on collection, search for add-on "Many Build Systems". Only few build-systems were packaged into own separate packages because they have big EXE/Binary files. Some ST3 plugins have build-systems paired with some Python code - they are not supported.
1124	1086
1125	1087		See the [Runner documentation on GitHub](https://github.com/halfbrained/cuda_runner/blob/main/readme/readme.txt).
1126	1088
1127	1089		Here is the GIF animation which shows reaction of Runner to PHP script running:
1128	1090
1129	1091		``` php
1130	1092		<?php
1131	1093		for($i=0; $i<10; $i++) {
1132	1094		sleep(1);
1133	1095		echo "$i is here\n";
1134	1096		}
1135	1097		?>
1136	1098		```
1137	1099
1138		-	~~<figure>~~
1139		-	~~<img src="cudatext-runner-thread.gif" title="cudatext-runner-thread.gif" />~~
1140		-	~~<figcaption>cudatext-runner-thread.gif</figcaption>~~
1141		-	~~</figure>~~
	1100	+	![](/wiki-images/4/48/Cudatext-runner-thread.gif)
1142	1101
1143	1102		## Runner limitation for input
1144	1103
1145	1104		If your Python script contains the input() function:
1146	1105
1147	1106		``` python
1148	1107		s=input('enter text: ')
1149	1108		print('entered:', s)
1150	1109		```
1151	1110
1152	1111		it will run with a runtime error like this:
1153	1112
1154	1113		`enter text: Traceback (most recent call last):`\
1155	1114		` File "/home/user/a.py", line 3, in <module>`\
1156	1115		` s=input('enter text: ')`\
1157	1116		`EOFError: EOF when reading a line`
1158	1117
1159	1118		This is the limitation of the Runner plugin. To run your Python script in this case, you should call "ExTerminal" plugin (or "Terminal Plus" plugin), and enter there: "python3 myscript.py". And make sure, that ExTerminal prompt appeared in the proper folder, with your script.
1160	1119
1161	1120		## Runner tool for C
1162	1121
1163	1122		Install the add-on "build-system: Many Build Systems from ST4". It supports C lexer using GCC compiler. It works on Linux/macOS out-of-the-box, on Windows you need the command "gcc" to be in the system PATH.
1164	1123
1165	1124		This build-system has 2 commands:
1166	1125
1167	1126		- Build: only compiles
1168	1127		- Run: compiles and then runs the binary
1169	1128
1170	1129		Example C file:
1171	1130
1172	1131		``` cpp
1173	1132		#include <stdio.h>
1174	1133		int main(){
1175	1134		printf("Hello world");
1176	1135		return 0;
1177	1136		}
1178	1137		```
1179	1138
1180	1139		Example output in the CudaText Output panel (Linux):
1181	1140
1182	1141		-- [10:34:08] Building: C via GCC: a.c
1183	1142		-- Command: gcc "/home/user/a.c" -o "/home/user/a" && "/home/user/a"
1184	1143		-- Working dir: /home/user
1185	1144		Hello world
1186	1145		-- Done (0.2s), return code: 0
1187	1146
1188	1147		## Runner tool for C++
1189	1148
1190	1149		Install the add-on "build-system: C++ using G++". It supports C++ lexer using GNU C++ compiler. It works on Linux/macOS out-of-the-box, on Windows you need the command "g++" to be in the system PATH.
1191	1150
1192	1151		This build-system has 2 commands:
1193	1152
1194	1153		- compile, then run the compiled binary (default command)
1195	1154		- only run the compiled binary (it should be called from "Plugins / Runner / Build with...").
1196	1155
1197	1156		Example C++ file:
1198	1157
1199	1158		``` cpp
1200	1159		#include <iostream>
1201	1160
1202	1161		int main() {
1203	1162		std::cout << "Hello World!";
1204	1163		return 0;
1205	1164		}
1206	1165		```
1207	1166
1208	1167		Example output in the CudaText Output panel (Linux):
1209	1168
1210	1169		-- [16:41:55] Building: C++: new.cpp
1211	1170		-- Command: g++ -std=c++11 -Wall "/home/user/new.cpp" -o "/home/user/new" && "/home/user/new"
1212	1171		-- Working dir: /home/user
1213	1172		Hello World!
1214	1173		-- Done (0.8s), return code: 0
1215	1174
1216	1175		## Runner tool for PHP
1217	1176
1218	1177		How to debug for example PHP file, with Runner. Create file "\[CudaText\]/data/buildsystems/php.sublime-build" with such text:
1219	1178
1220	1179		``` json
1221	1180		{
1222	1181		"file_patterns": ["*.php"],
1223	1182		"linux": {
1224	1183		"cmd": ["php", "$file"]
1225	1184		},
1226	1185		"windows": {
1227	1186		"cmd": ["C:\\PHP_folder\\php-win.exe", "$file"]
1228	1187		}
1229	1188		}
1230	1189		```
1231	1190
1232	1191		Restart CudaText.
1233	1192
1234	1193		After opening a PHP file, call Runner main command "Build", that's it. It must show script output (in the Output panel) line-by-line, as it appears.
1235	1194
1236	1195		Example script to test:
1237	1196
1238	1197		``` php
1239	1198		<?php
1240	1199		for($i=0; $i<10; $i++) {
1241	1200		sleep(1);
1242	1201		echo "$i is here\n";
1243	1202		}
1244	1203		?>
1245	1204		```
1246	1205
1247	1206		## Runner tool for Python
1248	1207
1249	1208		In Addons Mananger, install the add-on "buildsystem: Many Build Systems from ST4". It contains the Python build-system. It even contains 2 items in the build-system:
1250	1209
1251	1210		- Build
1252	1211		- Syntax Check
1253	1212
1254	1213		After opening a Python file, call Runner main command "Build", that's it. It must show script output (in the Output panel) line-by-line, as it appears.
1255	1214
1256	1215		Example script to test:
1257	1216
1258	1217		``` python
1259	1218		import time
1260	1219
1261	1220		for i in range(5):
1262	1221		time.sleep(1)
1263	1222		print(str(i) + " is here", flush=True)
1264	1223		```
1265	1224
1266	1225		## Runner tool for Free Pascal
1267	1226
1268	1227		In Addons Manager, install the add-on "buildsystem: Free Pascal". It installs the file "\[CudaText\]/data/buildsystems/Free Pascal.sublime-build" with text like this:
1269	1228
1270	1229		``` json
1271	1230		{
1272	1231		"file_patterns": [".pp", ".pas"],
1273	1232		"file_regex": "(.+?)\$(\\d+),(\\d+)\$\\s(.+)$",
1274	1233		"working_dir": "$file_path",
1275	1234		"name": "Compile",
1276	1235		"cmd": ["/home/user/fpcupdeluxe/fpcupdeluxe32/fpc/bin/x86_64-linux/fpc.sh", "$file_name"],
1277	1236		"variants": [
1278	1237		{
1279	1238		"name": "Run",
1280	1239		"cmd": ["./$file_base_name"]
1281	1240		}
1282	1241		]
1283	1242		}
1284	1243		```
1285	1244
1286	1245		In this file, you need to adjust the path to "fpc.sh", according to your [[fpcupdeluxe]] folder. Restart CudaText.
1287	1246
1288	1247		After opening a Pascal file, call Runner main command "Build", that's it. The "Build" command example output:
1289	1248
1290	1249		-- [20:07:55] Building: Free Pascal: new.pas
1291	1250		-- Command: ['/home/user/fpcupdeluxe/fpcupdeluxe32/fpc/bin/x86_64-linux/fpc.sh', 'new.pas']
1292	1251		-- Working dir: /home/user
1293	1252		Free Pascal Compiler version 3.2.3-425-gebc55c0f4e-dirty [2021/09/09] for x86_64
1294	1253		Copyright (c) 1993-2021 by Florian Klaempfl and others
1295	1254		Target OS: Linux for x86-64
1296	1255		Compiling new.pas
1297	1256		Linking new
1298	1257		3 lines compiled, 0.1 sec
1299	1258		-- Done (0.2s), return code: 0
1300	1259
1301	1260		The config above also gives the "Run" command for the compiled binary - in the menu of "Plugins / Runner / Build with...". The "Run" command example output:
1302	1261
1303	1262		-- [20:09:09] Building: Free Pascal: new.pas
1304	1263		-- Command: ['./new']
1305	1264		-- Working dir: /home/user
1306	1265		Hello world.
1307	1266		-- Done (-0.0s), return code: 0
1308	1267
1309	1268		## Runner tool for Cobol
1310	1269
1311	1270		In Addons Manager, install the lexer "Cobol".
1312	1271
1313	1272		Let's make build-system for GnuCOBOL on Windows. Install GnuCOBOL, usually [from this webpage](https://www.arnoldtrembley.com/GnuCOBOL.htm), to "C:\GnuCOBOL". You must have file "C:\GnuCOBOL\bin\cobc.exe".
1314	1273
1315	1274		Create Batch script "c:\GnuCOBOL\bin\runcobol.cmd" with such content:
1316	1275
1317	1276		set Path=c:\gnucobol\bin
1318	1277		set COB_CONFIG_DIR=c:\gnucobol\config
1319	1278		set COB_COPY_DIR=c:\gnucobol\copy
1320	1279		set COB_INCLUDE_PATH=c:\gnucobol\include
1321	1280		set COB_LIB_PATH=c:\gnucobol\lib
1322	1281		cobc -x -std=mf %1
1323	1282
1324	1283		Create build-system file "\[CudaText\]\data\buildsystems\cobol.sublime-build":
1325	1284
1326	1285		``` json
1327	1286		{
1328	1287		"file_patterns": [".cob", ".cbl", "*.cpy"],
1329	1288		"name": "Compile",
1330	1289		"cmd": ["cmd.exe", "/c", "c:\\GnuCOBOL\\bin\\runcobol.cmd", "$file"],
1331	1290		"working_dir": "$file_path",
1332	1291		"file_regex": "^([^:]+):([0-9]+):",
1333	1292		"variants": [
1334	1293		{
1335	1294		"name": "Run",
1336	1295		"cmd": ["$file_path/$file_base_name.exe"]
1337	1296		}
1338	1297		]
1339	1298		}
1340	1299		```
1341	1300
1342	1301		Note: the build-system gives usual command "Build" and additional command "Run" to execute the .exe file, and "Run" has forward slash (Unix slash): "\$file_path/\$file_base_name.exe". Forward slash is required here, because with backslash Runner will fail to run the .exe (it will not expand the macro \$file_base_name).
1343	1302
1344	1303		Now running the "Plugins / Runner / Build" can give text in the "Output panel" like this:
1345	1304
1346	1305		-- [07:49:02] Building: cobol: test.cbl
1347	1306		-- Command: ['cmd.exe', '/c', 'c:\\GnuCOBOL\\bin\\runcobol.cmd', 'C:\\Work\\test.cbl']
1348	1307		-- Working dir: C:\Work
1349	1308
1350	1309		C:\Work>set Path=c:\gnucobol\bin
1351	1310		C:\Work>set COB_CONFIG_DIR=c:\gnucobol\config
1352	1311		C:\Work>set COB_COPY_DIR=c:\gnucobol\copy
1353	1312		C:\Work>set COB_INCLUDE_PATH=c:\gnucobol\include
1354	1313		C:\Work>set COB_LIB_PATH=c:\gnucobol\lib
1355	1314		C:\Work>cobc -x -std=mf C:\Work\test.cbl
1356	1315		C:\Work\test.cbl:1: error: invalid indicator 'u' at column 7
1357	1316		C:\Work\test.cbl:2: warning: line not terminated by a newline [-Wmissing-newline]
1358	1317		C:\Work\test.cbl:3: warning: PROGRAM-ID header missing [-Wothers]
1359	1318		-- Done (0.3s), return code: 1
1360	1319
1361	1320		# FindInFiles
1362	1321
1363	1322		This plugin implements searching in many files, starting from custom folder. CudaText doesn't have the built-in feature to search in many files, and seems it will not have it in future, because FindInFiles is so powerful, it even has the Configuration dialog with dozens of options.
1364	1323
1365	1324		Project Manager plugin allows to call FindInFiles functionality. Focus a folder in Project Manager, call context menu, and then "Selected directory / Find in directory..." menu item.
1366	1325
1367	1326		## How to find/replace in all UI-tabs
1368	1327
1369	1328		FindInFiles 4 supports search inside all UI-tabs. Hover mouse over "From:" label in the dialog, tooltip will appear. Tooltip says what to enter in the nearest input-field. Enter one of these strings in the "From" field:
1370	1329
1371	1330		`<tabs>`\
1372	1331		`{t}`
1373	1332
1374		-	~~<figure>~~
1375		-	~~<img src="cudatext-findinfiles-intabs.png" title="cudatext-findinfiles-intabs.png" />~~
1376		-	~~<figcaption>cudatext-findinfiles-intabs.png</figcaption>~~
1377		-	~~</figure>~~
	1333	+	![](/wiki-images/a/ab/Cudatext-findinfiles-intabs.png)
1378	1334
1379	1335		And in the "Files" field, enter "*" for all files.
1380	1336
1381	1337		To discover more features of FindInFiles dialog, hover mouse over other labels/buttons.
1382	1338
1383	1339		You can also replace in all UI-tabs, of course. To do it, fill all input fields in the FindInFiles main dialog, but instead of pressing "Find" - press "=" button and then choose "Replace with..." from appeared popup menu. Additional dialog will appear to confirm you replacement request, press "Replace" button there.
1384	1340
1385	1341		Additionally, CudaText gives built-in "Replace in all tabs" feature, it is the button "Rep global" in the built-in Find/Replace dialog. This is documented in the main CudaText wiki page.
1386	1342
1387	1343		## How to use FindInFiles 4
1388	1344
1389	1345		FindInFiles v4 has two panels. Top panel shows found filenames, line by line. Bottom panel shows the entire document of one of the selected filenames. When you single click on a line of top panel, the bottom panel shows the content of a clicked file. When you double click the line again, the main editor of CudaText jumps to that location.
1390	1346
1391	1347		## FiF3 and FiF4: comparison and future
1392	1348
1393	1349		CudaText has two plugins to search in files/tabs:
1394	1350
1395	1351		- FindInFiles v3 (FiF3)
1396	1352		- FindInFiles v4 (FiF4)
1397	1353
1398	1354		Important: FiF3 is almost frozen. Only serious bugs will be fixed. No plans to hide/delete FiF3. FiF4 supersedes FiF3.
1399	1355
1400	1356		Detailed comparison.
1401	1357
1402	1358		Common features:
1403	1359
1404	1360		- Speed of search. Speed of FiF3 is stable. FiF4 can search faster or slower depending on the settings. In the "slow" mode FiF4 gives more complex Results or uses more complex filters.
1405	1361		- Encoding detection. FiF4 allows to set more flexible plan (see submenu "=/Encoding plan").
1406	1362		- Presets. Both versions allow to define and restore named set of search parameters. FiF4 allows to run dialog and start immediate search with parameters from a preset (see main menu command "Find by preset..."). FiF4 allows to restore \[pre\]previous parameters (runtime auto saving).
1407	1363		- Results/Source. FiF3 allows to put Results in old/new tab or in dialog editor control. FiF4 allows to put Results only in dialog editor control and has a command to copy Results to new tab. Both allow to open the source file for specified fragment in new tab. FiF3 can place Results and Source vertically or horizontally. FiF4 has only one way.
1408	1364		- FiF3 has commands to count fragments and to show only filenames. FiF4 skips such commands as unnecessary.
1409	1365		- FiF3 can save dialog layouts. FiF4 saves layout as part of preset.
1410	1366		- Like FiF3, FiF4 has the "Replace" functionality.
1411	1367		- Like FiF3, FiF4 can search in project folder(s).
1412	1368
1413	1369		Main new features:
1414	1370
1415	1371		- FiF4 can report the found fragment with its around lines (see "-?+?" button).
1416	1372		- FiF4 can search multi-line fragments (see "+" button).
1417	1373		- FiF4 can search in many start folders.
1418	1374		- FiF4 allows to use lexer data to filter and report fragments (in/out string/comment, lexer path).
1419	1375		- FiF4 allows to show lines in the Results with its lexer colors from source files.
1420	1376		- FiF4 allows to use macro-variables (OS environments, properties of current file/tab and free-set names) in any editable fields .
1421	1377		- FiF4 has statusbar to show statistics of the last search: folders/files/fragments/timing.
1422	1378		- FiF4 allows to reformat Results (change tree type and more) without new search.
1423	1379		- FiF4 allows to show modification time of files in the Results.
1424	1380
1425	1381		# Terminal
1426	1382
1427	1383		There are currently 3 terminal plugins:
1428	1384
1429	1385		- Terminal: simplest plugin.
1430	1386		- Terminal Plus: most feature-rich plugin, but its UI may be too complex for beginners.
1431	1387		- ExTerminal: middle in the feature set, but its UI is very simple.
1432	1388
1433	1389		Let's take ExTerminal plugin, and show how to perform some task with it, under Linux. Task: run Python script which uses 'input()' function. The simpest Terminal plugin cannot handle 'input()' function, but ExTerminal will work good. Let's take Python script with content:
1434	1390
1435	1391		``` python
1436	1392		x = int(input('Enter x: '))
1437	1393		w = int(input('Enter w: '))
1438	1394		print(x*w)
1439	1395		```
1440	1396
1441	1397		Steps:
1442	1398
1443	1399		- Save our script to file ~/myfolder/tt.py
1444	1400		- Install ExTerminal, restart CudaText
1445	1401		- Run ExTerminal by clicking its bottom-bar-icon
1446	1402		- In ExTerminal, enter "cd ~/myfolder", so file tt.py will be in the current directory. You can enter "ls *.py" to see all python files in the current directory.
1447	1403		- In ExTerminal, enter "python3 tt.py"
1448	1404
1449	1405		Script should work and show 2 input-prompts.
1450	1406
1451	1407		`user@user:~/myfolder$ ls *.py`\
1452	1408		`a.py test.py tt.py`\
1453	1409		`user@user:~/myfolder$ python3 tt.py`\
1454	1410		`Enter x: 10`\
1455	1411		`Enter w: 20`\
1456	1412		`200`
1457	1413
1458	1414		How to open ExTerminal in the directory of the current editor file? You can do this:
1459	1415
1460	1416		- Hover mouse over ExTerminal button in the bottom-bar. It must show tooltip like "ExTerminal 1".
1461	1417		- Right-click this button, popup menu appears, from the popup menu choose "New terminal". This will create another ExTerminal button+panel. New panel has the directory of the current editor file.
1462	1418		- To not produce too much ExTerminal buttons, use "Close terminal" from the popup menu.
1463	1419
1464	1420		# Configure Menu
1465	1421
1466	1422		Plugin "Configure Menu" (in Addons Manager) allows to change CudaText menus. You can add items to the CudaText top-menu, top menu submenu, editor context-menu, tab header context-menu and dropdown submenu of toolbar buttons. Plugin can create file (settings/menu.json) with default menu configuration, which you edit to customize all menus. File has items like:
1467	1423
1468	1424		``` json
1469	1425		,{"cap":"&Save", "cmd":"cmd_FileSave"}
1470	1426		```
1471	1427
1472	1428		How to add here built-in commands? See identifiers of CudaText commands in the file "py/cudatext_cmd.py", they have prefixes "cCommand_" (low level commands) and "cmd_" (high level commands). For example, "cmd_FileSave" is the command to save current file.
1473	1429
1474	1430		How to add here plugin commands? For example, you have plugin "Comments", it is in the folder "py/cuda_comments". See plugin's file install.inf, and find there needed Python methods. Then add in the "settings/menu.json" item like this:
1475	1431
1476	1432		``` json
1477	1433		,{"cap":"Toggle line comment", "cmd":"module=cuda_comments;cmd=cmt_toggle_line_body;"}
1478	1434		```
1479	1435
1480	1436		Here "cuda_comments" is plugin folder name, and "cmt_toggle_line_body" is Python method from install.inf.
1481	1437
1482	1438		You can add items to the CudaText top-menu and/or context-menu, it is different sections in "menu.json". Possible root sections in "menu.json" are listed in the API wiki page: [[CudaText API\|CudaText_API#menu_proc_-_Menu_id]].
1483	1439
1484	1440		Example screenshot shows how "menu.json" will look with new items for context-menu:
1485	1441
1486		-	~~<figure>~~
1487		-	~~<img src="cudatext-editing-context-menu.png" title="cudatext-editing-context-menu.png" />~~
1488		-	~~<figcaption>cudatext-editing-context-menu.png</figcaption>~~
1489		-	~~</figure>~~
	1442	+	![](/wiki-images/5/5e/Cudatext-editing-context-menu.png)
1490	1443
1491	1444		Example screenshot also shows tricks: how to write items for "External Tools" items and for "Macros" items: see lines with "cuda_exttools" and with "cuda_macros". Here they are:
1492	1445
1493	1446		``` json
1494	1447		{"cap": "SomeToolName", "cmd": "module=cuda_exttools;cmd=run;info=174420;"}
1495	1448		,{"cap": "SomeMacroName", "cmd": "module=cuda_macros;cmd=run;info=87635;"}
1496	1449		```
1497	1450
1498	1451		These special lines need special integer IDs. You can find these IDs in the config files of both plugins: External Tools / Macros. For example, to find Extertal Tools IDs, open "settings/exttools.json". Here is a fragment of this file, which shows "id" value of the tool "C - compile":
1499	1452
1500	1453		``` json
1501	1454		{
1502	1455		"ver": "20151209",
1503	1456		"list": [
1504	1457		{
1505	1458		"id": 254653,
1506	1459		"nm": "C - compile",
1507	1460		"file": "gcc",
1508	1461		"ddir": "{FileDir}",
1509	1462		"shll": false,
1510	1463		"prms": "\"{FileNameOnly}\" -o \"{FileNameNoExt}\"",
1511	1464		"savs": "N",
1512	1465		"rslt": "OP",
1513	1466		"encd": "utf_8",
1514	1467		"lxrs": "C,C++",
1515	1468		"pttn": "(?P<file>[\\w\\.\\-]+):(?P<line>\\d+):(?P<col>\\d+):.+",
1516	1469		},
1517	1470		```
1518	1471
1519	1472		# Config Toolbar
1520	1473
1521	1474		Plugin allows to change the content of the main (horizontal) toolbar: hide standard buttons, add user buttons for any actions, customize icons and nesting of menu items.
1522	1475
1523	1476		For example, you installed two plugins:
1524	1477
1525	1478		- Config Toolbar
1526	1479		- Color Text
1527	1480
1528	1481		And you want to call command "Apply bold" (from "Color Text") via toolbar. How to add such a button? Picture highlights your steps.
1529	1482
1530		-	~~<figure>~~
1531		-	~~<img src="cudatext-config-toolbar.png" title="cudatext-config-toolbar.png" />~~
1532		-	~~<figcaption>cudatext-config-toolbar.png</figcaption>~~
1533		-	~~</figure>~~
	1483	+	![](/wiki-images/8/81/Cudatext-config-toolbar.png)
1534	1484
1535	1485		- From the Command Palette, call the item "Config Toolbar: Configure buttons...". Dialog will appear from the plugin.
1536	1486		- In the "Configure toolbar" dialog, press "Add item...", and fill fields of new dialog "Button properties".
1537	1487		- Caption
1538	1488		- Tooltip (optional)
1539	1489		- Command: should be "cuda_color_text.format_bold" for our task. You cannot type this text, instead press "Choose command" and find the command there, in the Command Palette-like menu.
1540	1490		- Icon (optional)
1541	1491
1542	1492		# Intext Bookmarks
1543	1493
1544	1494		Plugin allows to place special marks, and to show Goto dialog for its special marks. These are not usual CudaText bookmarks, but text lines, which are recognized only by this plugin.
1545	1495
1546	1496		Plugin adds menu items in "Plugins / In-text Bookmarks":
1547	1497
1548	1498		- List for current tab -- show all marks in the current document
1549	1499		- List for all tabs -- show all marks in all opened UI-tabs
1550	1500		- Go to next
1551	1501		- Go to previous
1552	1502		- Add -- add a new mark at caret position
1553	1503
1554	1504		"Special" lines are supported even for files without lexer, and files with lexer if lexer doesn't support comments. For such poor files, plugin will add special lines like "//NOTE: comment_text".
1555	1505
1556	1506		You can customize that special lines, using plugin configuration dialog: menu item "Options / Settings-plugins / In-text Bookmarks". Dialog gives such options:
1557	1507
1558	1508		- Bookmark signs: NOTE: NB! TODO: todo: todo. FIX:
1559	1509		- Comment sign: //
1560	1510
1561	1511		That configuration means that for "poor" files (without lexer, or with lexer without line comments), plugin uses lines beginning with "//NOTE:" or "//NB!" or "//TODO:" etc. For files with rich lexers, plugin uses lexer's line-comment prefix.
1562	1512
1563	1513		# Color Text
1564	1514
1565	1515		Plugin "Color Text" gives several commands (in the Plugins menu) to add coloring to text ranges. Plugin uses the selected text, without selection it uses word under first caret. On applying the coloring, plugin marks file as "modified". Plugin is suitable for files with any lexer, it adds its colors over the lexer highlight.
1566	1516
1567		-	~~<figure>~~
1568		-	~~<img src="cudatext-color-text.png" title="cudatext-color-text.png" />~~
1569		-	~~<figcaption>cudatext-color-text.png</figcaption>~~
1570		-	~~</figure>~~
	1517	+	![](/wiki-images/0/0b/Cudatext-color-text.png)
1571	1518
1572	1519		The data of coloring is saved to additional 'helper file' with extension .cuda-colortext, in the folder of the original file. After you delete this 'helper file', plugin will not load its data on next start.
1573	1520
1574	1521		Not only background color can be changed, but also border color, and font styles (bold, italic, stikeout). To specify colors/styles, you have to edit the plugin config file. To edit the config file, call menu item "Options / Settings-plugins / Color Text". Config file has sections for colors/styles, and usual options:
1575	1522
1576	1523		- "all_words": Colorize all occurrences of fragment.
1577	1524		- "case_sensitive": Case sensitive search for other occurrences.
1578	1525		- "whole_words": Colorize only those occurrences, which are whole words.
1579	1526		- "show_on_map": Show added colored marks also on micro-map.
1580	1527
1581	1528		# Insert Pics
1582	1529
1583	1530		CudaText gives the plugin API to show pictures between the text lines. These spaces between lines are called "gaps". Plugin "Insert Pics" exists to show picture files in gaps. It saves pictures in the helper files (using Base64 encoding), with extension .cuda-pic, near the original text file. Files with pictures look like this:
1584	1531
1585		-	~~<figure>~~
1586		-	~~<img src="cudatext-insert-pics.png" title="cudatext-insert-pics.png" />~~
1587		-	~~<figcaption>cudatext-insert-pics.png</figcaption>~~
1588		-	~~</figure>~~
	1532	+	![](/wiki-images/8/8f/Cudatext-insert-pics.png)
1589	1533
1590	1534		- You can use any lexer for files with pictures.
1591	1535		- You can add the unlimited number of pictures. But only one picture per "gap".
1592	1536		- You can add/delete pictures later, using plugin's commands in menu "Plugins / Insert Pics".
1593	1537		- When you delete the "helper file" (located in the same folder), all pictures will be lost for plugin.
1594	1538
1595	1539		# Complete From Text
1596	1540
1597	1541		Plugin allows to show auto-completion listbox with words from the current file (or all opened UI-tabs, by option). E.g. if you typed "op" and press Ctrl+Space (default auto-completion hotkey), it may suggest previously mentioned words "operations", "opinion", "option" etc. Plugin is not smart like "LSP Client" plugin, so expect lot of 'false positives' in its listbox.
1598	1542
1599		-	~~<figure>~~
1600		-	~~<img src="cudatext-complete-from-text.png" title="cudatext-complete-from-text.png" />~~
1601		-	~~<figcaption>cudatext-complete-from-text.png</figcaption>~~
1602		-	~~</figure>~~
	1543	+	![](/wiki-images/1/11/Cudatext-complete-from-text.png)
1603	1544
1604	1545		In the picture above, one word was taken from C lexer's C.acp file (this is a feature).
1605	1546
1606	1547		Plugin is preconfigured to work with small set of lexers: none-lexer, Ini files, Markdown, reStructuredText, Properties. Here is how to use it for let's say "C" lexer:
1607	1548
1608	1549		- Install the plugin
1609	1550		- Call menu item "Options / Settings-plugins / Complete From Text"
1610	1551		- This opens the "plugins.ini" file
1611	1552		- Find section "\[complete_from_text\]", add ",c" (without quotes) to the line "lexers="
1612	1553		- Restart CudaText
1613	1554
1614	1555		Plugin has more options in that "plugins.ini" file:
1615	1556
1616	1557		- 'lexers': comma-separated lexer names, ie for which lexers to work; specify none-lexer as '-'.
1617	1558		- 'min_len': minimal word length, words of smaller length will be ignored.
1618	1559		- 'max_lines': if document has bigger count of lines, ignore this document.
1619	1560		- 'case_sens': case-sensitive; words starting with 'A' will be ignored when you typed 'a'.
1620	1561		- 'no_comments': ignore words inside "syntax comments" (lexer specific).
1621	1562		- 'no_strings': ignore words inside "syntax strings" (lexer specific).
1622	1563		- 'what_editors': which documents (ie UI tabs) to read to get words. Values:
1623	1564		- 0: only current document.
1624	1565		- 1: all opened documents.
1625	1566		- 2: all opened documents with the same lexer.
1626	1567		- 'use_acp': add suggestions from autocomplete files in 'data/autocomplete'
1627	1568		- 'case_split': expands suggestions, autocompletion for 'AB' will include 'AzzBzz', so to get 'ValueError' just typing 'VE' (or 'VaE', 'VErr', 'ValErr' etc.) and calling on autocompletion will suggest it.
1628	1569		- 'underscore_split': expands suggestions, autocompletion for 'AB' will include 'AZZ_BZZ', so to get 'supports_bytes_environ' just typing 'sb' (or 'sbe', 'supbyenv' etc.) and calling on autocompletion will suggest it.
1629	1570
1630	1571		Plugin supports CudaText option "nonword_chars", so for example words with '\$' char are also added to completions, if CudaText option is configured so.
1631	1572
1632	1573		# Embedded Editor
1633	1574
1634	1575		Plugin "Embedded Editor" shows "included" file in embedded editor - additional editor UI control is shown between the text lines. For example, you can open included CSS / JS files while editing the HTML file.
1635	1576
1636		-	~~<figure>~~
1637		-	~~<img src="cudatext-embedded-editor.png" title="cudatext-embedded-editor.png" />~~
1638		-	~~<figcaption>cudatext-embedded-editor.png</figcaption>~~
1639		-	~~</figure>~~
	1577	+	![](/wiki-images/5/55/Cudatext-embedded-editor.png)
1640	1578
1641	1579		It adds menu item to show/hide embedded editor in the current document, for the current caret position: "Plugins / Embedded Editor / Toggle".
1642	1580
1643	1581		By default, plugin searches for the included filename inside double-quotes, surrounding the caret position. This works OK for HTML and many other documents.
1644	1582
1645	1583		For example, when you have opened file "/folder/file.html", and placed caret inside first double-quotes:
1646	1584
1647	1585		``` html
1648	1586		<link href="css/style.css" rel="stylesheet" type="text/css"/>
1649	1587		```
1650	1588
1651	1589		then embedded editor will be opened for file "/folder/css/style.css".
1652	1590
1653	1591		The search can be configured, though. For example, plugin can be used in Pascal files for include-directives:
1654	1592
1655	1593		``` pascal
1656	1594		{$I path/filename.inc}
1657	1595		```
1658	1596
1659	1597		Plugin has 2 config files, you will see 2 menu items in the "Options / Settings-plugins / Embedded Editor". Read more about config files in the readme.txt of plugin.
1660	1598
1661	1599		# Breadcrumbs
1662	1600
1663	1601		Plugin "Breadcrumbs" shows the toolbar widget (modern name is breadcrumb bar) below or on top of the editor for quick file-system navigation. For example, when you have active editor with filename "/home/user/mydir/myfile.ext", widget shows buttons:
1664	1602
1665	1603		[ home / user / mydir / myfile.ext ]
1666	1604
1667	1605		It can also show the "~" button for the home directory (by option):
1668	1606
1669	1607		[ ~ / mydir / myfile.ext ]
1670	1608
1671		-	~~<figure>~~
1672		-	~~<img src="cudatext-breadcrumbs.png" title="cudatext-breadcrumbs.png" />~~
1673		-	~~<figcaption>cudatext-breadcrumbs.png</figcaption>~~
1674		-	~~</figure>~~
	1609	+	![](/wiki-images/b/be/Cudatext-breadcrumbs.png)
1675	1610
1676	1611		Clicking on each button shows the popup with file-system listing, showing the folder containing the clicked item. This popup supports basic tree-view navigation, you can click files there to open them in CudaText.
1677	1612
1678	1613		Plugin can also show buttons for Code-Tree nodes. This must be enabled first in the config file - turn on the option "code_navigation". Clicking the buttons from the code-tree shows the same tree-popup but with a different content - with symbols of the documents. Clicking the nodes in the tree-popup scrolls the document to different symbols.
1679	1614
1680	1615		# Spell Checker
1681	1616
1682	1617		Frequent question: how to make spell checking 'live', ie run it after each change? Do this:
1683	1618
1684	1619		- Menu "Options / Settings-plugins / Spell Checker / Configure events": check there all events.
1685	1620		- Menu "Options / Settings-plugins / Spell Checker / Configure": check that your file-extension is enabled in the option "file_extension_list". Option value "*" means that all extensions are enabled.
1686	1621		- Restart CudaText.
1687	1622
1688	1623		Now checking should be 'live'. Note: it needs a pause after text editing (about 1 second), because it uses "on_change_slow" to avoid slowdown on editing.
1689	1624
1690	1625		# LSP Client
1691	1626
1692	1627		Plugin "LSP Client" allows to use Microsoft LSP protocol in CudaText with servers for many languages. It requires that CudaText uses Python 3.6 or newer (otherwise you will see the error messagebox).
1693	1628
1694	1629		LSP Client gives several commands in the "Plugins / LSP Client", and all these commands work only if server supports them. Some of LSP commands are:
1695	1630
1696	1631		- Auto-completion: integrated with CudaText command "Auto-completion menu" (in the Command Palette).
1697	1632		- Go to definition: integrated with CudaText command "Go to definition" (in the Command Palette, and in the editor context menu).
1698	1633		- Function signature help: integrated with CudaText command "Show function hint" (in the Command Palette).
1699	1634		- Hover: shows the tooltip when you hover mouse above identifiers. You need the Ctrl key pressed while you hover.
1700	1635
1701		-	~~<figure>~~
1702		-	~~<img src="cudatext-lsp-hover_.png" title="cudatext-lsp-hover_.png" />~~
1703		-	~~<figcaption>cudatext-lsp-hover_.png</figcaption>~~
1704		-	~~</figure>~~
	1636	+	![](/wiki-images/b/b0/Cudatext-lsp-hover_.png)
1705	1637
1706	1638		- Find references: finds all locations where an identifier (under first caret) is used and shows menu with locations.
1707	1639
1708		-	~~<figure>~~
1709		-	~~<img src="cudatext-lsp-refs.png" title="cudatext-lsp-refs.png" />~~
1710		-	~~<figcaption>cudatext-lsp-refs.png</figcaption>~~
1711		-	~~</figure>~~
	1640	+	![](/wiki-images/c/ce/Cudatext-lsp-refs.png)
1712	1641
1713	1642		- Code linting: checking the correctness of the source code, places underlines and/or bookmarks on "incorrect lines". This feature is also implemented in #CudaLint and usually it works better/faster there.
1714	1643		- Document formatting: formatting of the source code by LSP server. This feature is also implemented in #CudaFormatter and usually it works better/faster there.
1715	1644
1716	1645		All LSP servers should have a homepage with description of their functions, and installation information.
1717	1646
1718	1647		In the server config "lsp_*.json", key "lexers", you need to specify the mapping between CudaText lexer names and LSP language names. For example, while CudaText lexer name is "Bash script", LSP language name is "bash". And while CudaText lexer name is "C#", LSP language name is "csharp".
1719	1648
1720	1649		``` json
1721	1650		{
1722	1651		"lexers": {
1723	1652		"C#": "csharp"
1724	1653		},
1725	1654		...
1726	1655		}
1727	1656		```
1728	1657
1729	1658		LSP Client also has the settings file, use menu item to open it: "Options / Settings-plugins / LSP Client".
1730	1659
1731	1660		## LSP server for Python
1732	1661
1733	1662		Project homepage is <https://github.com/python-lsp/python-lsp-server> . Note that this is fork of old, unmaintained, project "PyLS". Server supports:
1734	1663
1735	1664		- Auto-completion
1736	1665		- Go to definition
1737	1666		- Function signature help
1738	1667		- Hover
1739	1668		- Find references
1740	1669		- Code linting
1741	1670		- Document formatting
1742	1671
1743	1672		Use "pip" to install the server:
1744	1673
1745	1674		`pip install python-lsp-server`\
1746	1675
1747	1676		This will expose the command "pylsp" on your PATH. Confirm that installation succeeded by running:
1748	1677
1749	1678		`pylsp --help`\
1750	1679
1751	1680		Create the file "\[CudaText\]/settings/lsp_py.json" with text like this:
1752	1681
1753	1682		``` json
1754	1683		{
1755	1684		"lexers": {
1756	1685		"Python": "python"
1757	1686		},
1758	1687		"cmd_windows": ["pylsp.exe"],
1759	1688		"cmd_macos": ["pylsp"],
1760	1689		"cmd_unix": ["pylsp"]
1761	1690		}
1762	1691		```
1763	1692
1764	1693		Open some Python script, and call some commands of LSP Client. It will run the server, and it should work.
1765	1694
1766	1695		## LSP server for Python, pyright
1767	1696
1768	1697		1\. Install the server:
1769	1698
1770	1699		`pip install pyright`
1771	1700
1772	1701		- On Windows, add folder of "pyright-langserver.exe" to system PATH.
1773	1702		- On Linux/Unix, get the full path of the program, we will use this path in the next step.
1774	1703
1775	1704		`which pyright-langserver`
1776	1705
1777	1706		It outputs on Ubuntu:
1778	1707
1779	1708		`/home/user/.local/bin/pyright-langserver`
1780	1709
1781	1710		- On macOS, install pyright via PIP, not via Homebrew. On macOS, see what output you have after you call this command: "nodeenv env". If you see certificate error, try to fix it with the following command:
1782	1711
1783	1712		`/Applications/Python\ 3.10/Install\ Certificates.command`
1784	1713
1785	1714		2\. Create config (CudaText)/settings/lsp_pyright.json:
1786	1715
1787	1716		``` json
1788	1717		{
1789	1718		"lexers": {
1790	1719		"Python": "python"
1791	1720		},
1792	1721		"cmd_windows": ["pyright-langserver.exe", "--stdio"],
1793	1722		"cmd_unix": ["/home/user/.local/bin/pyright-langserver", "--stdio"],
1794	1723		"cmd_macos": ["/Library/Frameworks/Python.framework/Versions/3.10/bin/pyright-langserver", "--stdio"],
1795	1724		"log_stderr": true
1796	1725		}
1797	1726		```
1798	1727
1799	1728		3\. To disable type checking (which may be confusing), add key "settings" to the above config:
1800	1729
1801	1730		``` json
1802	1731		"settings": {
1803	1732		"python.analysis": {
1804	1733		"typeCheckingMode": "off"
1805	1734		}
1806	1735		}
1807	1736		```
1808	1737
1809	1738		## LSP server for JavaScript/ReactJS
1810	1739
1811	1740		- Install lexer for ReactJS: "JavaScript Babel", from "Addons Manager".
1812	1741		- Install TypeScript and the LSP server. In Terminal:
1813	1742
1814	1743		`npm install -g typescript typescript-language-server`
1815	1744
1816	1745		- Create CudaText LSP config: file "settings/lsp_js.json" with such content:
1817	1746
1818	1747		``` json
1819	1748		{
1820	1749		"name": "JavaScript",
1821	1750		"lexers": {
1822	1751		"JavaScript": "javascript",
1823	1752		"JavaScript Babel": "javascriptreact"
1824	1753		},
1825	1754		"cmd_unix": [
1826	1755		"typescript-language-server",
1827	1756		"--stdio"
1828	1757		],
1829	1758		"cmd_windows": [
1830	1759		"typescript-language-server.cmd",
1831	1760		"--stdio"
1832	1761		]
1833	1762		}
1834	1763		```
1835	1764
1836	1765		This assumes that "typescript-language-server" is in the PATH (it is true on Ubuntu). For Windows, you need to find the folder of "typescript-language-server.cmd" and add it to PATH.
1837	1766
1838	1767		## LSP server for TypeScript
1839	1768
1840	1769		- Install TypeScript lexer from "Addons Manager".
1841	1770		- Install TypeScript and the LSP server. In Terminal:
1842	1771
1843	1772		`npm install -g typescript typescript-language-server`
1844	1773
1845	1774		- Create CudaText LSP config: file "settings/lsp_ts.json" with such content:
1846	1775
1847	1776		``` json
1848	1777		{
1849	1778		"lexers": {
1850	1779		"TypeScript": "ts"
1851	1780		},
1852	1781		"cmd_unix": [
1853	1782		"typescript-language-server",
1854	1783		"--stdio"
1855	1784		],
1856	1785		"cmd_windows": [
1857	1786		"typescript-language-server.cmd",
1858	1787		"--stdio"
1859	1788		]
1860	1789		}
1861	1790		```
1862	1791
1863	1792		This assumes that "typescript-language-server" is in the PATH (it is true on Ubuntu). For Windows, you need to find the folder of "typescript-language-server.cmd" and add it to PATH.
1864	1793
1865	1794		According to <https://www.zeusedit.com/lsp/typescript.html>, sometimes more complex config file may be needed. Here it is on Ubuntu:
1866	1795
1867	1796		``` json
1868	1797		{
1869	1798		"lexers": {
1870	1799		"TypeScript": "ts"
1871	1800		},
1872	1801		"cmd_unix": [
1873	1802		"typescript-language-server",
1874	1803		"--stdio",
1875	1804		"--log-level=4",
1876	1805		"--tsserver-log-verbosity=verbose",
1877	1806		"--tsserver-path=/usr/local/lib/node_modules/typescript/lib/"
1878	1807		],
1879	1808		"cmd_windows": [
1880	1809		"typescript-language-server.cmd",
1881	1810		"--stdio",
1882	1811		"--log-level=4",
1883	1812		"--tsserver-log-verbosity=verbose",
1884	1813		"--tsserver-path=\"%APPDATA%\\npm\\node_modules\\typescript\\lib\\\""
1885	1814		]
1886	1815		}
1887	1816		```
1888	1817
1889	1818		How did I get the last path? It may be different on different Linux'es. It is from the "node_modules" dir which contains the globally installed Node.js modules. I found it by running "which typescript-language-server", it gave "/usr/local/bin/typescript-language-server". Then I checked symlink target for "/usr/local/bin/typescript-language-server" - it points to the sub-dir of needed "node_modules".
1890	1819
1891	1820		Test the auto-completion on this "test.ts" file (with TypeScript lexer):
1892	1821
1893	1822		`document.body.g`
1894	1823
1895	1824		## LSP server for C/C++
1896	1825
1897	1826		Install one of the servers following the instructions:
1898	1827
1899	1828		- clangd: <https://clangd.llvm.org/installation.html>
1900	1829		- For Windows, you need to download "clangd-windows-x.x.x.zip" from <https://github.com/clangd/clangd/releases> . You need to add folder of "clangd.exe" to the OS PATH in Windows settings.
1901	1830		- ccls: <https://github.com/MaskRay/ccls/wiki/Build> + <https://github.com/MaskRay/ccls/wiki/Install>
1902	1831
1903	1832		To use the server in LSP Client, create a file "lsp_c.json" in the "settings" directory with such content:
1904	1833
1905	1834		``` json
1906	1835		{
1907	1836		"lexers": {
1908	1837		"C++": "cpp",
1909	1838		"C": "c"
1910	1839		},
1911	1840		"cmd_unix": [
1912	1841		"clangd-12",
1913	1842		],
1914	1843		"cmd_windows": [
1915	1844		"clangd",
1916	1845		],
1917	1846		}
1918	1847		```
1919	1848
1920	1849		Replace "clangd*" with "ccls" if it was chosen.
1921	1850
1922	1851		On Windows: you must add the "bin" directory of mingw64 to the PATH so clangd is in the PATH.
1923	1852
1924	1853		## LSP server for C#
1925	1854
1926	1855		First, install C# lexer from "Addons Manager".
1927	1856
1928	1857		1\. Get OmniSharp server from GitHub <https://github.com/OmniSharp/omnisharp-roslyn/releases> . For Windows 64-bit it is the package "omnisharp-win-x64.zip" or "omnisharp-win-x64-net6.0.zip". Unzip this package to the folder "C:\OmniSharp", for example. It's not required to add that folder to system PATH.
1929	1858
1930	1859		2\. You need to install MSBuild. As of May 2022, OmniSharp does not include MSBuild. Download link can be found at the bottom of this page: <https://visualstudio.microsoft.com/downloads/?q=build+tools> - see "Build Tools for Visual Studio 2022". In the installation check the following option: ".NET desktop build tools". If you won't install MSBuild, OmniSharp server will fail, see more info here: <https://github.com/OmniSharp/omnisharp-vscode/issues/5120> .
1931	1860
1932	1861		3\. Create LSP config file: (CudaText)/settings/lsp_cs.json:
1933	1862
1934	1863		``` json
1935	1864		{
1936	1865		"lexers": {
1937	1866		"C#": "csharp"
1938	1867		},
1939	1868		"cmd_windows": [
1940	1869		"C:\\OmniSharp\\OmniSharp.exe", "-lsp", "-z"
1941	1870		]
1942	1871		}
1943	1872		```
1944	1873
1945	1874		Note that backslashes must be doubled (because of JSON format).
1946	1875
1947	1876		4\. To test that server works: create a file "test.cs" (with C# lexer active). Call auto-completion after "date.A".
1948	1877
1949	1878		``` csharp
1950	1879		using System;
1951	1880
1952	1881		public class DateExample
1953	1882		{
1954	1883		public static void Main()
1955	1884		{
1956	1885		DateTime date;
1957	1886		date.A
1958	1887		}
1959	1888		}
1960	1889		```
1961	1890
1962	1891		## LSP server for CSS/SCSS/LESS
1963	1892
1964	1893		The CSS (and SCSS, LESS) server is not easy to install, so here is the instruction, from the author of LSP Client:
1965	1894
1966	1895		- Download the repository of VSCode: <https://github.com/microsoft/vscode>
1967	1896		- From the repository, get the folder "extensions/css-language-features/server" and enter in it.
1968	1897		- Replace the file "tsconfig.json" with content:
1969	1898
1970	1899		``` json
1971	1900		{
1972	1901		"compilerOptions": {
1973	1902		"target": "es2018",
1974	1903		"lib": [
1975	1904		"es2018"
1976	1905		],
1977	1906		"module": "commonjs",
1978	1907		"strict": true,
1979	1908		"alwaysStrict": true,
1980	1909		"noImplicitAny": true,
1981	1910		"noImplicitReturns": true,
1982	1911		"noImplicitOverride": true,
1983	1912		"noUnusedLocals": true,
1984	1913		"noUnusedParameters": true,
1985	1914		"forceConsistentCasingInFileNames": true,
1986	1915
1987	1916		"outDir": "./out"
1988	1917		},
1989	1918		"files": [
1990	1919		"src/node/cssServerMain.ts"
1991	1920		]
1992	1921		}
1993	1922		```
1994	1923
1995	1924		- Install dependencies and TypeScript. In Terminal:
1996	1925
1997	1926		`npm install`\
1998	1927		`npm install -g typescript`
1999	1928
2000	1929		- Compile it. In Terminal:
2001	1930
2002	1931		`npx tsc`
2003	1932
2004	1933		Server should be compiled.
2005	1934
2006	1935		Create config file (CudaText)/settings/lsp_css.json:
2007	1936
2008	1937		``` json
2009	1938		{
2010	1939		"name": "vsc-css",
2011	1940		"lexers": {
2012	1941		"CSS": "css",
2013	1942		"SCSS": "scss",
2014	1943		"Sass": "sass",
2015	1944		"LESS": "less",
2016	1945		},
2017	1946		"cmd_unix": [
2018	1947		"node",
2019	1948		"path_to_server/server/out/node/cssServerMain.js",
2020	1949		"--stdio"
2021	1950		]
2022	1951		}
2023	1952		```
2024	1953
2025	1954		## LSP server for HTML
2026	1955
2027	1956		CudaText does not support built-in HTML auto-completion when caret is inside style="..." blocks. But LSP server supports it. Install server using Node.js:
2028	1957
2029	1958		`npm install --global vscode-html-ls-bin`
2030	1959
2031	1960		Make config file (CudaText)/settings/lsp_html.json:
2032	1961
2033	1962		``` json
2034	1963		{
2035	1964		"lexers": {
2036	1965		"HTML": "html",
2037	1966		},
2038	1967		"cmd_windows": ["html-ls.cmd", "--stdio"],
2039	1968		"cmd_unix": ["html-ls", "--stdio"]
2040	1969		}
2041	1970		```
2042	1971
2043	1972		Make sure the script "html-ls" ("html-ls.cmd" on Windows) is in the PATH.
2044	1973
2045	1974		You may see wrong sorting of CSS properties in the auto-completion list, when auto-completion is called for CSS prop with dash char. To fix that, you need to remove dash char "-" from the "nonword_chars" option. Do it via lexer-specific config for HTML.
2046	1975
2047	1976		## LSP server for Java
2048	1977
2049	1978		Part 1. Information for Windows.
2050	1979
2051	1980		- Install lexer "Java" from Addons Manager.
2052	1981
2053	1982		- Install [Java SE Development Kit 19](https://www.oracle.com/java/technologies/downloads/#jdk19-windows) or later. If you have usual Java (JRE) then better remove it first. Then run in Console:
2054	1983
2055	1984		`java -version`
2056	1985
2057	1986		It must show something like this:
2058	1987
2059	1988		`java version "19.0.1" 2022-10-18`\
2060	1989		`Java(TM) SE Runtime Environment (build 19.0.1+10-21)`\
2061	1990		`Java HotSpot(TM) 64-Bit Server VM (build 19.0.1+10-21, mixed mode, sharing)`
2062	1991
2063	1992		- Download package "jdt-language-server-1.9.0-2022*.tar.gz" from [Eclipse JDT Language Server milestone builds](https://download.eclipse.org/jdtls/milestones/?d) and extract it to "C:\Java\jdt-language-server".
2064	1993
2065	1994		- Create "C:\Java\jLSP.cmd" batch file with the following contents (edit if necessary):
2066	1995
2067	1996		```batch
2068	1997		@echo off
2069	1998		echo.
2070	1999		echo Usage: jLSP.cmd CacheDir
2071	2000		echo where "CacheDir" is an absolute path to your data directory. eclipse.jdt.ls stores workspace specific information in it. This should be unique per workspace/project.
2072	2001		echo.
2073	2002
2074	2003		:: language server installation folder (adjust to suit)
2075	2004		set Directory=C:/Java/jdt-language-server
2076	2005		:: language server jar file (update based on version file of jar)
2077	2006		set JarFile=%Directory%/plugins/org.eclipse.equinox.launcher_1.6.400.v20210924-0641.jar
2078	2007		:: language server config folder location
2079	2008		set Config=%Directory%/config_win
2080	2009
2081	2010		set CacheDir=%~1
2082	2011		echo Directory: %Directory%
2083	2012		echo JarFile: %JarFile%
2084	2013		echo Config: %Config%
2085	2014		echo CacheDir: %CacheDir%
2086	2015
2087	2016		java -Dosgi.bundles.defaultStartLevel=4 -Declipse.product=org.eclipse.jdt.ls.core.product -Dlog.level=ALL -noverify -Xmx1G -jar %JarFile% -configuration %Config% --add-modules=ALL-SYSTEM --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED -data %CacheDir%
2088	2017		```
2089	2018
2090	2019		- Create LSP config file: (CudaText)/settings/lsp_java.json:
2091	2020
2092	2021		``` json
2093	2022		{
2094	2023		"lexers": {
2095	2024		"Java": "java"
2096	2025		},
2097	2026		"cmd_windows": ["C:\\Java\\jLSP.cmd", "./cache_for_proj1"]
2098	2027		}
2099	2028		```
2100	2029
2101	2030		Use testing file "test.java". Place caret on last code line after "System.g" and call auto-completion.
2102	2031
2103	2032		``` java
2104	2033		public class Example {
2105	2034		public static void main(String[] args) {
2106	2035		System.g
2107	2036		}
2108	2037		}
2109	2038		```
2110	2039
2111	2040		Part 2. Information for Linux.
2112	2041
2113	2042		- Install lexer "Java" from Addons Manager.
2114	2043
2115	2044		- Install "Java SE Development Kit" from [Oracle website](https://www.oracle.com/java/technologies/downloads/#jdk19-linux) or from OS package manager. If you have usual Java (JRE) then better remove it first.
2116	2045
2117	2046		On Ubuntu this command works (2022 year):
2118	2047
2119	2048		`sudo apt install openjdk-17-jre-headless `
2120	2049
2121	2050		Then run in Console:
2122	2051
2123	2052		`java -version`
2124	2053
2125	2054		It must show something like this:
2126	2055
2127	2056		`openjdk version "17.0.4" 2022-07-19`\
2128	2057		`OpenJDK Runtime Environment (build 17.0.4+8-Ubuntu-120.04)`\
2129	2058		`OpenJDK 64-Bit Server VM (build 17.0.4+8-Ubuntu-120.04, mixed mode, sharing)`
2130	2059
2131	2060		- Download package "jdt-language-server-1.9.0-2022*.tar.gz" from [Eclipse JDT Language Server milestone builds](https://download.eclipse.org/jdtls/milestones/?d) and extract it to "~\jdt-language-server".
2132	2061
2133	2062		- Create "~\jLSP.sh" shell script with the following contents, and make it executable:
2134	2063
2135	2064		``` bash
2136	2065		#!/bin/bash
2137	2066		echo
2138	2067		echo Usage: jLSP.sh CacheDir
2139	2068		echo where "CacheDir" is an absolute path to your data directory. eclipse.jdt.ls stores workspace specific information in it. This should be unique per workspace/project.
2140	2069		echo
2141	2070
2142	2071		# language server installation folder (adjust to suit)
2143	2072		Directory=~/jdt-language-server
2144	2073		# language server jar file (update based on version file of jar)
2145	2074		JarFile=$Directory/plugins/org.eclipse.equinox.launcher_1.6.400.v20210924-0641.jar
2146	2075		# language server config folder location
2147	2076		Config=$Directory/config_linux
2148	2077
2149	2078		CacheDir=$1
2150	2079		echo Directory: $Directory
2151	2080		echo JarFile: $JarFile
2152	2081		echo Config: $Config
2153	2082		echo CacheDir: $CacheDir
2154	2083
2155	2084		java -Dosgi.bundles.defaultStartLevel=4 -Declipse.product=org.eclipse.jdt.ls.core.product -Dlog.level=ALL -noverify -Xmx1G -jar $JarFile -configuration $Config --add-modules=ALL-SYSTEM --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED -data $CacheDir
2156	2085		```
2157	2086
2158	2087		- Create LSP config file: (CudaText)/settings/lsp_java.json:
2159	2088
2160	2089		``` json
2161	2090		{
2162	2091		"lexers": {
2163	2092		"Java": "java",
2164	2093		},
2165	2094		"cmd_unix": ["~/jLSP.sh", "./cache_for_proj1"],
2166	2095		}
2167	2096		```
2168	2097
2169	2098		Use testing file "test.java". Place caret on last code line after "System.g" and call auto-completion.
2170	2099
2171	2100		``` java
2172	2101		public class Example {
2173	2102		public static void main(String[] args) {
2174	2103		System.g
2175	2104		}
2176	2105		}
2177	2106		```
2178	2107
2179	2108		## LSP server for Nim
2180	2109
2181	2110		Server from <https://github.com/PMunch/nimlsp> works good.
2182	2111
2183	2112		Config file (CudaText)/settings/lsp_nim.json:
2184	2113
2185	2114		``` json
2186	2115		{
2187	2116		"name": "nim-lsp",
2188	2117		"lexers": {
2189	2118		"Nim": "nim"
2190	2119		},
2191	2120		"cmd_unix": [
2192	2121		"~/.nimble/bin/nimlsp"
2193	2122		]
2194	2123		}
2195	2124		```
2196	2125
2197	2126		## LSP server for Rust
2198	2127
2199	2128		RLS server ( <https://github.com/rust-lang/rls> ) has been deprecated and is no longer supported. It has been replaced with Rust-analyzer. Users are encouraged to uninstall RLS and follow the instructions in the Rust-analyzer manual to install it. User needs to download binary file for his system: <https://github.com/rust-lang/rust-analyzer#quick-start>
2200	2129
2201	2130		Create config (CudaText)/settings/lsp_rust.json:
2202	2131
2203	2132		``` json
2204	2133		{
2205	2134		"lexers": {
2206	2135		"Rust": "rust"
2207	2136		},
2208	2137		"cmd_windows": ["rust-analyzer-x86_64-pc-windows-msvc.exe"],
2209	2138		"cmd_unix": ["rust-analyzer-x86_64-unknown-linux-gnu"]
2210	2139		}
2211	2140		```
2212	2141
2213	2142		## LSP server for AutoHotkey
2214	2143
2215	2144		- Download the repository of AutoHotkey2: <https://github.com/thqby/vscode-autohotkey2-lsp>
2216	2145		- Extract and enter the directory: "vscode-autohotkey2-lsp-main"
2217	2146		- Install dependencies and TypeScript. In Terminal:
2218	2147
2219	2148		`npm install`\
2220	2149		`npm install -g typescript`
2221	2150
2222	2151		- Enter the directory "server", and compile the server. In Terminal:
2223	2152
2224	2153		`npx tsc`
2225	2154
2226	2155		Server should be compiled now. To use the server in LSP Client, create the file "lsp_ahk.json" in the "settings" with such content:
2227	2156
2228	2157		``` json
2229	2158		{
2230	2159		"name": "AutoHotkey2",
2231	2160		"lexers": {
2232	2161		"AutoHotkey": "ahk"
2233	2162		},
2234	2163		"cmd_unix": [
2235	2164		"node",
2236	2165		"path_to_server/server/out/server.js",
2237	2166		"--stdio"
2238	2167		]
2239	2168		}
2240	2169		```
2241	2170
2242	2171		## LSP server for Red
2243	2172
2244	2173		1\) On Linux x64.
2245	2174
2246	2175		- Install Red. Download "red" binary, "chmod +x red", then copy it to PATH dir (/usr/bin on Ubuntu). Command "red" must work from Terminal. Red release 0.6.4 may give errors with the LSP server, so better install build from 30-Sep-2021.
2247	2176		- Install server from <https://github.com/bitbegin/redlangserver>, put the repo e.g. to ~/redlangserver.
2248	2177		- Create file "redlangserver.sh" and put it to some PATH dir. Content:
2249	2178
2250	2179		``` bash
2251	2180		#!/bin/bash
2252	2181		red ~/redlangserver/server.red
2253	2182		```
2254	2183
2255	2184		- Create file (CudaText)/settings/lsp_red.json with content:
2256	2185
2257	2186		``` json
2258	2187		{
2259	2188		"lexers": {
2260	2189		"Red": "red"
2261	2190		},
2262	2191		"cmd_unix": ["redlangserver.sh"],
2263	2192		"cmd_windows": ["c:\\red\\red.exe", "--cli", "c:\\red\\redlangserver\\server.red"]
2264	2193		}
2265	2194		```
2266	2195
2267	2196		Server should work now. It gives: mouse hover tooltips (Ctrl + mouse hovering over names), go to definition.
2268	2197
2269	2198		2\) On Windows 10 x64.
2270	2199
2271	2200		- Install Red to "c:\Red". Tested the build from 02-Oct-2021.
2272	2201		- Install server from <https://github.com/bitbegin/redlangserver>, put the repo to "c:\Red\redlangserver".
2273	2202		- Run once the command "c:\red\red.exe --cli", it will print "Compiling Red console..." with the big pause.
2274	2203		- Create file (CudaText)\settings\lsp_red.json with the same content as for Unix. Adjust path to Red folder, if needed.
2275	2204
2276	2205		Server should work now. It gives: mouse hover tooltips (Ctrl + mouse hovering over names), go to definition (works not always, logic when it works is unclear).
2277	2206
2278	2207		Note: don't create .bat or .cmd file with the "red.exe" calling, because it does not work in LSP Client for some reason.
2279	2208
2280	2209		## LSP server for PHP
2281	2210
2282	2211		1\. Install PHP, Composer. PHP versions 7.4.3 and 8.1 are OK.
2283	2212
2284	2213		2\. Install php-dom extension. php-dom extension is the only needed for this server to work, and it must be installed before you run "composer update".
2285	2214
2286	2215		3\. Clone Git repo <https://github.com/zobo/php-language-server> , and get the full path to the file "php-language-server.php", it will be needed in the next step. See readme "Installation" part, you must do some steps with Composer first, e.g. "composer update" inside php-language-server directory.
2287	2216
2288	2217		4\. Create LSP config (CudaText)/settings/lsp_php.json:
2289	2218
2290	2219		``` json
2291	2220		{
2292	2221		"name": "PHP",
2293	2222		"lexers": {
2294	2223		"PHP": "php"
2295	2224		},
2296	2225		"tcp_port": 12345,
2297	2226		"cmd_unix": [
2298	2227		"php",
2299	2228		"folder_of_server/bin/php-language-server.php",
2300	2229		"--tcp-server=127.0.0.1:12345"
2301	2230		],
2302	2231		"cmd_windows": [
2303	2232		"php",
2304	2233		"D:\\programm\\php\\php-language-server\\bin\\php-language-server.php",
2305	2234		"--tcp-server=127.0.0.1:12345"
2306	2235		]
2307	2236		}
2308	2237		```
2309	2238
2310	2239		Server should work now. It gives these features: <https://github.com/zobo/php-language-server#features> .
2311	2240
2312	2241		Auto-completion works, it is not working if you open .php file that is outside of current CudaText project directory. In LSP Client config there is a parameter named "root_dir_source". For zobo's server to index .php files they must be inside this dir. In CudaText Project Manager you must save your project file to your php project location, otherwise the root_dir will be wrong.
2313	2242
2314	2243		Note: on Windows, in rare cases hanging php.exe process can prevent LSP server from starting. If you see "ReadLoopError" in Console, try to kill all "php" processes and try again.
2315	2244
2316	2245		## LSP server for Bash
2317	2246
2318	2247		- Install Node.js, see readme here: <https://github.com/nodesource/distributions/blob/master/README.md>
2319	2248		- Install Bash server, see readme here: <https://github.com/bash-lsp/bash-language-server>
2320	2249		- Install Shellcheck from <https://www.shellcheck.net/> - "We strongly recommend that you install shellcheck to enable linting"
2321	2250		- On Windows, maybe you need to add folder of "bash-language-server.cmd" to system PATH.
2322	2251		- Create file (CudaText)/settings/lsp_bash.json with content:
2323	2252
2324	2253		``` json
2325	2254		{
2326	2255		"lexers": {
2327	2256		"Bash script": "bash"
2328	2257		},
2329	2258		"cmd_windows": ["bash-language-server.cmd", "start"],
2330	2259		"cmd_unix": ["bash-language-server", "start"]
2331	2260		}
2332	2261		```
2333	2262
2334	2263		## LSP server for D
2335	2264
2336	2265		First, install D lexer from "Addons Manager".
2337	2266
2338	2267		1\. Install DLang into "C:\D", for example. For 64-bit compiler, add folder "C:\D\dmd2\windows\bin64" to system PATH. Check that "dmd" and "dub" commands run OK from Windows console.
2339	2268
2340	2269		2\. Install the LSP server, run from console:
2341	2270
2342	2271		`dub fetch dls`
2343	2272
2344	2273		This must show output like
2345	2274
2346	2275		`C:\D>dub fetch dls`\
2347	2276		`Fetching dls 0.26.2...`\
2348	2277		`` Please note that you need to use `dub run <pkgname>` or add it to dependencies of your package to actually use/run it. dub does not do actual installation of packages outside of its own ecosystem. ``
2349	2278
2350	2279		3\. Compile the LSP server, run from console:
2351	2280
2352	2281		`dub run dls:bootstrap`
2353	2282
2354	2283		This must show output like
2355	2284
2356	2285		`C:\D>dub run dls:bootstrap`\
2357	2286		`Building package dls:bootstrap in C:\Users\user\AppData\Local\dub\packages\dls-0.26.2\dls\bootstrap\`\
2358	2287		`Running pre-generate commands for dls:i18n...`\
2359	2288		`Performing "debug" build using C:\D\dmd2\windows\bin64\dmd.exe for x86_64.`\
2360	2289		`dls:protocol 0.26.2: building configuration "library"...`\
2361	2290		`dls:i18n 0.26.2: building configuration "library"...`\
2362	2291		`dls:bootstrap 0.26.2: building configuration "application"...`\
2363	2292		`Linking...`\
2364	2293		`Running ../Users/user/AppData/Local/dub/packages/dls-0.26.2/dls/bootstrap/dls_bootstrap.exe`\
2365	2294		`C:\Users\user\AppData\Local\dub\packages\.bin\dls-latest\dls.exe`
2366	2295
2367	2296		Copy to clipboard the last printed filename with dls.exe.
2368	2297
2369	2298		4\. Create the CudaText LSP config: (CudaText)/settings/lsp_d.json. The dls.exe filename is from the previous step. Note: backslashes must be doubled (because of JSON format).
2370	2299
2371	2300		``` json
2372	2301		{
2373	2302		"lexers": {
2374	2303		"D": "dlang"
2375	2304		},
2376	2305		"cmd_windows": [
2377	2306		"C:\\Users\\user\\AppData\\Local\\dub\\packages\\.bin\\dls-latest\\dls.exe", "--stdio"
2378	2307		]
2379	2308		}
2380	2309		```
2381	2310
2382	2311		5\. Create test file "test.d" (with lexer D). Test that auto-completion works after "b.":
2383	2312
2384	2313		``` d
2385	2314		class A {int a; int a2;}
2386	2315		class B: A {int a3;}
2387	2316
2388	2317		void foo(B b)
2389	2318		{
2390	2319		b.
2391	2320		}
2392	2321		```
2393	2322
2394	2323		## LSP server for Go
2395	2324
2396	2325		Install lexer Go from "Addons Manager".
2397	2326
2398	2327		1\. Install Go. Make sure that Go binary is in the system PATH, and GOPATH variable is also set.
2399	2328
2400	2329		2\. Install the LSP server:
2401	2330
2402	2331		`go install golang.org/x/tools/gopls@latest`
2403	2332
2404	2333		In Ubuntu, this must create binary "gopls" in the folder "~/go/bin" (on Windows it may be "C:\Go\bin"), which is in the PATH. Check that "gopls" runs:
2405	2334
2406	2335		`gopls version`
2407	2336
2408	2337		It must give output like:
2409	2338
2410	2339		`golang.org/x/tools/gopls v0.9.5`\
2411	2340		` golang.org/x/tools/gopls@v0.9.5 h1:F3TO5th6TUg40FHrpxZfMkMlVaaTmByeEvylgVHGH2A=`
2412	2341
2413	2342		3\. Create CudaText LSP config (CudaText)/settings/lsp_go.json:
2414	2343
2415	2344		``` json
2416	2345		{
2417	2346		"lexers": {
2418	2347		"Go": "go"
2419	2348		},
2420	2349		"cmd_unix": [
2421	2350		"gopls"
2422	2351		],
2423	2352		"cmd_windows": [
2424	2353		"gopls.exe"
2425	2354		]
2426	2355		}
2427	2356		```
2428	2357
2429	2358		4\. See the content of GOPATH env variable, and create file "test.go" (with lexer Go) in that folder. Check that auto-completion works after "fmt.F":
2430	2359
2431	2360		``` go
2432	2361		package aa
2433	2362		import ("fmt")
2434	2363
2435	2364		func main() {
2436	2365		fmt.F
2437	2366		}
2438	2367		```
2439	2368
2440	2369		## LSP server for Lua
2441	2370
2442	2371		1\. Install server for the command line from <https://github.com/sumneko/lua-language-server> . Find the full path of the file "lua-language-server" ("lua-language-server.exe" on Windows).
2443	2372
2444	2373		2\. Create LSP config (CudaText)/settings/lsp_lua.json:
2445	2374
2446	2375		``` json
2447	2376		{
2448	2377		"lexers": {
2449	2378		"Lua": "lua"
2450	2379		},
2451	2380		"log_stderr": true,
2452	2381		"cmd_windows": ["D:\\Programs\\lua-lsp\\bin\\lua-language-server.exe"],
2453	2382		"cmd_unix": ["/path/to/lua-language-server"]
2454	2383		}
2455	2384		```
2456	2385
2457	2386		## LSP server for Scala
2458	2387
2459	2388		Install lexer "Scala" from Addons Manager. Information for Windows.
2460	2389
2461	2390		1\. Install Coursier: <https://get-coursier.io/docs/cli-installation>
2462	2391
2463	2392		2\. Install Metals. Make sure "metals.bat" is in the system PATH.
2464	2393
2465	2394		`cs install metals`
2466	2395
2467	2396		3\. Create LSP config file (CudaText)/settings/lsp_scala.json:
2468	2397
2469	2398		``` json
2470	2399		{
2471	2400		"lexers": {
2472	2401		"Scala": "scala"
2473	2402		},
2474	2403		"cmd_windows": ["metals.bat"]
2475	2404		}
2476	2405		```
2477	2406
2478	2407		Testing file for auto-completion:
2479	2408
2480	2409		`object Hello extends App {`\
2481	2410		` println("Hello, world")`\
2482	2411		`}`
2483	2412
2484	2413		## LSP server for Fortran
2485	2414
2486	2415		Install lexer "Fortran" from Addons Manager. Steps show how to use server on Linux (Ubuntu 20.04) with Python 3 installed.
2487	2416
2488	2417		1\. Install the LSP server:
2489	2418
2490	2419		`pip install fortran-language-server`
2491	2420
2492	2421		Check that command runs OK:
2493	2422
2494	2423		`fortls -?`
2495	2424
2496	2425		And check its full path:
2497	2426
2498	2427		`which fortls`
2499	2428
2500	2429		Here it prints: "/home/user/.local/bin/fortls". We will need that full path in the next step, because short program name "fortls" gave errors for me.
2501	2430
2502	2431		2\. Create LSP config file: (CudaText)/settings/lsp_fortran.json:
2503	2432
2504	2433		``` json
2505	2434		{
2506	2435		"lexers": {
2507	2436		"Fortran": "fortran"
2508	2437		},
2509	2438		"cmd_unix": [
2510	2439		"/home/user/.local/bin/fortls"
2511	2440		]
2512	2441		}
2513	2442		```
2514	2443
2515	2444		3\. Make test file "test.for" (with Fortran lexer). Test auto-completion after "CALL myv".
2516	2445
2517	2446		``` fortran
2518	2447		PROGRAM myprog
2519	2448		USE test_free, ONLY: scaled_vector
2520	2449		TYPE(scaled_vector) :: myvec
2521	2450		CALL myv
2522	2451		END PROGRAM
2523	2452		```
2524	2453
2525	2454		## LSP server for Markdown
2526	2455
2527	2456		1\. Get precompiled Marksman LSP server from GitHub: <https://github.com/artempyanykh/marksman/releases>
2528	2457
2529	2458		2\. On Windows, copy "marksman.exe" to some folder in PATH. On Linux, copy "marksman-linux" to this recommended folder in PATH: ~/.local/bin. Set executable permission for Linux binary.
2530	2459
2531	2460		`chmod +x marksman-linux`
2532	2461
2533	2462		3\. Create config file (CudaText)/settings/lsp_md.json:
2534	2463
2535	2464		``` json
2536	2465		{
2537	2466		"lexers": {
2538	2467		"Markdown": "markdown"
2539	2468		},
2540	2469		"cmd_windows": ["marksman.exe"],
2541	2470		"cmd_unix": ["marksman-linux"]
2542	2471		}
2543	2472		```
2544	2473
2545	2474		Now auto-completion / goto-definition / hover-tooltip must work on this "test.md" file:
2546	2475
2547	2476		``` md
2548	2477		[reference][abcd]
2549	2478		[reference][a123]
2550	2479
2551	2480		Some text.
2552	2481
2553	2482		[abcd]: url "title"
2554	2483		[a123]: url "title2"
2555	2484		```
2556	2485
2557	2486		## LSP server for V
2558	2487
2559	2488		- Install V lexer (from "Addons Manager / Plugins / Install")
2560	2489		- Install V language
2561	2490		- Install v-analyzer binary from <https://github.com/v-analyzer/v-analyzer> to a folder (that is included in PATH)
2562	2491		- Create "lsp_v.json" in CudaText's "settings" folder with the following content:
2563	2492
2564	2493		``` json
2565	2494		{
2566	2495		"lexers": {
2567	2496		"V": "v"
2568	2497		},
2569	2498		"cmd_windows": ["v-analyzer.exe"],
2570	2499		"cmd_unix": ["v-analyzer"],
2571	2500		"cmd_macos": ["v-analyzer"]
2572	2501		}
2573	2502		```
2574	2503
2575	2504		## LSP server Vale
2576	2505
2577	2506		Steps for Windows OS.
2578	2507
2579	2508		- Install Vale server. Add path of "vale-ls.exe" to system PATH.
2580	2509		- Create "lsp_vale.json" in CudaText's "settings" folder. Specify empty lexer name.
2581	2510
2582	2511		``` json
2583	2512		{
2584	2513		"lexers": {
2585	2514		"": ""
2586	2515		},
2587	2516
2588	2517		"cmd_windows": ["vale-ls.exe"],
2589	2518		"log_stderr": true,
2590	2519		"settings": {
2591	2520		"configPath": ""
2592	2521		}
2593	2522		}
2594	2523		```
2595	2524
2596	2525		- You need to put config file to %UserProfile% folder. For example: "C:\Users\john\\.vale.ini".
2597	2526		- Do not forget to run: "vale sync".
2598	2527		- Vale server did not support filenames with spaces on Windows OS. To fix it, update Vale to 0.3.7 or newer.
2599	2528
2600	2529		---
2601	2530		From the Free Pascal wiki, page "CudaText plugins", as it stood on 2024-05-05 after a change by Alextp, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
2602	2531		Category: CudaText

Back to history