Building Smack

Linux

Building Smack is as simple as

git clone git@github.com:igniterealtime/Smack.git
cd Smack
gradle assemble

Mac

Smack requires a case-sensitive file system in order to build. Unfortunately, the macOS operating system is case-insensitive by default. To get around this, you can create a case-sensitive disk image to work from.

Launch Disk Utility (Applications > Utilities)
Click the +, or go to Edit > Add APFS Volume
Give it a name, e.g. "Smack"
Change the format to "APFS (Case-sensitive)"
Click Add

It'll auto-mount into /Volumes, e.g. /Volumes/Smack

cd /Volumes/Smack
git clone git@github.com:igniterealtime/Smack.git
cd Smack
gradle assemble

Windows

Smack requires a case-sensitive file system in order to build. Unfortunately, Windows NTFS is case-insensitive by default. To get around this, you can set specific folders as case-sensitive (requires Windows 10 v1803 or higher).

In an Administrator console:

fsutil.exe file SetCaseSensitiveInfo C:\git\Smack enable
cd \git\Smack
git clone git@github.com:igniterealtime/Smack.git
cd Smack
gradle assemble

IDE Config

Eclipse

Import IDE settings from ./resources/eclipse/ to configure proper ordering of imports and correct formatting that should pass the CheckStyle rules.

IntelliJ IDEA

Import Java Code Style settings from ./resources/intellij/smack_formatter.xml to configure import optimisation and code formatting to pass the CheckStyle rules when building or submitting PRs.

We've noticed, at time of writing, that IntelliJ often requires a restart when applying new rules - no amount of OK/Apply will do the trick.

1.7 KiB Raw Blame History