Skip to content

Latest commit

 

History

History
289 lines (171 loc) · 7.88 KB

BUILDING.md

File metadata and controls

289 lines (171 loc) · 7.88 KB
Raw

Building quick-lint-js

Quick build

If you want to quickly compile quick-lint-js to try it out, and don't want to install CMake or Ninja, run the following commands (macOS and Linux only):

$ c++ -o quick-lint-js -std=gnu++17 -I src -I vendor/boost -I vendor/simdjson/include -I vendor/simdjson/src -D_LIBCPP_HIDE_FROM_ABI_PER_TU_BY_DEFAULT=1 -D_LIBCPP_INLINE_VISIBILITY="__attribute__((internal_linkage))" src/*.cpp vendor/boost/libs/container/src/*.cpp vendor/boost/libs/container/src/alloc_lib.c vendor/simdjson/src/simdjson.cpp
$ ./quick-lint-js path/to/my-file.js

For contributors

quick-lint-js contributors should use the CMake meta build system.

Recommended process:

  1. Run CMake to create a build directory containing project files.
  2. Run your build tool to compile quick-lint-js and its tests.
  3. Run quick-lint-js' tests directly.

The exact commands you need to run differs depending on your preferred development environment and build tool:

Linux: Ninja

0. Install build dependencies

Before building quick-lint-js, install the following third-party dependencies:

  • GCC version 8.3 or newer
  • CMake version 3.10 or newer
  • Ninja

For Debian, Ubuntu, and Linux Mint, run the following command to install all necessary dependencies:

$ sudo apt-get update && sudo apt-get install cmake g++ ninja-build

For Ubuntu 18.04 Bionic, run the following command to install all necessary dependencies:

$ sudo apt-get update && sudo apt-get install cmake g++-8 ninja-build

For CentOS, run the following command to install all necessary dependencies:

$ sudo dnf --enablerepo=powertools install cmake gcc-c++ ninja-build

For Fedora, run the following command to install all necessary dependencies:

$ sudo dnf install cmake gcc-c++ ninja-build

For Arch Linux, run the following command to install all necessary dependencies:

$ sudo pacman -Syy cmake gcc ninja

1. Configure with CMake

Run the following command to create a directory called build:

$ mkdir build ; cd build ; cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. ; cd "$OLDPWD"

For Ubuntu 18.04 Bionic, instead run the following command:

$ mkdir build ; cd build ; CC=gcc-8 CXX=g++-8 cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug .. ; cd "$OLDPWD"

2. Build

Run the following command to build the quick-lint-js executable, quick-lint-js' tests, and quick-lint-js' benchmarks:

$ ninja -C build

If you only want to build the quick-lint-js executable:

$ ninja -C build quick-lint-js

If you only want to build quick-lint-js' tests:

$ ninja -C build quick-lint-js-test

3. Run

Run the following command to run quick-lint-js' test suite:

$ ./build/test/quick-lint-js-test

If you want to run the quick-lint-js program:

$ ./build/quick-lint-js --help

Linux: make

0. Install build dependencies

Before building quick-lint-js, install the following third-party dependencies:

  • GCC version 8.3 or newer
  • CMake version 3.10 or newer
  • GNU Make

1. Configure with CMake

Run the following command to create a directory called build:

$ mkdir build ; cd build ; cmake -G 'Unix Makefiles' -DCMAKE_BUILD_TYPE=Debug .. ; cd "$OLDPWD"

2. Build

Run the following command to build the quick-lint-js executable, quick-lint-js' tests, and quick-lint-js' benchmarks:

$ make -j4 -C build

If you only want to build the quick-lint-js executable:

$ make -j4 -C build quick-lint-js

If you only want to build quick-lint-js' tests:

$ make -j4 -C build quick-lint-js-test

3. Run

Run the following command to run quick-lint-js' test suite:

$ ./build/test/quick-lint-js-test

If you want to run the quick-lint-js program:

$ ./build/quick-lint-js --help

macOS: Homebrew LLVM and Ninja

0. Install Homebrew packages

Install LLVM, CMake, and Ninja using [Homebrew][] by running the following command:

$ brew install cmake llvm ninja

1. Configure with CMake

Run the following command to use Homebrew's version of LLVM and create a directory called build:

$ PATH="$(brew --prefix)/opt/llvm/bin:$PATH" \
  CC=clang \
  CXX=clang++ \
  CPPFLAGS="-I$(brew --prefix)/opt/llvm/include" \
  CXXFLAGS=-D_LIBCPP_DISABLE_AVAILABILITY \
  LDFLAGS="-L$(brew --prefix)/opt/llvm/lib" \
  cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -S . -B build

2. Build

Run the following command to build the quick-lint-js executable, quick-lint-js' tests, and quick-lint-js' benchmarks:

$ ninja -C build

If you only want to build the quick-lint-js executable:

$ ninja -C build quick-lint-js

If you only want to build quick-lint-js' tests:

$ ninja -C build quick-lint-js-test

3. Run

Run the following command to run quick-lint-js' test suite:

$ ./build/test/quick-lint-js-test

If you want to run the quick-lint-js program:

$ ./build/quick-lint-js --help

Windows: Visual Studio

0. Install build dependencies

Before building quick-lint-js, install the following third-party dependencies:

1. Configure with CMake

Open x64 Native Tools Command Prompt for VS. Use cd to navigate to your quick-lint-js project directory. Run the following command to create a directory called build:

> cmake -G "Visual Studio 16 2019" -S . -B build

2. Build

Open the Visual Studio solution in the build directory:

> start build\quick-lint-js.sln

In Visual Studio, build the solution: press F6, or select the Build > Build Solution menu option.

3. Run

Open the Solution Explorer panel, right-click the quick-lint-js-test project, and select the Set as StartUp Project menu option.

Run the test program: press F5, or select the Debug > Start Debugging menu option.

If you want to run the quick-lint-js program, you can find it in build\Debug\quick-lint-js.exe. Run it from a command prompt or PowerShell window.

macOS and Linux: nix

This is for advanced users only. You need to install the Nix package manager if you have not already done so.

Nix uses derivation files that contain instructions for automation on how to build and package software. The dist/ folder contains such derivations for quick-lint-js and can be used to download dependencies and build it.

0. Prepare environment

The derivations in dist/ contain the necessary dependencies to build quick-lint-js using cmake and ninja. We can use nix-shell to download those dependencies and make them available for development.

$ nix-shell dist/nix/shell.nix

While it seems this does not do anything, you will be dropped in a shell that has the build tools available necessary to build quick-lint-js. Once you exit this shell, the downloaded dependencies will not be available anymore. You can use the above command again to re-create a shell with the build tools available at any time.

1. Configure

After running above command, we configure the build environment:

$ cmakeConfigurePhase

This will create a build/ folder in the project folder and changes the current directory to it.

2. Build

To build quick-lint-js, make sure you are in the build/ folder; the previous command should have already put you there. To start the build using ninja, you use:

$ ninjaBuildPhase

3. Run

After building, the binary is available as quick-lint-js in the build folder:

$ ./quick-lint-js --help

To run the tests, execute the test binary in the build directory:

$ ./test/quick-lint-js-test