向 Deno 学习脚本的管理

洛竹 28 0 0

前言 🌱

如果你使用过 Deno、Go 或者配置过 Android Studio,那么你一定对配置环境变量不陌生。那么如果我们自己写了一个脚本或者命令行工具,如何分享给朋友们玩呢?最简单的当然是直接把脚本放出去,供别人手动下载和手动配置环境变量。但这既不优雅,也不利于传播,本文就是研读了 Deno 的安装机制后,总结出的一套可用的二进制可执行文件分发教程。

Deno 在 v1.7.0 支持了 交叉编译,本文就以 Deno 实现一个简单的 CLI 工具 并分发给 MacOS、Linux、Windows 用户。

Deno 安装方式分析

从官网中,我们可以看到 Deno 有多种安装方式,主要有:

  • With Shell(Linux/MacOS):curl -fsSL https://deno.land/x/install/install.sh | sh
  • With PowerShell(Windows):iwr https://deno.land/x/install/install.ps1 -useb | iex
  • With Homebrew:brew install deno

并且还可以安装特定版本:

  • With Shell: curl -fsSL https://deno.land/x/install/install.sh | sh -s v1.0.0
  • With PowerShell: $v="1.0.0"; iwr https://deno.land/x/install/install.ps1 -useb | iex

其中 Homebrew 方式需要将安装脚本合并到 homebrew-core,但是我们的脚本一般比较小众,可以参考 不会吧?不会吧!还有人不会发 Homebrew 包? 发布到自己的 tap 中。对于 Shell 和 PowerShell 是我们本文要研究的。

准备一个项目

我这边已经准备好了一个简单的 Deno 项目 youngjuning/seve。如果你对 Deno 开发感兴趣,可以阅读 Deno 从入门到跑路 | 🏆 技术专题第一期征文 入门。

编译项目

我们可以使用 deno compile --unstable --target=<target> 命令把我们的项目编译成二进制可执行文件,可选的 target 有:

  • x86_64-unknown-linux-gnu
  • x86_64-pc-windows-msvc
  • x86_64-apple-darwin
  • aarch64-apple-darwin

我们编写一个 compile.sh 来批量编译出各个平台的产物(记得执行 chmod +x 755 compile.sh 赋予脚本可执行权限)。

#!/bin/bash
name="seve"
deno compile --unstable --lite --target=x86_64-unknown-linux-gnu index.ts
zip -o -q -m ${name}-x86_64-unknown-linux-gnu.zip ${name}

deno compile --unstable --lite --target=x86_64-pc-windows-msvc -o ./${name}.exe index.ts
zip -o -q -m ${name}-x86_64-pc-windows-msvc.zip ${name}.exe

deno compile --unstable --lite --target=x86_64-apple-darwin index.ts
zip -o -q -m ${name}-x86_64-apple-darwin.zip ${name}

deno compile --unstable --lite --target=aarch64-apple-darwin index.ts
zip -o -q -m ${name}-aarch64-apple-darwin.zip ${name}

以上脚本会生成以下文件,我们不需要把它们上传到代码库中,所以请在 .gitignore 中忽略它们。

Windows 安装脚本

首先我们来看下 deno_install 中的脚本 install.ps1

#!/usr/bin/env pwsh
# Copyright 2018 the Deno authors. All rights reserved. MIT license.
# TODO(everyone): Keep this script simple and easily auditable.

$ErrorActionPreference = 'Stop'

if ($v) {
  $Version = "v${v}"
}
if ($args.Length -eq 1) {
  $Version = $args.Get(0)
}

$DenoInstall = $env:DENO_INSTALL
$BinDir = if ($DenoInstall) {
  "$DenoInstall\bin"
} else {
  "$Home\.deno\bin"
}

$DenoZip = "$BinDir\deno.zip"
$DenoExe = "$BinDir\deno.exe"
$Target = 'x86_64-pc-windows-msvc'

# GitHub requires TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

$DenoUri = if (!$Version) {
  "https://github.com/denoland/deno/releases/latest/download/deno-${Target}.zip"
} else {
  "https://github.com/denoland/deno/releases/download/${Version}/deno-${Target}.zip"
}

if (!(Test-Path $BinDir)) {
  New-Item $BinDir -ItemType Directory | Out-Null
}

Invoke-WebRequest $DenoUri -OutFile $DenoZip -UseBasicParsing

if (Get-Command Expand-Archive -ErrorAction SilentlyContinue) {
  Expand-Archive $DenoZip -Destination $BinDir -Force
} else {
  if (Test-Path $DenoExe) {
    Remove-Item $DenoExe
  }
  Add-Type -AssemblyName System.IO.Compression.FileSystem
  [IO.Compression.ZipFile]::ExtractToDirectory($DenoZip, $BinDir)
}

Remove-Item $DenoZip

