You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-5Lines changed: 31 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,28 +104,30 @@ PRs for ecode will be accepted at the eepp repository.
104
104
There are scripts for each supported platform ready to build the application.
105
105
For *Linux* and *macOS* it is trivial to build the project, you'll just need to have GCC/Clang installed
106
106
and also the development library from libSDL2. Windows build script is currently a cross-compiling script and it uses mingw64.
107
-
But it also can be easily built with Visual Studio and [libSDL2 development libraries](https://www.libsdl.org/release/SDL2-devel-2.0.22-VC.zip) installed.
107
+
But it also can be easily built with Visual Studio and [libSDL2 development libraries](https://www.libsdl.org/release/SDL2-devel-2.30.7-VC.zip) installed.
108
108
For more information on how to build manually a project please follow the [eepp build instructions](https://github.com/SpartanJ/eepp/#how-to-build-it).
109
109
The project name is always *ecode* (so if you are building with make, you'll need to run `make ecode`).
110
110
111
-
**Linux* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/linux/ecode). Running `build.app.sh` will try to build the `AppImage` package.
112
-
**macOS* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/macos/ecode). Running `build.app.sh` will create `ecode.app`.
113
-
**Windows* cross-compiling build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/mingw32/ecode). Running `build.app.sh` will create a `zip` file with the zipped application package.
111
+
**Linux* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/linux/ecode). Running `build.app.sh` will try to build the `AppImage` package and `tar.gz` with the compressed application. `ecode` folder will contain the uncompressed application.
112
+
**macOS* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/macos/ecode). Running `build.app.sh` will create `ecode.app`. Run `create.dmg.sh` to create the `dmg` file. `ecode.app` folder will contain the uncompressed application.
113
+
**Windows* cross-compiling build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/mingw32/ecode). Running `build.app.sh` will create a `zip` file with the zipped application package. `ecode` folder will contain the uncompressed application. To build from Windows follow the instructions [here](https://github.com/SpartanJ/eepp/?tab=readme-ov-file#windows).
114
+
**FreeBSD* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/freebsd/ecode). Running `build.app.sh` will try to build a `tar.gz` with the compressed application. `ecode.app` folder will contain the uncompressed application.
115
+
**Haiku* build script can be found [here](https://github.com/SpartanJ/eepp/tree/develop/projects/haiku/ecode). Running `build.app.sh` will try to build a `tar.gz` with the compressed application. `ecode.app` folder will contain the uncompressed application.
114
116
115
117
## Language support
116
118
117
119
ecode is constantly adding more languages support and also supports extending it's language support
118
120
via configuration files (for every feature: syntax highlighting, LSP, linter and formatter).
@@ -284,6 +286,8 @@ Please check the [language support table](#language-support-table)
284
286
***enable_error_lens**: Enables error lens (prints the message inline)
285
287
***enable_lsp_diagnostics**: Boolean that enable/disable LSP diagnostics as part of the linting. Enabled by default.
286
288
***disable_lsp_languages**: Array of LSP languages disabled for LSP diagnostics. For example: `"disable_lsp_languages": ["lua", "python"]`, disables lua and python.
289
+
***disable_languages**: Array of linters disabled from external linter application diagnostics. For example: `"disable_languages": ["lua", "python"]`, disables luacheck and ruff respectively.
290
+
***goto_ignore_warnings**: Defines the behavior of the "linter-go-to-next-error" and "linter-go-to-previous-error" keybindings. If ignore warnings is true it will jump only between errors.
287
291
288
292
#### Linter JSON object keys
289
293
@@ -398,8 +402,11 @@ Please check the [language support table](#language-support-table)
398
402
***hover_delay**: The time the editor must wait to show symbol information when hovering any piece of code.
399
403
***server_close_after_idle_time**: The time the LSP Server will keep alive after all documents that consumes that LSP Server were closed. LSP Servers are spawned and killed on demand.
400
404
***semantic_highlighting**: Enable/Disable semantic highlighting (disabled by default, boolean)
405
+
***disable_semantic_highlighting_lang**: An array of languages where semantic highlighting should be disabled
401
406
***silent**: Enable/Disable non-critical LSP logs
402
407
***trim_logs**: If logs are enabled and trim_logs is enabled it will trim the line log size at maximum 1 KiB per line (useful for debugging)
408
+
***breadcrumb_navigation**: Enable/Disable the breadcrumb (enabled by default)
409
+
***breadcrumb_height**: Defines the height of the breadcrumb in [CSS length](https://eepp.ensoft.dev/page_cssspecification.html#length-data-type)
403
410
404
411
#### LSP Client keybindings object keys
405
412
@@ -472,6 +479,25 @@ C and C++ LSP server example (using [clangd](https://clangd.llvm.org/))
472
479
473
480
***git-blame**: Keybinding to display the a git blame summary over the current positioned line.
474
481
482
+
### Auto Complete
483
+
484
+
The auto-complete plugin is in charge of providing suggestions for code-completion and signature help.
485
+
486
+
#### Auto Complete config object keys
487
+
488
+
***max_label_characters**: Maximum characters displayed in the suggestion box.
489
+
***suggestions_syntax_highlight**: Enables/disables syntax highlighting in suggestions.
490
+
491
+
### XML Tools
492
+
493
+
The XML Tools plugin (disabled by default) provides some nice to have improvements when editing XML
494
+
content.
495
+
496
+
#### XML Tools config object keys
497
+
498
+
***auto_edit_match**: Automatically edits the open/close tag when the user edits the element tag name (syncs open and close element names).
499
+
***highlight_match**: When the user moves the cursor to an open or close tag it will highlight the matched open/close tag.
500
+
475
501
### Plugins configuration files location
476
502
477
503
*ecode* respects the standard configuration paths on each OS:
0 commit comments