Skip to content

Commit 31ac40b

Browse files
github-user-23github-user-23
authored
Adding ./setup.sh to automate development setup, (also added ./watch.sh wrapper) (#3973)
1 parent d0c8342 commit 31ac40b

11 files changed

+214
-1
lines changed

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ There are a variety of ways to connect with Dendron devs, contributors, and othe
196196

197197
Dendron wouldn't be what it is today without help from the wonderful gardeners 👨‍🌾👩‍🌾
198198

199-
If you would like to contribute (docs, code, finance, or advocacy), you can find instructions to do so [here](https://wiki.dendron.so/notes/125c990b-6fe7-4ada-a65f-44cbde8b33f0.html).
199+
If you would like to contribute (docs, code, finance, or advocacy), you can find instructions to do so [here](https://wiki.dendron.so/notes/125c990b-6fe7-4ada-a65f-44cbde8b33f0.html). For setup of local development environment run `./setup.sh` which automates the setup.
200200

201201
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
202202
<!-- prettier-ignore-start -->

‎setup.sh

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Description: Setup the environment for Dendron development.
2+
#
3+
# For further documentation refer to [Dendron Plugin Quickstart]:
4+
# https://docs.dendron.so/notes/64f0e2d5-2c83-43df-9144-40f2c68935aa/
5+
main() {
6+
export DENDRON_MONOREPO="${PWD:?}"
7+
8+
"${DENDRON_MONOREPO:?}"/shell/setup.sh
9+
}
10+
11+
main "${@}" || exit 1

‎shell/_setup_nvm_source_me.sh

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
main() {
2+
if [[ ! -f "$HOME/.nvm/nvm.sh" ]]
3+
then
4+
echo "File $HOME/.nvm/nvm.sh does NOT exists. Setup NVM refer to https://github.com/nvm-sh/nvm"
5+
exit 1
6+
fi
7+
8+
# Source nvm script - adjust the path if it's different on your machine
9+
#
10+
# -s check if file exists and has a size greater than zero
11+
[ -s "$HOME/.nvm/nvm.sh" ] && {
12+
source "$HOME/.nvm/nvm.sh"
13+
echo "Sourced $HOME/.nvm/nvm.sh"
14+
}
15+
}
16+
17+
main "${@}" || exit 1

‎shell/_util.sh

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# --------------------------------------------------------------------------------
2+
# ANSI escape code for green color
3+
export COLOR_GREEN="\033[0;32m"
4+
# ANSI escape code to reset color back to default
5+
export COLOR_RESET="\033[0m" # No Color
6+
# ANSI escape code for red color
7+
export COLOR_RED="\033[0;31m"
8+
9+
echo_green(){
10+
echo -e "${COLOR_GREEN:?}${*}${COLOR_RESET:?}"
11+
}
12+
13+
# Check if the file exists and source it.
14+
source_robust(){
15+
local file="${1:?}"
16+
17+
if [ ! -f "${file:?}" ]; then
18+
echo -e "${COLOR_RED:?}File not found: ${file:?}${COLOR_RESET:?}"
19+
exit 1
20+
fi
21+
22+
# shellcheck disable=SC1090
23+
source "${file:?}"
24+
}
25+
26+
# Announces command (prints out the command that is going to be executed).
27+
# Executes the command.
28+
# If the command fails, prints out error and exits.
29+
#
30+
# Note this function will use 'source' with a temporary file, to allow
31+
# the functions that are executed to modify environment variables.
32+
eae(){
33+
local execution_file=/tmp/execution_file_dendron_setup.sh
34+
echo "${@:?}" > "${execution_file:?}"
35+
36+
echo ""
37+
echo -e "Executing: ${COLOR_GREEN}$(cat "${execution_file:?}")${COLOR_RESET:?}"
38+
39+
# We use source_robust instead of 'eval' to be able to modify environment variables
40+
# from the commands that we are running with eae.
41+
#
42+
# shellcheck disable=SC1090
43+
if ! source "${execution_file:?}"; then
44+
echo -e "${COLOR_RED:?}Error executing: $(cat "${execution_file:?}")${COLOR_RESET:?}"
45+
exit 1
46+
fi
47+
}

‎shell/_verify_env_variables.sh

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
main() {
2+
# -z: returns true when value is empty.
3+
if [[ -z "${DENDRON_MONOREPO}" ]]; then
4+
echo "DENDRON_MONOREPO environment variable is not set."
5+
exit 1
6+
fi
7+
}
8+
9+
main "${@}" || exit 1

‎shell/_verify_node_version.sh

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
main() {
2+
MIN_VERSION="14.0.0"
3+
4+
# Get the current Node.js version
5+
CURRENT_VERSION=$(node -v | sed 's/v//') # Removes the 'v' prefix from version
6+
7+
# Function to compare versions
8+
version_gt() { test "$(printf '%s\n' "$@" | sort -V | head -n 1)" != "$1"; }
9+
10+
# Check if the current version is greater than or equal to the minimum version
11+
if version_gt "$CURRENT_VERSION" "$MIN_VERSION"; then
12+
echo "Current Node.js version is $CURRENT_VERSION. Proceeding..."
13+
else
14+
echo "Error: Node.js version must be $MIN_VERSION or greater. Current version is $CURRENT_VERSION."
15+
exit 1
16+
fi
17+
}
18+
19+
main "${@}" || exit 1

‎shell/_verify_npm.sh

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
main() {
2+
if command -v npm > /dev/null 2>&1; then
3+
echo "Verified npm is installed."
4+
else
5+
echo "npm is not installed. Please install Node.js and npm."
6+
exit 1
7+
fi
8+
}
9+
10+
main "${@}" || exit 1

‎shell/_verify_nvm_source_me.sh

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
main() {
2+
if type nvm > /dev/null 2>&1; then
3+
echo "nvm is installed."
4+
else
5+
echo "nvm is not installed. Please install nvm. (https://github.com/nvm-sh/nvm)"
6+
exit 1
7+
fi
8+
}
9+
10+
main "${@}" || exit 1

‎shell/_verify_yarn.sh

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
main() {
2+
if command -v yarn > /dev/null 2>&1; then
3+
echo "Verified Yarn is installed."
4+
else
5+
echo "Yarn is not installed. Please install Yarn."
6+
exit 1
7+
fi
8+
}
9+
10+
main "${@}" || exit 1

‎shell/setup.sh

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Description: Setup the environment for Dendron development.
2+
#
3+
# Pre-requisites:
4+
# - DENDRON_MONOREPO environment variable must be set.
5+
# It should point to dendron's monorepo
6+
# (directory where you cloned https://github.com/dendronhq/dendron.git into)
7+
#
8+
# This script is based off of https://docs.dendron.so/notes/64f0e2d5-2c83-43df-9144-40f2c68935aa/
9+
10+
# -z: returns true when value is empty.
11+
if [[ -z "${DENDRON_MONOREPO}" ]]; then
12+
echo "DENDRON_MONOREPO environment variable is not set. Please set it to dendron's monorepo directory."
13+
exit 1
14+
fi
15+
16+
if [[ -f "${DENDRON_MONOREPO:?}"/shell/_util.sh ]]
17+
then
18+
source "${DENDRON_MONOREPO:?}"/shell/_util.sh
19+
else
20+
echo "File not found: ${DENDRON_MONOREPO:?}/shell/_util.sh"
21+
exit 1
22+
fi
23+
24+
_setup_node_version(){
25+
# NVM is often not propagated to subshells. This is a workaround to
26+
# allow usage of NVM within the script.
27+
source_robust "${DENDRON_MONOREPO:?}"/shell/_setup_nvm_source_me.sh
28+
29+
# We need to source verification of NVM due to subshell issue mentioned above.
30+
source_robust "${DENDRON_MONOREPO:?}"/shell/_verify_nvm_source_me.sh
31+
32+
# There is an issue with node 17+ and `yarn setup` that causes an error.
33+
# Node 16 is the latest version that works with `yarn setup` with
34+
# current dendron setup.
35+
#
36+
# Another option to try is to use later node version with:
37+
# export NODE_OPTIONS=--openssl-legacy-provider
38+
#
39+
# However, it seems more robust to pick a node version that is known to work.
40+
# Hence, we are setting node version to 16.
41+
eae nvm install 16
42+
eae nvm use 16
43+
}
44+
45+
main_impl(){
46+
eae _setup_node_version
47+
48+
eae npm install -g yarn
49+
eae npm install -g lerna
50+
51+
eae cd "${DENDRON_MONOREPO:?}"
52+
53+
echo "install workspace dependencies..."
54+
eae yarn
55+
56+
echo "install package dependencies..."
57+
eae yarn setup
58+
}
59+
60+
main() {
61+
echo_green "Starting ${0}..."
62+
63+
eae "${DENDRON_MONOREPO:?}"/shell/_verify_env_variables.sh
64+
eae "${DENDRON_MONOREPO:?}"/shell/_verify_node_version.sh
65+
eae "${DENDRON_MONOREPO:?}"/shell/_verify_npm.sh
66+
eae "${DENDRON_MONOREPO:?}"/shell/_verify_yarn.sh
67+
68+
main_impl
69+
70+
echo "--------------------------------------------------------------------------------"
71+
echo_green "Finished ${0} successfully. For further documentation refer to https://docs.dendron.so/notes/64f0e2d5-2c83-43df-9144-40f2c68935aa/ . Particularly look for the part that talks about 'dendron-main.code-workspace' (And use File->Open Workspace from file... to open 'dendron/dendron-main.code-workspace'). Also look for './watch.sh' which wraps the watch command."
72+
}
73+
74+
main "${@}" || exit 1

‎watch.sh

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Related documentation here https://docs.dendron.so/notes/64f0e2d5-2c83-43df-9144-40f2c68935aa/
2+
main() {
3+
./bootstrap/scripts/watch.sh
4+
}
5+
6+
main "${@}" || exit 1

0 commit comments

Comments
 (0)