List of useful aliases for Mina developers

[dannywillems]

In my shell config, I have added a few shell aliases to facilitate the builds, tests run, etc of the Mina codebase. Here the list. I will try to keep it up-to-date. Feel free to share yours:

#  helps to grep an expression in the Mina repo, including submodules
mina-grep() {
    git grep --recurse-submodules -n $1 -- ':!*.cjs' ':!*.bc.*' ':!*.html' ':!*.min.js'
}

## generic make build aliases.
m-k() {
    make build
}

## Run the check performed by the CI job "Check merges cleanly into develop"

mina-c-m-develop() {
    git merge-tree `git merge-base origin/develop HEAD` HEAD origin/develop | grep -A 25 "^+<<<<<<<"
}

mina-env() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    eval $(opam env)
    gvm use go1.18.10
    nvm use v19.3.0
    export MINA_BUILD_DIR=${OPAM_SWITCH_PREFIX}/../_build
    MINA_ENV_SETUP=1
  fi
}

mina-drl() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/..
  dune runtest src/lib
  cd -
}

mina-build() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/..
  make build
  cd -
}

## Build specific libraries
snarky-build() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarky
  dune build
  cd -
}

snarkyjs-bindings-build() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarkyjs/src/bindings
  npm run bindings
  cd -
}

## Build specific libraries documentation
snarky-doc() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarky
  dune build @doc
  cd -
}

# Aliases to travel to different projects
## proof-systems
goto-proof-systems() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/crypto/proof-systems
}

## snarky
goto-snarky() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarky
}

## snarkyjs
goto-snarkyjs() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarkyjs
}

## snarkyjs
goto-snarkyjs-bindings() {
  if [ ${MINA_ENV_SETUP} -ne 1 ]
  then
    mina-env
  fi
  cd ${OPAM_SWITCH_PREFIX}/../src/lib/snarkyjs/src/bindings
}


## To split a commit containing changes related to the run of npm run bindings including other changes
git checkout --no-overlay HEAD~1 -- compiled
git checkout --no-overlay HEAD~1 -- MINA_COMMIT
git add compiled MINA_COMMIT
git commit -m "fixup"

To run the SnarkyJS tests locally (can be found in README-dev.md too):

npm run build:node
TEST_TYPE='Simple integration tests' bash run-ci-tests.sh
TEST_TYPE='DEX integration tests' bash run-ci-tests.sh
TEST_TYPE='DEX integration test with proofs' bash run-ci-tests.sh
TEST_TYPE='Voting integration tests' bash run-ci-tests.sh
TEST_TYPE='Unit tests' bash run-ci-tests.sh
TEST_TYPE='Verification Key Regression Check' bash run-ci-tests.sh
TEST_TYPE='CommonJS test' bash run-ci-tests.sh

You can also run exactly the CI using act:

act -j Build-And-Test-Server --matrix test_type:"DEX integration tests" -s GITHUB_TOKEN=$GITHUB_TOKEN

IMPORTANT
Never rebase on top of other people commits. Use git merge.

For instance, you have a branch B1 that needs to be merged in develop and a PR is opened, but it is outdated with develop, and you need the latest change from develop in B1 before merging it.
Use

git fetch origin
git checkout develop
git pull origin develop
git checkout B1
git merge develop

[dannywillems]

Updated with new functions, using mina-env first, and setting up with the correct nvm and go versions.
new functions are:

- goto-snarky
- goto-snarkyjs
- go-snarkyjs-bindings
- snarky-doc
- snarkyjs-bindings-build
- snarky-build
- mina-build
- mina-drl
- mina-env