Added build scripts for linux, macos and windows to help new contributors get setup quickly (#21)

Co-authored-by: Vijay A <vraravam@users.noreply.github.com>
Co-authored-by: André Oliveira <oliveira.andrerodrigues95@gmail.com>

2 files changed, 235 insertions, 0 deletions

diff --git a/scripts/build-unix.sh b/scripts/build-unix.sh
new file mode 100755
index 000000000..e80c38059
--- /dev/null
+++ b/scripts/build-unix.sh
@@ -0,0 +1,135 @@
+#!/bin/bash
+
+# INTRO:
+# This file is used to build ferdium on both x64 and arm-based for macos and linux (not tested on arm for linux).
+# It also handles any corrupted node modules with the 'CLEAN' env var (set it to 'true' for cleaning)
+# It will install the system dependencies except for node (which is still verified)
+# I sometimes symlink my 'recipes' folder so that any changes that I need to do in it can also be committed and pushed
+# This file can live anywhere in your PATH
+
+set -e
+
+export ELECTRON_CACHE=$HOME/.cache/electron
+export ELECTRON_BUILDER_CACHE=$HOME/.cache/electron-builder
+export CSC_IDENTITY_AUTO_DISCOVERY=false
+export CI=true
+
+# -----------------------------------------------------------------------------
+#                  Utility functions
+fail_with_docs() {
+  printf "\n*************** FAILING ***************\n"
+  echo "$1"
+  echo ""
+  echo "Please read the developer documentation in CONTRIBUTING.md"
+  exit 1
+}
+
+command_exists() {
+  type "$1" &>/dev/null 2>&1
+}
+
+# -----------------------------------------------------------------------------
+#                  Checking the developer environment
+# checking for installed programmes
+command_exists node || fail_with_docs "Node is not installed"
+command_exists jq || fail_with_docs "jq is not installed"
+
+EXPECTED_NODE_VERSION=$(cat .nvmrc)
+ACTUAL_NODE_VERSION=$(node -v)
+if [ "v$EXPECTED_NODE_VERSION" != "$ACTUAL_NODE_VERSION" ]; then
+  fail_with_docs "You are not running the expected version of node!
+    expected: [v$EXPECTED_NODE_VERSION]
+    actual  : [$ACTUAL_NODE_VERSION]"
+fi
+
+# Check if the 'recipes' folder is present either as a git submodule or a symbolic link
+if ! [ -f "recipes/package.json" ]; then
+  fail_with_docs "'recipes' folder is missing or submodule has not been checked out"
+fi
+
+# This log statement is only to remind me which 'recipes' folder I am using (symlink or git submodule)
+if [[ -L recipes ]]; then
+  printf "\n*************** CONTINUING for 'recipes' symlinked ***************\n"
+else
+  printf "\n*************** CONTINUING for 'recipes' submodule ***************\n"
+fi
+
+# -----------------------------------------------------------------------------
+# If you are moving to a new version of node or any other system dependency, then cleaning is recommended
+# so that there's no irregular results due to cached modules
+if [ "$CLEAN" != "true" ]; then
+  printf "\n*************** SKIPPING Cleaning ***************\n"
+else
+  printf "\n*************** Cleaning!!!!!! ***************\n"
+  npm cache clean --force
+  rm -rf ~/.npm ~/.node-gyp ~/.asdf/installs/nodejs/*/.npm/
+  if [[ -s 'pnpm-lock.yaml' ]]; then
+    pnpm store prune || true # in case the pnpm executable itself is not present
+    rm -rf ~/.pnpm-store ~/.pnpm-state
+  fi
+
+  git -C recipes clean -fxd # Clean recipes folder/submodule
+  git clean -fxd            # Note: This will blast away the 'recipes' folder if you have symlinked it
+fi
+
+# -----------------------------------------------------------------------------
+printf "\n*************** Installing node dependencies ***************\n"
+# If 'asdf' is installed, reshim for new nodejs if necessary
+command_exists asdf && asdf reshim nodejs
+
+# Ensure that the system dependencies are at the correct version
+EXPECTED_NPM_VERSION=$(jq --raw-output .engines.npm <"package.json")
+EXPECTED_PNPM_VERSION=$(jq --raw-output .engines.pnpm <"./recipes/package.json")
+if [[ "$(npm --version)" != "$EXPECTED_NPM_VERSION" ]]; then
+  npm i -gf "npm@$EXPECTED_NPM_VERSION"
+fi
+if [[ "$(pnpm --version)" != "$EXPECTED_PNPM_VERSION" ]]; then
+  npm i -gf "pnpm@$EXPECTED_PNPM_VERSION"
+fi
+
+# If 'asdf' is installed, reshim for new nodejs if necessary
+command_exists asdf && asdf reshim nodejs
+
+# This is useful if we move from 'npm' to 'pnpm' for the main repo as well
+if [[ -s 'pnpm-lock.yaml' ]]; then
+  BASE_CMD=pnpm
+else
+  BASE_CMD=npm
+fi
+
+# Now the meat.....
+$BASE_CMD i
+$BASE_CMD run prepare-code
+
+# -----------------------------------------------------------------------------
+printf "\n*************** Building recipes ***************\n"
+# Note: 'recipes' is already using only pnpm - can switch to $BASE_CMD AFTER both repos are using pnpm
+pushd recipes
+pnpm i
+pnpm run package
+popd
+
+# -----------------------------------------------------------------------------
+printf "\n*************** Building app ***************\n"
+if [[ "$(uname -m)" =~ "arm" ]]; then
+  TARGET_ARCH=arm64
+else
+  TARGET_ARCH=x64
+fi
+
+if [[ "$(uname)" =~ "Darwin" ]]; then
+  TARGET_OS="mac"
+else
+  TARGET_OS="linux"
+fi
+
+$BASE_CMD run build -- "--$TARGET_ARCH" --"$TARGET_OS" --dir
+
+printf "\n*************** App successfully built! ***************\n"
+# Final check to ensure that the version built is the same as the latest commit
+cat build/buildInfo.json
+git --no-pager log -1
+if [[ $(git rev-parse --short HEAD) != $(jq --raw-output .gitHashShort <"build/buildInfo.json") ]]; then
+  echo "The built version is not on the latest commit"
+  exit 1
+fi
diff --git a/scripts/build-windows.ps1 b/scripts/build-windows.ps1
new file mode 100644
index 000000000..9d4219ffb
--- /dev/null
+++ b/scripts/build-windows.ps1
@@ -0,0 +1,100 @@
+# INTRO:
+# This file is used to build ferdium on windows.
+# It also handles any corrupted node modules with the 'CLEAN' env var (set it to 'true' for cleaning)
+# It will install the system dependencies except for node (which is still verified)
+# I sometimes symlink my 'recipes' folder so that any changes that I need to do in it can also be committed and pushed
+# This file can live anywhere in your PATH
+
+#CHECK PYTHON
+#CHECK NODE.JS
+#CHECK NPM
+#CHECK MSVS_VERSION and MSVS Tools
+
+$USERHOME = "${env:HOMEDRIVE}${env:HOMEPATH}"
+
+$env:ELECTRON_CACHE = $USERHOME + '/.cache/electron'
+$env:ELECTRON_BUILDER_CACHE = $USERHOME + '/.cache/electron-builder'
+$env:CSC_IDENTITY_AUTO_DISCOVERY = $false
+
+$env:CI = $true
+
+$EXPECTED_NODE_VERSION = (Get-Content .\.nvmrc)
+$ACTUAL_NODE_VERSION = (node -v)
+
+if ( "v$EXPECTED_NODE_VERSION" -ne $ACTUAL_NODE_VERSION)
+{
+  Write-Host "You are not running the expected version of node!"
+  Write-Host "  expected: [v$EXPECTED_NODE_VERSION]"
+  Write-Host "  actual  : [$ACTUAL_NODE_VERSION]"
+  exit 1
+}
+
+if ( $env:CLEAN -eq "true" )
+{
+  $NPM_PATH = "$USERHOME\.npm"
+  $NODE_GYP = "$USERHOME\.node-gyp"
+
+  Write-Host "Cleaning!"
+  npm cache clean --force
+  Remove-Item -Path $NPM_PATH -Recurse
+  Remove-Item -Path $NODE_GYP -Recurse
+
+  if ( Test-Path -Path ".\pnpm-lock.yaml" -and (Get-Command -ErrorAction Ignore -Type Application pnpm) )
+  {
+    $PNPM_STORE = "$USERHOME\.pnpm-store"
+    $PNPM_STATE = "$USERHOME\.pnpm-state"
+
+    pnpm store prune
+
+    Remove-Item -Path $PNPM_STORE -Recurse
+    Remove-Item -Path $PNPM_STATE -Recurse
+  }
+
+  git -C recipes clean -fxd
+  git clean -fxd # Note: This will blast away the 'recipes' folder if you have symlinked it
+}
+
+# Ensure that the system dependencies are at the correct version
+npm i -gf npm@8.7.0
+npm i -gf pnpm@6.32.8
+
+# This is useful if we move from 'npm' to 'pnpm' for the main repo as well
+if ( (Test-Path -Path ".\pnpm-lock.yaml") -and (Get-Command -ErrorAction Ignore -Type Application pnpm) )
+{
+  $BASE_CMD="pnpm"
+  $env:EXEC_CMD="pnpm dlx"
+}
+else
+{
+  $BASE_CMD="npm"
+  $env:EXEC_CMD="npx"
+}
+
+# Now the meat.....
+& $BASE_CMD i
+& $BASE_CMD run prepare-code
+
+# Check if the 'recipes' folder is present either as a git submodule or a symbolic link
+if (-not (Test-Path -Path ".\recipes\package.json"))
+{
+  try {
+    git submodule update --init --recursive --remote --rebase --force
+  } catch {
+    Write-Host "FAILING since 'recipes' folder/submodule has not been checked out"
+    exit 1
+  }
+}
+
+# Note: 'recipes' is already using only pnpm - can switch to $BASE_CMD AFTER both repos are using pnpm
+Set-Location recipes
+pnpm i
+pnpm run package
+Set-Location ..
+
+$TARGET_ARCH="x64"
+& $BASE_CMD run build -- --$TARGET_ARCH --dir
+
+# Final check to ensure that the version built is the same as the latest commit
+# TODO: Need to make this an assertion similar to tthe unix-equivalent
+Get-Content "build/buildInfo.json" | ConvertFrom-Json
+git log -1