https://github.com/entando/entando-code-style
Entando code-style repository
https://github.com/entando/entando-code-style
Last synced: 6 months ago
JSON representation
Entando code-style repository
- Host: GitHub
- URL: https://github.com/entando/entando-code-style
- Owner: entando
- License: apache-2.0
- Created: 2019-09-04T13:54:54.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T11:18:45.000Z (over 5 years ago)
- Last Synced: 2025-02-01T03:28:06.269Z (over 1 year ago)
- Size: 32.2 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# entando-code-style
Purpose of this repository is to collect the
code-style rules we are adopting in Entando and
to propose updates to the rules that are accepted by
Entando's developers
## Import code style configuration on your favorite IDE
To make sure that the code written is formatted properly and adhere to Checkstyle rules,
we have created code style configuration for the 3 main Java IDEs (Intellij IDEA,
Apache NetBeans and Eclipse).
### Import the code style on Intellij IDEA
Go to **Settings -> Editor -> Code Style**. Click on the Gear Icon from the Scheme field
and select **Import Scheme -> Intellij IDEA code style XML**. Choose the Intellij configuration
file in config/intellij-java-entando-style.xml
### Import the code style on Apache NetBeans
Go to **Tools -> Options**. Click on **Import...** and choose the NetBeans configuration
file in config/netbeans-java-entando-style.zip
### Import the code style on Eclipse
Go to **Window -> Preferences -> Java -> Code Style -> Formatter** and click on **Import...**.
Choose the Eclipse configuration file in config/eclipse-java-entando-style.xml
After that go to **Window -> Preferences -> Java -> Code Style -> Organize Imports** and
remove everything from the Field **Define the sorting order of import...**
## PMD version
The Maven PMD Plugin does not use the latest PMD version. At the time of this writing,
maven-pmd-plugin version 3.12.0 uses PMD 6.13.0. To use the latest PMD version, add the
following configuration to `pom.xml`:
```xml
...choose your version...
...
org.apache.maven.plugins
maven-pmd-plugin
3.12.0
net.sourceforge.pmd
pmd-core
${pmd-version}
net.sourceforge.pmd
pmd-java
${pmd-version}
...
```
Get the latest PMD version from their homepage: https://pmd.github.io/