Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better dependency checks #27

Merged
merged 1 commit into from
Sep 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
template-suffix: ejs
dependencies:
- node
- npm
- extism-js

available-feature-flags:
- name: stub-with-code-samples
Expand Down
86 changes: 86 additions & 0 deletions template/prepare.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
#!/bin/bash

# Function to check if a command exists
command_exists () {
command -v "$1" >/dev/null 2>&1
}

missing_deps=0

# Check for Node.js
if ! (command_exists node || command_exists nodejs); then
missing_deps=1
echo "❌ Node.js is not installed."
echo ""
echo "To install Node.js, visit the official download page:"
echo "👉 https://nodejs.org/en/download/"
echo ""
echo "Or install it using a package manager:"
echo ""
echo "🔹 macOS (Homebrew):"
echo " brew install node"
echo ""
echo "🔹 Ubuntu/Debian:"
echo " curl -fsSL https://deb.nodesource.com/setup_current.x | sudo -E bash -"
echo " sudo apt-get install -y nodejs"
echo ""
echo "🔹 CentOS/RHEL:"
echo " curl -fsSL https://rpm.nodesource.com/setup_current.x | sudo bash -"
echo " sudo yum install -y nodejs"
echo ""
echo "🔹 Arch Linux:"
echo " sudo pacman -S nodejs"
echo ""
fi

# Check for npm
if ! command_exists npm; then
missing_deps=1
echo "❌ npm is not installed."
echo ""
echo "npm typically comes with Node.js. Please install Node.js to get npm."
echo ""
echo "Alternatively, install npm using a package manager:"
echo ""
echo "🔹 macOS (Homebrew):"
echo " brew install npm"
echo ""
echo "🔹 Ubuntu/Debian:"
echo " sudo apt-get install npm"
echo ""
echo "🔹 CentOS/RHEL:"
echo " sudo yum install npm"
echo ""
echo "🔹 Arch Linux:"
echo " sudo pacman -S npm"
echo ""
fi

# Exit with a bad exit code if any dependencies are missing
if [ "$missing_deps" -ne 0 ]; then
echo "Install the missing dependencies and ensure they are on your path. Then run this command again."
# TODO: remove sleep when cli bug is fixed
sleep 2
exit 1
fi

# Check for extism-js
if ! command_exists extism-js; then
echo "❌ extism-js is not installed."
echo ""
echo "extism-js is needed to compile the plug-in. You can find the instructions to install it here: https://github.com/extism/js-pdk"
echo ""
echo "Alternatively, you can use an install script."
echo ""
echo "🔹 Mac / Linux:"
echo "curl -L https://raw.githubusercontent.com/extism/js-pdk/main/install.sh | bash"
echo ""
echo "🔹 Windows:"
echo "powershell Invoke-WebRequest -Uri https://raw.githubusercontent.com/extism/js-pdk/main/install-windows.ps1 -OutFile install-windows.ps1"
echo "powershell -executionpolicy bypass -File .\install-windows.ps1"
echo ""
# TODO: remove sleep when cli bug is fixed
sleep 2
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will remove after CLI is fixed

exit 1
fi

4 changes: 2 additions & 2 deletions template/xtp.toml.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ name = "<%- project.name %>"

[scripts]
# xtp plugin build runs this script to generate the wasm file
build = "npm run build"
build = "sh prepare.sh && npm run build"

# xtp plugin init runs this script to format the code
format = "npm run format"

# xtp plugin init runs this script before running the format script
prepare = "npm install"
prepare = "sh prepare.sh && npm install"
Loading