$User = [EnvironmentVariableTarget]::User
$Path = [Environment]::GetEnvironmentVariable('Path', $User)
if (!(";$Path;".ToLower() -like "*;$BinDir;*".ToLower())) {
  [Environment]::SetEnvironmentVariable('Path', "$Path;$BinDir", $User)
  $Env:Path += ";$BinDir"
}

Write-Output "Deno was installed successfully to $DenoExe"
Write-Output "Run 'deno --help' to get started"

这是 powershell 文件,这里不做过多语法解释,我们看其中的核心代码:

...
$Target = 'x86_64-pc-windows-msvc'
...
$DenoUri = if (!$Version) {
  "https://github.com/denoland/deno/releases/latest/download/deno-${Target}.zip"
} else {
  "https://github.com/denoland/deno/releases/download/${Version}/deno-${Target}.zip"
}

从这个可以看出,deno 的安装包是以 zip 的形式存在 GitHub Release 的,并且依托 Tag 实现了版本管理。下图便是 Deno 1.7.1 release 的附件:

Deno 从构建到发布这些步骤全都是 GitHub Action 自动实现的,感兴趣的我可以再写一篇解析 Deno 的自动化流程。

自定义安装脚本

1、手动新建一个 Release 并把上面编译出来的压缩包以附件的形式上传:

2、将上面的脚本中的命名改成我们自己的脚本:

如果你有 cdn 可以把它上传到 cdn 上,我这里就上传到 github 上了。

#!/usr/bin/env pwsh
# Copyright 2018 the Seve authors. All rights reserved. MIT license.
# TODO(everyone): Keep this script simple and easily auditable.

$ErrorActionPreference = 'Stop'

if ($v) {
  $Version = "v${v}"
}
if ($args.Length -eq 1) {
  $Version = $args.Get(0)
}

$SeveInstall = $env:SEVE_INSTALL
$BinDir = if ($SeveInstall) {
  "$SeveInstall\bin"
}
else {
  "$Home\.seve\bin"
}

$SeveZip = "$BinDir\seve.zip"
$SeveExe = "$BinDir\seve.exe"
$Target = 'x86_64-pc-windows-msvc'

# GitHub requires TLS 1.2
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

$DenoUri = if (!$Version) {
  "https://github.com/youngjuning/seve/releases/latest/download/seve-${Target}.zip"
}
else {
  "https://github.com/youngjuning/seve/releases/download/${Version}/seve-${Target}.zip"
}

if (!(Test-Path $BinDir)) {
  New-Item $BinDir -ItemType Directory | Out-Null
}

Invoke-WebRequest $DenoUri -OutFile $SeveZip -UseBasicParsing

if (Get-Command Expand-Archive -ErrorAction SilentlyContinue) {
  Expand-Archive $SeveZip -Destination $BinDir -Force
}
else {
  if (Test-Path $SeveExe) {
    Remove-Item $SeveExe
  }
  Add-Type -AssemblyName System.IO.Compression.FileSystem
  [IO.Compression.ZipFile]::ExtractToDirectory($SeveZip, $BinDir)
}

Remove-Item $SeveZip

$User = [EnvironmentVariableTarget]::User
$Path = [Environment]::GetEnvironmentVariable('Path', $User)
if (!(";$Path;".ToLower() -like "*;$BinDir;*".ToLower())) {
  [Environment]::SetEnvironmentVariable('Path', "$Path;$BinDir", $User)
  $Env:Path += ";$BinDir"
}

Write-Output "Seve was installed successfully to $SeveExe"
Write-Output "Run 'seve --help' to get started"

3、安装脚本

# 安装最新版
iwr https://youngjuning.js.org/seve/install.ps1 -useb | iex
# 安装指定版本
$v="1.0.0"; iwr https://deno.land/x/install/install.ps1 -useb | iex

类 Unix 安装脚本

首先我们来看下 deno_install 中的脚本 install.sh

#!/bin/sh
# Copyright 2019 the Deno authors. All rights reserved. MIT license.
# TODO(everyone): Keep this script simple and easily auditable.

set -e

if ! command -v unzip >/dev/null; then
    echo "Error: unzip is required to install Deno (see: https://github.com/denoland/deno_install#unzip-is-required)." 1>&2
    exit 1
fi

if [ "$OS" = "Windows_NT" ]; then
    target="x86_64-pc-windows-msvc"
else
    case $(uname -sm) in
    "Darwin x86_64") target="x86_64-apple-darwin" ;;
    "Darwin arm64") target="aarch64-apple-darwin" ;;
    *) target="x86_64-unknown-linux-gnu" ;;
    esac
fi

