Apache
/
hbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

HBASE-23688 Update docs for setting up IntelliJ as a development environment (#1041) 

Signed-off-by: stack <stack@apache.org>
This commit is contained in:
Nick Dimiduk 2020-01-14 22:25:18 -08:00 committed by Michael Stack
parent 4e60583b5a
commit 8cd6410128
1 changed files with 23 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/main/asciidoc/_chapters/developer.adoc
View File

@ -284,22 +284,34 @@ For additional information on setting up Eclipse for HBase development on Window
=== IntelliJ IDEA === IntelliJ IDEA
You can set up IntelliJ IDEA for similar functionality as Eclipse. A functional development environment can be setup around an IntelliJ IDEA installation that has the
Follow these steps. plugins necessary for building Java projects with Maven.
. Select . Use either File > New > "Project from Existing Sources..." or "Project From Version Control.."
. You do not need to select a profile. . Depending on your version of IntelliJ, you may need to choose Maven as the "project" or "model"
Be sure [label]#Maven project type.
required# is selected, and click btn:[Next].
. Select the location for the JDK.
.Using the HBase Formatter in IntelliJ IDEA The following plugins are recommended:
Using the Eclipse Code Formatter plugin for IntelliJ IDEA, you can import the HBase code formatter described in <<eclipse.code.formatting,eclipse.code.formatting>>.
. Maven, bundled. This allows IntelliJ to resolve dependencies and recognize the project structure.
. EditorConfig, bundled. This will apply project whitespace settings found in the the
`.editorconfig` file available on branches with
link:https://issues.apache.org/jira/browse/HBASE-23234[HBASE-23234] or later.
. link:https://plugins.jetbrains.com/plugin/1065-checkstyle-idea/[Checkstyle-IDEA]. Configure this
against the configuration file found under `hbase-checkstyle/src/main/resources/hbase/checkstyle.xml`.
This will highlight style errors in the IDE, so you can fix them before they get flagged during the
pre-commit process.
. link:https://plugins.jetbrains.com/plugin/8277-protobuf-support/[Protobuf Support]. HBase uses
link:https://developers.google.com/protocol-buffers/[Protocol Buffers] in a number of places where
serialization is required. This plugin is helpful when editing these object definitions.
. link:https://plugins.jetbrains.com/plugin/7391-asciidoc/[AsciiDoc]. HBase uses
link:http://asciidoc.org[AsciiDoc] for building it's project documentation. This plugin is helpful
when editing this book.
=== Other IDEs === Other IDEs
It would be useful to mirror the <<eclipse,eclipse>> set-up instructions for other IDEs. If you'd have another environment with which you'd like to develop on HBase, please consider
If you would like to assist, please have a look at link:https://issues.apache.org/jira/browse/HBASE-11704[HBASE-11704]. documenting your setup process here.
[[build]] [[build]]
== Building Apache HBase == Building Apache HBase