You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by rc...@apache.org on 2023/06/30 02:19:52 UTC
[james-project] branch master updated: JAMES-2933 Update dev-build document - how to build james from IntelliJ (#1617)
This is an automated email from the ASF dual-hosted git repository.
rcordier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git
The following commit(s) were added to refs/heads/master by this push:
new 92d038947f JAMES-2933 Update dev-build document - how to build james from IntelliJ (#1617)
92d038947f is described below
commit 92d038947fd009d7bf79d4cb94cec332a1d1cc8a
Author: vttran <vt...@linagora.com>
AuthorDate: Fri Jun 30 09:19:46 2023 +0700
JAMES-2933 Update dev-build document - how to build james from IntelliJ (#1617)
---
.../intellij-idea/intellij-checkstyle-scan.png | Bin 0 -> 441786 bytes
.../intellij-idea/intellij-checkstyle-setting.png | Bin 0 -> 525461 bytes
.../images/intellij-idea/intellij-git-repo.png | Bin 20247 -> 0 bytes
.../intellij-idea/intellij-import-layout-java.png | Bin 0 -> 305334 bytes
.../intellij-idea/intellij-import-layout-scala.png | Bin 0 -> 386742 bytes
.../intellij-idea/intellij-james-project.png | Bin 80415 -> 226259 bytes
.../images/intellij-idea/intellij-james-zip.png | Bin 78556 -> 258215 bytes
.../server/images/intellij-idea/intellij-mvn.png | Bin 66624 -> 278225 bytes
.../images/intellij-idea/intellij-new-project.png | Bin 71315 -> 555985 bytes
src/site/xdoc/server/dev-build.xml | 27 +++++++++++++++------
10 files changed, 20 insertions(+), 7 deletions(-)
diff --git a/src/site/resources/server/images/intellij-idea/intellij-checkstyle-scan.png b/src/site/resources/server/images/intellij-idea/intellij-checkstyle-scan.png
new file mode 100644
index 0000000000..677a3002f2
Binary files /dev/null and b/src/site/resources/server/images/intellij-idea/intellij-checkstyle-scan.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-checkstyle-setting.png b/src/site/resources/server/images/intellij-idea/intellij-checkstyle-setting.png
new file mode 100644
index 0000000000..cc2c189c8c
Binary files /dev/null and b/src/site/resources/server/images/intellij-idea/intellij-checkstyle-setting.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-git-repo.png b/src/site/resources/server/images/intellij-idea/intellij-git-repo.png
deleted file mode 100644
index 3cd5c277fb..0000000000
Binary files a/src/site/resources/server/images/intellij-idea/intellij-git-repo.png and /dev/null differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-import-layout-java.png b/src/site/resources/server/images/intellij-idea/intellij-import-layout-java.png
new file mode 100644
index 0000000000..36a33a2fdb
Binary files /dev/null and b/src/site/resources/server/images/intellij-idea/intellij-import-layout-java.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-import-layout-scala.png b/src/site/resources/server/images/intellij-idea/intellij-import-layout-scala.png
new file mode 100644
index 0000000000..c32921ec6b
Binary files /dev/null and b/src/site/resources/server/images/intellij-idea/intellij-import-layout-scala.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-james-project.png b/src/site/resources/server/images/intellij-idea/intellij-james-project.png
index 8c1189843a..4279dbdb02 100644
Binary files a/src/site/resources/server/images/intellij-idea/intellij-james-project.png and b/src/site/resources/server/images/intellij-idea/intellij-james-project.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-james-zip.png b/src/site/resources/server/images/intellij-idea/intellij-james-zip.png
index 516ac52736..3e3d394ebf 100644
Binary files a/src/site/resources/server/images/intellij-idea/intellij-james-zip.png and b/src/site/resources/server/images/intellij-idea/intellij-james-zip.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-mvn.png b/src/site/resources/server/images/intellij-idea/intellij-mvn.png
index 3f1c966373..33a7579c2a 100644
Binary files a/src/site/resources/server/images/intellij-idea/intellij-mvn.png and b/src/site/resources/server/images/intellij-idea/intellij-mvn.png differ
diff --git a/src/site/resources/server/images/intellij-idea/intellij-new-project.png b/src/site/resources/server/images/intellij-idea/intellij-new-project.png
index dfd554409a..52481c7156 100644
Binary files a/src/site/resources/server/images/intellij-idea/intellij-new-project.png and b/src/site/resources/server/images/intellij-idea/intellij-new-project.png differ
diff --git a/src/site/xdoc/server/dev-build.xml b/src/site/xdoc/server/dev-build.xml
index 28d441389c..d29ac6ae30 100644
--- a/src/site/xdoc/server/dev-build.xml
+++ b/src/site/xdoc/server/dev-build.xml
@@ -101,17 +101,16 @@
<section name="Build James from IntelliJ IDEA">
- <p>This section has been created using IntelliJ IDEA 2019.2.1 and Maven 3. And downloading the master version of the server
- from <code>http://git-wip-us.apache.org/repos/asf/james-project.git/</code>.
+ <p>This section has been created using IntelliJ IDEA 2023.1.3 and Maven 3. And downloading the master version of the server
+ from <code>https://github.com/apache/james-project.git</code>.
</p>
<subsection name="Getting the sources from the repository">
<p>To download the source code, you can use the Git support that comes with IntelliJ IDEA following the next steps:</p>
- <p>First, in the Welcome page, click on <strong>Check out from Version Control</strong> and select <strong>Git</strong>.</p>
- <img src="./images/intellij-idea/intellij-new-project.png"/>
- <p>In the pop-up window, fill the <strong>URL</strong> part to <i>http://git-wip-us.apache.org/repos/asf/james-project.git</i>.</p>
- <img src="./images/intellij-idea/intellij-git-repo.png"/> <br/>
+ <p>First, in the Welcome page, click on <strong>Get from VCS</strong> and select <strong>Git</strong>.</p>
+ <p>In the pop-up window, fill the <strong>URL</strong> part to <i>https://github.com/apache/james-project.git</i>.</p>
+ <img src="./images/intellij-idea/intellij-new-project.png"/> <br/>
<p>When this process is done, the project should look like this. <br/></p>
<img src="./images/intellij-idea/intellij-james-project.png"/>
@@ -130,7 +129,7 @@
<p>We suggest you install these plugins for a better developing Apache James process:
<ul>
<li><a href="https://plugins.jetbrains.com/plugin/1347-scala">Scala</a>: Some parts of the project are written in Scala.</li>
- <li><a href="https://plugins.jetbrains.com/plugin/1065-checkstyle-idea">CheckStyle-IDEA</a>: Better engage the project' check style constraints.</li>
+ <li><a href="https://plugins.jetbrains.com/plugin/1065-checkstyle-idea">CheckStyle-IDEA</a>: Better engage the project' check style constraints. (the `checkstyle.xml` file is already in root directory)</li>
<li><a href="https://plugins.jetbrains.com/plugin/7391-asciidoc">AsciiDoc</a>: Better manage our Antora documentations.</li>
</ul>
</p>
@@ -166,6 +165,20 @@
</code>
</li>
</ul>
+
+ <p>To import Java layout, you can go to <strong>Settings > Editor > Code Style > Java</strong>. Then click to `Imports` tab, and
+ edit layout rule in `Import layout` section.</p>
+ <img src="./images/intellij-idea/intellij-import-layout-java.png"/>
+ <p>To import Scala layout, you can go to <strong>Settings > Editor > Code Style > Scala</strong>. Then click to `Imports` tab, and
+ edit layout rule in `Import layout` section.</p>
+ <img src="./images/intellij-idea/intellij-import-layout-scala.png"/>
+ <p>To use CheckStyle plugin, you can go to <strong>Settings > Tools > Checkstyle</strong>. Then click "+" button on Configuration File
+ section. The new window will be opened, and you need to input Description and file path to "checkstyle.xml"</p>
+ <img src="./images/intellij-idea/intellij-checkstyle-setting.png"/>
+ <p>After declaring the CheckStyle rule, you can scan the source code to verify whether the current import layout is correct or not
+ by opening the CheckStyle plugin, and select James rule, then clicking on <strong>Check Current File</strong> or <strong>Check Module</strong>
+ or <strong>Check Project</strong></p>
+ <img src="./images/intellij-idea/intellij-checkstyle-scan.png"/>
</subsection>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org