Skip to content
Snippets Groups Projects
Commit 4b2b5eda authored by juanf's avatar juanf
Browse files

SSDM-13365 : Updated docs, coding style

parent aa13a06a
No related branches found
No related tags found
1 merge request!40SSDM-13578 : 2PT : Database and V3 Implementation - include the new AFS "free"...
...@@ -119,4 +119,17 @@ The project does not uses modules yet. Add '--add-opens' statements manually whe ...@@ -119,4 +119,17 @@ The project does not uses modules yet. Add '--add-opens' statements manually whe
## Setting up IntelliJ Idea ## Setting up IntelliJ Idea
1. Under "IntelliJ IDEA" -> "Preferences" -> "Languages and Frameworks" -> Javascript, set the 1. Under "IntelliJ IDEA" -> "Preferences" -> "Languages and Frameworks" -> Javascript, set the
language version to ECMAScript 6. language version to ECMAScript 6.
\ No newline at end of file
## Coding Style
openBIS uses a particular coding style that guarantees all code is formatted uniformly.
To make use of the preset go to File/Settings or IntelliJIDEA/Preferences depending on your OS.
Then import the XML file under 'docs/CISD_Conventions_IntelliJ_V2.xml'. See images below.
!["IntelliJ Code Style Configuration 1"](./docs/readme/intellij-codestyle-config-1.png "IntelliJ Code Style Configuration 1")
!["IntelliJ Code Style Configuration 2"](./docs/readme/intellij-codestyle-config-2.png "IntelliJ Code Style Configuration 2")
!["IntelliJ Code Style Configuration 3"](./docs/readme/intellij-codestyle-config-3.png "IntelliJ Code Style Configuration 3")
!["IntelliJ Code Style Configuration 4"](./docs/readme/intellij-codestyle-config-4.png "IntelliJ Code Style Configuration 4")
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<profiles version="21"> <profiles version="21">
<profile kind="CodeFormatterProfile" name="CISD Conventions V2" version="21"> <profile kind="CodeFormatterProfile" name="SIS Conventions V3" version="21">
<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/> <setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
<setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="false"/> <setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/> <setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
......
<code_scheme name="CISD Conventions V2" version="173"> <code_scheme name="SIS Conventions V3" version="173">
<option name="RIGHT_MARGIN" value="100" /> <option name="RIGHT_MARGIN" value="100" />
<JavaCodeStyleSettings> <JavaCodeStyleSettings>
<option name="SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT" value="true" /> <option name="SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT" value="true" />
......
docs/readme/intellij-codestyle-config-1.png

649 KiB

docs/readme/intellij-codestyle-config-2.png

52.9 KiB

docs/readme/intellij-codestyle-config-3.png

35.4 KiB

docs/readme/intellij-codestyle-config-4.png

169 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment