Wiki source code of Development Tools

Last modified by Thomas Mortagne on 2026/09/15 09:40

Show last authors
1 = Development Tools =
2
3 You will find here some development tools to be able to easier contribute to XWiki project. If you're an [[XWiki committer>>Community.Committership]] you can access some [[licenses for these tools>>DevelopmentToolLicenses]].
4
5 {{toc start="2"/}}
6
7 == XWiki scripts ==
8
9 You can find on https://github.com/xwiki/xwiki-dev-tools/tree/master/bash various command line tools which can be helpfull in the context of XWiki and XWiki Contrib.
10
11 == Java ==
12
13 The core technologies/programming language on which XWiki is based.
14
15 === Eclipse ===
16
17 {{info}}
18 Look at [[Building in Eclipse>>Community.BuildingInEclipse]] for some tutorials about configuring your workspace
19 {{/info}}
20
21 * URL: http://www.eclipse.org
22 * Description: Very well known and powerful open source development platform mostly targeting Java development.
23 * OS: Windows / Mac OS X / Linux
24
25 === IntelliJ IDEA ===
26
27 {{info}}
28 Look at [[Working in Intellij IDEA>>Community.BuildingInIdea]] for some tutorials about configuring your workspace
29 {{/info}}
30
31 * URL: http://www.jetbrains.com/idea/
32 * Description: Another development platform. There is an Open Source community version.
33 * OS: Windows / Mac OS X / Linux
34
35 == Bash ==
36
37 Those on Unix/Linux systems can find various helpers scripts on [[https://github.com/xwiki/xwiki-dev-tools/tree/master/bash]].
38
39 == In-Page editing ==
40
41 === gEdit ===
42
43 * URL: https://wiki.gnome.org/Apps/Gedit
44 * Description: A text editor very appreciated by developers. With syntax highlighting and a lot of available plug-ins.
45 * OS: Linux with ports for Windows and Mac OS X
46
47 === Velocity highlighting for gEdit ===
48
49 * URL: https://github.com/xwiki-contrib/gedit-velocity-highlighting
50 * Description: a file to add to have the Velocity Syntax support in gEdit.
51
52 == Atlassian JIRA issue tracker ==
53
54 The main issue tracking system used by all XWiki projects.
55
56 === Online ===
57
58 * URL: https://jira.xwiki.org
59
60 === Jira client ===
61
62 * URL: http://almworks.com/jiraclient
63 * Description: Desktop client for Atlassian JIRA issue tracker. XWiki project has global Jira Client license that anyone can use to access XWiki project jira server : [[XWiki Jiraclient license>>attach:jiraclient_xwiki.license||title="XWiki Jiraclient license"]]
64 * Environment: Windows / Mac OS X / Linux
65
66 == Git ==
67
68 The main version control system used for all XWiki projects sources.
69
70 === GitHub ===
71
72 That's where sources are actually hosted, it offers some online tools and help on how to use git.
73
74 === Git shell client ===
75
76 * URL: http://git-scm.com/
77 * Description: The official git client. Present in almost all Unix/Linux repositories distributions.
78 * Environment: Mac OS X / Linux. For Windows see http://code.google.com/p/msysgit/
79
80 == Maven ==
81
82 The main build system used by all XWiki projects.
83
84 === M2Eclipse ===
85
86 * URL: http://www.eclipse.org/m2e/
87 * Description: Integrate a Maven project with Eclipse and Eclipse plugins
88 * Environment: All Eclipse supported OS
89
90 === IntelliJ Idea integrated maven ===
91
92 * URL: http://www.jetbrains.com/idea/
93 * Description: Since version 7, IntelliJ natively support maven.
94 * Environment: All IntelliJ Idea supported OS
95
96 === Maven shell client ===
97
98 * URL: http://maven.apache.org
99 * Description: The official maven client. See [[Installing Maven>>Community.Building#HInstallingMaven]] for more.
100 * Environment: Windows / Mac OS X / Linux
101 * Bash completion: https://github.com/juven/maven-bash-completion
102
103 === xmvn ===
104
105 A special wrapper around mvn which make sure to build the current project with the expected version of Java. See https://github.com/xwiki/xwiki-dev-tools/tree/master/bash for more details.
106
107 == Checkstyle ==
108
109 The system used by maven to automates the process of checking Java code for XWiki coding standard. Configuration file : [[checkstyle.xml>>https://raw.githubusercontent.com/xwiki/xwiki-commons/master/xwiki-commons-tools/xwiki-commons-tool-verification-resources/src/main/resources/checkstyle.xml]].
110
111 === XWiki Checkstyle maven plugin ===
112
113 * URL: [[Community.CodeStyle]]
114 * Environment: Windows / Mac OS X / Linux
115
116 === Eclipse-cs ===
117
118 * URL: https://github.com/checkstyle/eclipse-cs
119 * Description: "With the Checkstyle Eclipse plug-in your code is constantly inspected for problems. Within the Eclipse workbench you are notified of problems via the Eclipse Problems View and source code annotations just as you would see with compiler errors or warnings."
120 * Environment: All Eclipse supported OS
121
122 {{warning}}
123 Don't use checkstyle.xml configuration file alone, or you'll get ##cannot initialize module TreeWalker - Unable to instantiate org.xwiki.tool.checkstyle.XWikiClassFanOutComplexityCheck##
124 errors in Eclipse while it tries to build your project. Instead, put the latest version of [[https:~~/~~/central.sonatype.com/artifact/org.xwiki.commons/xwiki-commons-tool-verification-resources>>https://central.sonatype.com/artifact/org.xwiki.commons/xwiki-commons-tool-verification-resources]] jar in Eclipse's ##dropins/## (recommended) or ##plugins/## folder. This jar contains a couple of XWiki specific checkstyle modules that are defined in XWiki's checkstyle.xml and without which the Eclipse-cs can not properly process the xml.
125 {{/warning}}
126
127 === CheckStyle-IDEA ===
128
129 * URL: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
130 * Description: " This plugin provides both real-time and on-demand scanning of Java files with CheckStyle from within IDEA."
131 * Environment: All IDEA supported OS
132
133 {{info}}
134 Clone the https://github.com/xwiki/xwiki-commons project and use the checkstyle.xml directly from the xwiki-commons-tool-verification-resources package.
135 {{/info}}
136
137 === Checkstyle official shell client ===
138
139 * URL: http://checkstyle.sourceforge.net/
140 * Description: The official Checktyle client.
141 * Environment: Windows / Mac OS X / Linux
142
143 == AspectJ ==
144
145 The tool used by XWiki mainly to keep deprecated methods/Class isolated from the "clean" code.
146
147 === Eclipse AJDT plugin ===
148
149 * URL: http://www.eclipse.org/ajdt/
150 * Description: very useful to build/edit aspectJ files
151 * Environment: All Eclipse supported OS
152
153 == Nexus ==
154
155 Used to perform cleanup of XWiki's remote repository (+ for staging and deployment in the future)
156
157 == YourKit ==
158
159 Use to debug performance issues (memory, CPU) by profiling XWiki.

Get Connected