Skip to content

Commit fec6a01

Browse files
committed
add external editor doc
1 parent 1c90242 commit fec6a01

File tree

3 files changed

+37
-0
lines changed

3 files changed

+37
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sidebar_position: 10
3+
title: External editor
4+
---
5+
6+
External code editor
7+
=====================
8+
9+
The code editor included in Simplicité does not have all the tooling and possibilities offered by an IDE.
10+
11+
Simplicité modules include git functionnality, so you can easily clone them locally and work on the sources. Refer to the [git documentation](/docs/integration/webservices/git-repositories#export) to see how to clone the module's git repository.
12+
13+
Typically, you would:
14+
1. do some configuration on Simplicité
15+
2. commit on Simplicité
16+
3. pull the changes from Simplicité
17+
4. do some coding locally
18+
5. commit those changes locally
19+
6. push the changes to Simplicité
20+
21+
VS Code
22+
-------
23+
24+
To work with VSCode (and affiliates), it is usefull to add the [Extension Pack for Java](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) to get IntelliSense and Java debugging tools. Given that Simplicité modules are in fact exported as Maven projects, the extension will do all the necessary work when opening the project, for example to provide the necessary JavaDocs to get usefull autocompletion.
25+
26+
### Simplicité Extension
27+
28+
The [Simplicite VSCode tools extesion](https://marketplace.visualstudio.com/items?itemName=SimpliciteSoftware.simplicite-vscode-tools) is **optional**. It requires signing in to the app in the extesion, but is usefull to avoid "technical" git commits, as its main usage is to
29+
push code directly to the instance. Detailed documentation is available in the marketplace's README.
30+
31+
:::warning
32+
33+
You must activate the `DEV_MODE` system parameter for this extension to work.
34+
35+
:::
36+
37+
![vscode tools](img/external-editor/vscode.png)
523 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)