Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 6.57 KB

README.md

File metadata and controls

101 lines (76 loc) · 6.57 KB
Raw

ZigZen

Welcome! ZigZen is an IDE based off IntelliJ IDEA Community Edition which provides tight integration with the Zig language. These instructions will help you build it from source code. The following conventions will be used to refer to directories on your machine:

  • <USER_HOME> is your home directory.
  • <ZIGZEN_HOME> is the root directory for the ZigZen source code.

Getting ZigZen Source Code

ZigZen source code is available from github.com/ZigIDE/ZigZen by either cloning or downloading a zip file (based on a branch) into <ZIGZEN_HOME>. The default is the 241.14494 branch. It contains the source code which will be used to create the 2024.1 version of ZigZen.

These Git operations can also be done through the IntelliJ IDEA user interface.

Speed Tip: If the complete repository history isn't needed, then using a shallow clone (git clone --depth 1) will save significant time.

On Windows: Two git options are required to check out sources on Windows. Since it's a common source of Git issues on Windows anyway, those options could be set globally (execute those commands before cloning any of intellij-community/android repositories):

  • git config --global core.longpaths true
  • git config --global core.autocrlf input

ZigZen requires additional Android modules from separate Git repositories. To clone these repositories, run one of the getPlugins scripts located in the <ZIGZEN_HOME> directory. Use the --shallow argument if the complete repository history isn't needed. These scripts clone their respective master branches. Make sure you are inside the <ZIGZEN_HOME> directory when running those scripts, so the modules get cloned inside the <ZIGZEN_HOME> directory.

  • getPlugins.sh for Linux or macOS.
  • getPlugins.bat for Windows.

Note: Always git checkout the ZigZen and android Git repositories to the same branches/tags.

Building ZigZen

Version 2023.2 or newer of IntelliJ IDEA Community Edition or IntelliJ IDEA Ultimate Edition is required to build ZigZen.

Opening the ZigZen Source Code for Build

Using IntelliJ IDEA File | Open, select the <ZIGZEN_HOME> directory.

IntelliJ Build Configuration

  1. It's recommended to use JetBrains Runtime 17 to compile the project. When you invoke Build Project for the first time, IntelliJ IDEA should suggest downloading it automatically.
  2. If the Maven plugin is disabled, add the path variable "MAVEN_REPOSITORY" pointing to <USER_HOME>/.m2/repository directory.
  3. Make sure you have at least 8GB of RAM on your computer. With the bare minimum of RAM, disable "Compile independent modules in parallel" option in the compiler settings. With notably more memory available, increase "User-local build process heap size" to 3000 - that will greatly reduce compilation time.

Note that it is important to use the variant of JetBrains Runtime without JCEF. So, if for some reason jbr-17 SDK points to an installation of JetBrains Runtime with JCEF, you need to change it: ensure that IntelliJ IDEA is running in internal mode (by adding idea.is.internal=true to idea.properties file), navigate to jbr-17 item in Project Structure | SDKs, click on 'Browse' button, choose 'Download...' item and select version 17 and vendor 'JetBrains Runtime'.

Building the ZigZen Source Code

To build ZigZen from source, choose Build | Build Project from the main menu.

To build installation packages, run the installers.cmd command in <ZIGZEN_HOME> directory. installers.cmd will work on both Windows and Unix systems.

Options to build installers are passed as system properties to installers.cmd command. You may find the list of available properties in BuildOptions.kt

Examples (./ should be added only for Linux/macOS):

  • Build installers only for current operating system: ./installers.cmd -Dintellij.build.target.os=current
  • Build source code incrementally (do not build what was already built before): ./installers.cmd -Dintellij.build.incremental.compilation=true

installers.cmd is used just to run OpenSourceCommunityInstallersBuildTarget from the command line. You may call it directly from IDEA, see run configuration Build ZigZen Community Installers (current OS) for an example.

Dockerized Build Environment

To build installation packages inside a Docker container with preinstalled dependencies and tools, run the following command in <ZIGZEN_HOME> directory (on Windows, use PowerShell):
docker run --rm -it -v ${PWD}:/community $(docker build -q . --target build_env)

Running ZigZen

To run the ZigZen built from source, choose Run | Run from the main menu. This will use the preconfigured run configuration "ZigZen".

To run tests on the build, apply these setting to the Run | Edit Configurations... | Templates | JUnit configuration tab:

  • Working dir: <ZIGZEN_HOME>/bin
  • VM options:
    • -ea

You can find other helpful information at https://www.jetbrains.com/opensource/idea. The "Contribute Code" section of that site describes how you can contribute to ZigZen.

Running ZigZen on CI/CD environment

To run tests outside of ZigZen, run the tests.cmd command in <ZIGZEN_HOME> directory. tests.cmd will work on both Windows and Unix systems.

Options to run tests are passed as system properties to tests.cmd command. You may find the list of available properties in TestingOptions.kt

Examples (./ should be added only for Linux/macOS):

  • Build source code incrementally (do not build what was already built before): ./tests.cmd -Dintellij.build.incremental.compilation=true
  • Run a specific test: ./tests.cmd -Dintellij.build.test.patterns=com.intellij.util.ArrayUtilTest

tests.cmd is used just to run CommunityRunTestsBuildTarget from the command line. You may call it directly from IDEA, see run configuration tests in community for an example.