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

Npm: download the required binaries during installation #188

Merged
merged 17 commits into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from 4 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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ dist/
.rubygems/pkg/
.rubygems/libexec/
.npm/bin/
!.npm/bin/*.js
package.json
!.npm/package.json
node_modules/
yarn.lock
package-lock.json
6 changes: 3 additions & 3 deletions .npm/bin/index.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#!/usr/bin/env node

var spawn = require('child_process').spawn;
const { getExePath } = require('../get-exe');
const path = require("path")
const exePath = path.join(__dirname, `lefthook${["win32", "cygwin"].includes(process.platform) ? ".exe" : ""}`)
aminya marked this conversation as resolved.
Show resolved Hide resolved

var command_args = process.argv.slice(2);

var child = spawn(
getExePath(),
exePath,
command_args,
{ stdio: "inherit" });

Expand Down
36 changes: 0 additions & 36 deletions .npm/get-exe.js

This file was deleted.

3 changes: 3 additions & 0 deletions .npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,8 @@
],
"scripts": {
"postinstall": "node postinstall.js"
},
"dependencies": {
"node-downloader-helper": "^1.0.18"
}
}
71 changes: 65 additions & 6 deletions .npm/postinstall.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,69 @@
if (!process.env.CI) {
const { spawnSync } = require('child_process');
const { getExePath } = require('./get-exe');
const { spawnSync } = require("child_process")

async function install() {
if (process.env.CI) {
return
}
const exePath = await downloadBinary()
// run install
spawnSync(getExePath(), ['install', '-f'], {
spawnSync(exePath, ["install", "-f"], {
cwd: process.env.INIT_CWD || process.cwd,
stdio: 'inherit',
});
stdio: "inherit",
})
}

function getDownloadURL() {
// Detect OS
// https://nodejs.org/api/process.html#process_process_platform
let goOS = process.platform
let extension = ""
if (["win32", "cygwin"].includes(process.platform)) {
goOS = "windows"
extension = ".exe"
}

// Convert the goOS to the os name in the download URL
let downloadOS = goOS === "darwin" ? "macOS" : goOS
downloadOS = `${downloadOS.charAt(0).toUpperCase()}${downloadOS.slice(1)}`

// Detect architecture
// https://nodejs.org/api/process.html#process_process_arch
let arch = process.arch
switch (process.arch) {
case "x64": {
arch = "x86_64"
break
}
case "x32":
case "ia32": {
arch = "i386"
break
}
}
const version = require("./package.json").version

return `https://github.com/evilmartians/lefthook/releases/download/v${version}/lefthook_${version}_${downloadOS}_${arch}${extension}`
}

const { DownloaderHelper } = require("node-downloader-helper")
const path = require("path")

async function downloadBinary() {
// TODO zip the binaries to reduce the download size
aminya marked this conversation as resolved.
Show resolved Hide resolved
const downloadURL = getDownloadURL()
const extension = path.extname(downloadURL).slice(1)
const fileName = `lefthook.${extension}`
aminya marked this conversation as resolved.
Show resolved Hide resolved
const binDir = path.join(__dirname, "bin")
const dl = new DownloaderHelper(downloadURL, binDir, {
fileName,
retry: { maxRetries: 5, delay: 50 },
})
dl.on("end", () => console.log("lefthook binary was downloaded"))
Envek marked this conversation as resolved.
Show resolved Hide resolved
await dl.start()
return path.join(binDir, fileName)
aminya marked this conversation as resolved.
Show resolved Hide resolved
}

// start:
install().catch((e) => {
throw e
})
13 changes: 12 additions & 1 deletion cmd/templates.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"bytes"
"embed"
"text/template"
"runtime"

"github.com/spf13/afero"
)
Expand All @@ -14,6 +15,7 @@ var templatesFS embed.FS
type hookTmplData struct {
AutoInstall string
HookName string
Extension string
}

func hookTemplate(hookName string, fs afero.Fs) []byte {
Expand All @@ -22,6 +24,7 @@ func hookTemplate(hookName string, fs afero.Fs) []byte {
err := t.Execute(buf, hookTmplData{
AutoInstall: autoInstall(hookName, fs),
HookName: hookName,
Extension: getExtension(),
})
check(err)

Expand All @@ -40,5 +43,13 @@ func autoInstall(hookName string, fs afero.Fs) string {
return ""
}

return "# lefthook_version: " + configChecksum(fs) + "\n\ncall_lefthook \"lefthook install\""
return "# lefthook_version: " + configChecksum(fs) + "\n\ncall_lefthook \"install\""
}

func getExtension() string {
if (runtime.GOOS == "windows") {
return ".exe"
} else {
return ""
}
}
14 changes: 7 additions & 7 deletions cmd/templates/hook.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ call_lefthook()
{
if lefthook -h >/dev/null 2>&1
then
eval $1
elif test -f "$dir/node_modules/@arkweid/lefthook/bin/lefthook"
eval lefthook $1
aminya marked this conversation as resolved.
Show resolved Hide resolved
elif test -f "$dir/node_modules/@arkweid/lefthook/bin/lefthook{{.Extension}}"
then
eval $dir/node_modules/@arkweid/lefthook/bin/$1
eval "$dir/node_modules/@arkweid/lefthook/bin/lefthook{{.Extension}} $1"
elif bundle exec lefthook -h >/dev/null 2>&1
then
bundle exec $1
bundle exec lefthook $1
elif npx lefthook -h >/dev/null 2>&1
then
npx $1
npx lefthook $1
elif yarn lefthook -h >/dev/null 2>&1
then
yarn $1
yarn lefthook $1
else
echo "Can't find lefthook in PATH"
fi
}

{{.AutoInstall}}

call_lefthook "lefthook run {{.HookName}} $@"
call_lefthook "run {{.HookName}} $@"
12 changes: 6 additions & 6 deletions spec/fixtures/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ call_lefthook()
{
if lefthook -h >/dev/null 2>&1
then
eval $1
eval lefthook $1
elif test -f "$dir/node_modules/@arkweid/lefthook/bin/lefthook"
then
eval $dir/node_modules/@arkweid/lefthook/bin/$1
eval "$dir/node_modules/@arkweid/lefthook/bin/lefthook $1"
elif bundle exec lefthook -h >/dev/null 2>&1
then
bundle exec $1
bundle exec lefthook $1
elif npx lefthook -h >/dev/null 2>&1
then
npx $1
npx lefthook $1
elif yarn lefthook -h >/dev/null 2>&1
then
yarn $1
yarn lefthook $1
else
echo "Can't find lefthook in PATH"
fi
}



call_lefthook "lefthook run pre-commit $@"
call_lefthook "run pre-commit $@"
12 changes: 6 additions & 6 deletions spec/fixtures/pre-push
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@ call_lefthook()
{
if lefthook -h >/dev/null 2>&1
then
eval $1
eval lefthook $1
elif test -f "$dir/node_modules/@arkweid/lefthook/bin/lefthook"
then
eval $dir/node_modules/@arkweid/lefthook/bin/$1
eval "$dir/node_modules/@arkweid/lefthook/bin/lefthook $1"
elif bundle exec lefthook -h >/dev/null 2>&1
then
bundle exec $1
bundle exec lefthook $1
elif npx lefthook -h >/dev/null 2>&1
then
npx $1
npx lefthook $1
elif yarn lefthook -h >/dev/null 2>&1
then
yarn $1
yarn lefthook $1
else
echo "Can't find lefthook in PATH"
fi
}



call_lefthook "lefthook run pre-push $@"
call_lefthook "run pre-push $@"