hugo-bin-extended 0.100.2 → 0.104.3

package/README.md

@@ -8,13 +8,15 @@
 npm install hugo-bin-extended --save-dev
 ```
 
+For usage within corporate networks or behind corporate proxies, the download repository can be overwritten, see [Installation options](#installation-options) for more details.
+
 ## Usage
 
 ### API
 
 ```js
 import { execFile } from 'node:child_process';
-import hugo from 'hugo-bin';
+import hugo from 'hugo-bin-extended';
 
 execFile(hugo, ['version'], (error, stdout) => {
   if (error) {
@@ -54,6 +56,48 @@ npm run create -- post/my-new-post.md
 
 See the [Hugo Documentation](https://gohugo.io/) for more information.
 
+## Installation options
+
+hugo-bin-extended supports options to change the variation of Hugo binaries and to overwrite the download repository.
+
+Each option can be configured in the `hugo-bin-extended` section of your `package.json`:
+
+```json
+{
+  "name": "your-package",
+  "version": "0.0.1",
+  "hugo-bin-extended": {
+    "downloadRepo" : "https://some.example.com/artifactory/github-releases"
+  }
+}
+```
+
+Also as local or global [.npmrc](https://docs.npmjs.com/files/npmrc) configuration file:
+
+```ini
+hugo_bin_extended_download_repo = "https://some.example.com/artifactory/github-releases"
+```
+
+Also as an environment variable:
+
+```sh
+export HUGO_BIN_EXTENDED_DOWNLOAD_REPO="https://some.example.com/artifactory/github-releases"
+```
+
+**Note that you have to run `npm install hugo-bin-extended` to re-install hugo-bin-extended itself, if you change any of these options.**
+
+### Options
+
+#### downloadRepo
+
+Default: `"https://github.com"`
+
+Set it to your corporate proxy url to download the hugo binary from a different download repository.
+
+## Supported versions
+
+See [the package.json commit history](MarlonLuan/hugo-bin-extended/commits/main/package.json).
+
 ## Super Inspired By
 
 - [mastilver/apex-bin](https://github.com/mastilver/apex-bin)

package/lib/index.js

@@ -3,33 +3,36 @@ import path from 'node:path';
 import process from 'node:process';
 import { fileURLToPath } from 'node:url';
 import BinWrapper from 'bin-wrapper';
+import { packageConfigSync } from 'pkg-conf';
 
 const { hugoVersion } = JSON.parse(fs.readFileSync(new URL('../package.json', import.meta.url)));
 
-const baseUrl = `https://github.com/gohugoio/hugo/releases/download/v${hugoVersion}/`;
 const destDir = path.join(fileURLToPath(new URL('../vendor', import.meta.url)));
 const binName = process.platform === 'win32' ? 'hugo.exe' : 'hugo';
 
-const extendedBin = new BinWrapper()
-  .src(`${baseUrl}hugo_extended_${hugoVersion}_Linux-64bit.tar.gz`, 'linux', 'x64')
-  .src(`${baseUrl}hugo_extended_${hugoVersion}_macOS-64bit.tar.gz`, 'darwin', 'x64')
-  .src(`${baseUrl}hugo_extended_${hugoVersion}_macOS-ARM64.tar.gz`, 'darwin', 'arm64')
-  .src(`${baseUrl}hugo_extended_${hugoVersion}_Windows-64bit.zip`, 'win32', 'x64')
+const extendedBin = (baseDownloadUrl) => new BinWrapper()
+  .src(`${baseDownloadUrl}hugo_extended_${hugoVersion}_darwin-universal.tar.gz`, 'darwin', 'arm64')
+  .src(`${baseDownloadUrl}hugo_extended_${hugoVersion}_darwin-universal.tar.gz`, 'darwin', 'x64')
+  .src(`${baseDownloadUrl}hugo_extended_${hugoVersion}_linux-amd64.tar.gz`, 'linux', 'x64')
+  .src(`${baseDownloadUrl}hugo_extended_${hugoVersion}_linux-arm64.tar.gz`, 'linux', 'arm64')
+  .src(`${baseDownloadUrl}hugo_extended_${hugoVersion}_windows-amd64.zip`, 'win32', 'x64')
   // Fall back to the normal version on unsupported platforms
-  .src(`${baseUrl}hugo_${hugoVersion}_FreeBSD-64bit.tar.gz`, 'freebsd', 'x64')
-  .src(`${baseUrl}hugo_${hugoVersion}_Linux-32bit.tar.gz`, 'linux', 'x86')
-  .src(`${baseUrl}hugo_${hugoVersion}_Linux-ARM.tar.gz`, 'linux', 'arm')
-  .src(`${baseUrl}hugo_${hugoVersion}_Linux-ARM64.tar.gz`, 'linux', 'arm64')
-  .src(`${baseUrl}hugo_${hugoVersion}_NetBSD-64bit.tar.gz`, 'netbsd', 'x64')
-  .src(`${baseUrl}hugo_${hugoVersion}_OpenBSD-64bit.tar.gz`, 'openbsd', 'x64')
-  .src(`${baseUrl}hugo_${hugoVersion}_Windows-32bit.zip`, 'win32', 'x86')
-  .src(`${baseUrl}hugo_${hugoVersion}_Windows-ARM.zip`, 'win32', 'arm')
-  .src(`${baseUrl}hugo_${hugoVersion}_Windows-ARM64.zip`, 'win32', 'arm64')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_dragonfly-amd64.tar.gz`, 'dragonflybsd', 'x64')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_freebsd-amd64.tar.gz`, 'freebsd', 'x64')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_linux-arm.tar.gz`, 'linux', 'arm')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_netbsd-amd64.tar.gz`, 'netbsd', 'x64')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_openbsd-amd64.tar.gz`, 'openbsd', 'x64')
+  .src(`${baseDownloadUrl}hugo_${hugoVersion}_windows-arm64.zip`, 'win32', 'arm64')
   .dest(destDir)
   .use(binName);
 
-function main() {
-  return extendedBin
+function main(projectRoot) {
+  const config = packageConfigSync('hugo-bin-extended', { cwd: projectRoot });
+  const downloadRepo = (process.env.HUGO_BIN_EXTENDED_DOWNLOAD_REPO || process.env.npm_config_hugo_bin_extended_download_repo || config.downloadRepo || 'https://github.com');
+
+  const baseDownloadUrl = `${downloadRepo}/gohugoio/hugo/releases/download/v${hugoVersion}/`;
+
+  return extendedBin(baseDownloadUrl);
 }
 
 export default main;

package/lib/install.js

@@ -15,7 +15,7 @@ function getProjectRoot() {
   const cwd = process.cwd();
   const paths = cwd.split(path.sep);
   // If `process.cwd` ends with 'node_modules/*' then get the dependent root directory,
-  // otherwise return the `cwd` (ordinary it will be the postinstall process of hugo-bin itself).
+  // otherwise return the `cwd` (ordinary it will be the postinstall process of hugo-bin-extended itself).
   if (paths.length > 1 && paths[paths.length - 2] === 'node_modules') {
     return path.resolve('../../', cwd);
   }
@@ -25,8 +25,8 @@ function getProjectRoot() {
 
 bin(getProjectRoot()).run(['version'])
   .then(() => {
-    console.log(picocolors.green('Hugo binary successfully installed!'));
+    console.log(picocolors.green('Hugo binary extended successfully installed!'));
   })
   .catch(error => {
-    console.error(picocolors.red(`${error.message}\nHugo binary installation failed!`));
+    console.error(picocolors.red(`${error.message}\nHugo binary extended installation failed!`));
   });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hugo-bin-extended",
-  "version": "0.100.2",
-  "hugoVersion": "0.100.2",
+  "version": "0.104.3",
+  "hugoVersion": "0.104.3",
   "description": "Binary wrapper for Hugo Extended",
   "repository": {
     "type": "git",
@@ -26,8 +26,8 @@
   },
   "devDependencies": {
     "bin-check": "^4.1.0",
-    "eslint": "^8.16.0",
-    "uvu": "^0.5.3"
+    "eslint": "^8.24.0",
+    "uvu": "^0.5.6"
   },
   "scripts": {
     "lint": "eslint .",