status-react/nix
Icaro Motta 7f960f9be5
Add custom linter for i18n/label translation keywords (#17610)
This commit adds a custom linter to verify i18n/label is called with a qualified
keyword, like :t/foo. More sophisticated linters are possible too.

We also set the stage for other developers to consider more lint automation
instead of manually reviewing conventions in PRs.

If you want to understand how to write custom linters, check out
https://github.com/clj-kondo/clj-kondo/blob/master/doc/hooks.md. You can fire
the Clojure JVM REPL in status-mobile and play with the clj-kondo hook too, it
works beautifully.

Why do we care? By making sure all translation keywords are qualified with "t",
it is trivial to grep or replace them because they're unique in the repo, and
can't be confused with other words if you search by ":t/<something>".

Note: It's a best practice to commit clj-kondo configuration from external
libraries in the .clj-kondo directory. The directory .clj-kondo/babashka is
auto-generated, that's why it was added.
2023-10-11 18:53:34 -03:00
..
deps Add custom linter for i18n/label translation keywords (#17610) 2023-10-11 18:53:34 -03:00
lib nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
mobile nix: set ios status-go targets 2023-09-07 14:15:30 +02:00
pkgs nix: downgrade watchman to 4.9.0 2023-07-02 08:46:28 +02:00
scripts nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
status-go Update status-go to v0.167.6 2023-10-04 01:16:25 +03:00
DETAILS.md nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
KNOWN_ISSUES.md nix: fix applying nix.conf by using correct env var 2023-06-20 13:55:07 +02:00
README.md nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
default.nix Cleanup 2020-01-10 19:59:54 +01:00
nix.conf nix: build derivation from sources if cache fails 2023-06-25 23:34:59 +02:00
overlay.nix Upgrade clj-kondo and configure new linters (#17543) 2023-10-05 15:50:57 -03:00
pkgs.nix nix: switch status-im config to env vars, cleanup 2023-08-07 14:50:36 +02:00
shell.nix nix: add missing Apple SDKs to fix make test on macOS 2023-06-24 10:56:21 +02:00
shells.nix nix: make fetching Gradle dependencies more generic 2023-09-04 09:57:53 +02:00
targets.nix drop all desktop related files and references 2020-07-08 10:26:51 +02:00

README.md

Description

This folder contains configuration for Nix, a purely functional package manager used by the Status app for its build process.

Configuration

The main config file is nix/nix.conf and its main purpose is defining the binary caches which allow download of packages to avoid having to compile them yourself locally.

Build arguments

We leverage the environment variables for parameterization of the builds (e.g. to pass a build number or build type).

Here is the list of variables you can use to override defaults:

# Build type (influences which .env file gets used for feature flags)
export BUILD_TYPE="pr"
# Used for versionCode and CFBundleVersion in Android and iOS respectively
export BUILD_NUMBER=9999
# Gradle options passed for Android builds
export ANDROID_GRADLE_OPTS=""
# If APKs should be split based on architectures
export ANDROID_ABI_SPLIT=false
# Android architectures to build for
export ANDROID_ABI_INCLUDE="x86"
# Local source override, see below
export STATUS_GO_SRC_OVERRIDE="$HOME/my/source/status-go"
export STATUS_GO_IPFS_GATEWAY_URL="https://ipfs.status.im/"

You can see the defaults in code:

Shell

In order to access an interactive Nix shell a user should run make shell.

The Nix shell is started in this repo via the nix/scripts/shell.sh script, which is a wrapper around the nix-shell command and is intended for use with our main Makefile. This allows for an implicit use of nix-shell as the default shell in the Makefile.

Normally the shell starts without any specific target platform, if you want to change that you should export the TARGET env variable with appropriate value:

make shell TARGET=android

This way your shell and all other nix commands should run in a setup that is tailored towards Android development.

For valid values you can check the nix/shells.nix file.

⚠️ WARNING: To have Nix pick up all changes a new nix-shell needs to be spawned.

Using a local status-go repository

If you need to use a locally checked-out status-go repository, you can achieve that by defining the STATUS_GO_SRC_OVERRIDE environment variable:

export STATUS_GO_SRC_OVERRIDE=$GOPATH/src/github.com/status-im/status-go
make release-android

Resources

You can learn more about Nix by watching these presentations:

And you can read nix/DETAILS.md for more information.

Known Issues

See KNOWN_ISSUES.md.