if [ $# -eq 0 ]; then
    deno_uri="https://github.com/denoland/deno/releases/latest/download/deno-${target}.zip"
else
    deno_uri="https://github.com/denoland/deno/releases/download/${1}/deno-${target}.zip"
fi

deno_install="${DENO_INSTALL:-$HOME/.deno}"
bin_dir="$deno_install/bin"
exe="$bin_dir/deno"

if [ ! -d "$bin_dir" ]; then
    mkdir -p "$bin_dir"
fi

curl --fail --location --progress-bar --output "$exe.zip" "$deno_uri"
unzip -d "$bin_dir" -o "$exe.zip"
chmod +x "$exe"
rm "$exe.zip"

echo "Deno was installed successfully to $exe"
if command -v deno >/dev/null; then
    echo "Run 'deno --help' to get started"
else
    case $SHELL in
    /bin/zsh) shell_profile=".zshrc" ;;
    *) shell_profile=".bash_profile" ;;
    esac
    echo "Manually add the directory to your \$HOME/$shell_profile (or similar)"
    echo "  export DENO_INSTALL=\"$deno_install\""
    echo "  export PATH=\"\$DENO_INSTALL/bin:\$PATH\""
    echo "Run '$exe --help' to get started"
fi

上面的安装脚本就是我们熟悉的 Shell 脚本了,核心代码:

if [ "$OS" = "Windows_NT" ]; then
    target="x86_64-pc-windows-msvc"
else
    case $(uname -sm) in
    "Darwin x86_64") target="x86_64-apple-darwin" ;;
    "Darwin arm64") target="aarch64-apple-darwin" ;;
    *) target="x86_64-unknown-linux-gnu" ;;
    esac
fi

可以看出 $(uname -sm) 表示系统架构,根据它脚本可以动态决定安装哪个平台的脚本。

自定义脚本

发布 Release 和上传附件前面说过你了,这里不多赘述了。

1、将上面的脚本中的命名改成我们自己的脚本并上传到合适的地方:

这里我们加入了自动设置环境变量的功能。PS:Deno 作者为了保持脚本的简洁拒绝了我的 PR。

#!/bin/sh
# Copyright 2021 the Seve authors. All rights reserved. MIT license.
# TODO(everyone): Keep this script simple and easily auditable.

set -e

if ! command -v unzip >/dev/null; then
    echo "Error: unzip is required to install Seve (see: https://github.com/youngjuning/seve#unzip-is-required)." 1>&2
    exit 1
fi

if [ "$OS" = "Windows_NT" ]; then
    target="x86_64-pc-windows-msvc"
else
    case $(uname -sm) in
    "Darwin x86_64") target="x86_64-apple-darwin" ;;
    "Darwin arm64") target="aarch64-apple-darwin" ;;
    *) target="x86_64-unknown-linux-gnu" ;;
    esac
fi

if [ $# -eq 0 ]; then
    seve_uri="https://github.com/youngjuning/seve/releases/latest/download/seve-${target}.zip"
else
    seve_uri="https://github.com/youngjuning/seve/releases/download/${1}/seve-${target}.zip"
fi

seve_install="${SEVE_INSTALL:-$HOME/.seve}"
bin_dir="$seve_install/bin"
exe="$bin_dir/seve"

if [ ! -d "$bin_dir" ]; then
    mkdir -p "$bin_dir"
fi

curl --fail --location --progress-bar --output "$exe.zip" "$seve_uri"
unzip -d "$bin_dir" -o "$exe.zip"
chmod +x "$exe"
rm "$exe.zip"

echo "Seve was installed successfully to $exe"
if command -v seve >/dev/null; then
    echo "Run 'seve --help' to get started"
else
    case $SHELL in
    /bin/zsh) shell_profile=".zshrc" ;;
    *) shell_profile=".bash_profile" ;;
    esac
    echo "# Seve" >> $HOME/$shell_profile
    echo "export SEVE_INSTALL=\"$seve_install\"" >> $HOME/$shell_profile
    echo "export PATH=\"\$SEVE_INSTALL/bin:\$PATH\"" >> $HOME/$shell_profile
    source $HOME/$shell_profile
    echo "Run 'seve' to get started"
fi

2、安装脚本

# 安装最新版
curl -fsSL https://youngjuning.js.org/seve/install.sh | sh
# 安装指定版本
curl -fsSL https://youngjuning.js.org/seve/install.sh | sh -s v0.0.1

至此我们就实现了我们自己的脚本管理,示例代码在 youngjuning/seve,如有帮助,欢迎 Star。

国内加速

这又是另一段故事了,我们可以仿照 justjavac 大佬在 justjavac/deno_releases 中做的那样仿照一份。和原脚本不一样的地方在于是基于 jsdelivr 做了 CDN 加速。

由于 jsdeliver 有 20M 的限制,我在 coding 上开了个仓库,可以使用 https://youngjuning.js.org/deno/install.shhttps://youngjuning.js.org/deno/install.ps1 脚本来安装。感谢评论区大佬提醒。使用方式和 deno 一致,替换链接即可。

预告

  • Powershell 编程基础
  • Deno GitHub Action 自动化流程解析
  • Deno CLI 开发入门

预览图
收藏
评论区
守株待兔
最新文章
发布一个 Homebrew 包 2021-03-25 02:34
我的 Mac 开发环境 2021-03-25 02:32

导读