hugo-extended 0.88.0 → 0.88.1-patch1

package/README.md

@@ -14,17 +14,25 @@ yarn add hugo-extended --dev
 
 This package's version numbers align with Hugo's — `hugo-extended@0.64.1` installs Hugo v0.64.1, for example.
 
+_Note:_ If you'll be using the SCSS features of Hugo Extended, it's probably smart to install [`postcss`](https://www.npmjs.com/package/postcss), [`postcss-cli`](https://www.npmjs.com/package/postcss-cli), and [`autoprefixer`](https://www.npmjs.com/package/autoprefixer) as devDependencies too, since they can be conveniently called via [built-in Hugo pipes](https://gohugo.io/hugo-pipes/postcss/):
+
+```sh
+npm install postcss postcss-cli autoprefixer --save-dev
+# or...
+yarn add postcss postcss-cli autoprefixer --dev
+```
+
 ## Usage
 
 The following examples simply refer to downloading and executing Hugo as a Node dependency. See the [official Hugo docs](https://gohugo.io/documentation/) for guidance on actual Hugo usage.
 
 ### via CLI / `package.json`:
 
-If you'll be using the SCSS features of Hugo Extended, it's probably smart to install [`postcss`](https://www.npmjs.com/package/postcss), [`postcss-cli`](https://www.npmjs.com/package/postcss-cli), and [`autoprefixer`](https://www.npmjs.com/package/autoprefixer) as devDependencies too, since they can be called via [built-in Hugo pipes](https://gohugo.io/hugo-pipes/postcss/).
-
-The `build:preview` script below is designed for [Netlify deploy previews](https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/), where [`$DEPLOY_PRIME_URL`](https://docs.netlify.com/configure-builds/environment-variables/#deploy-urls-and-metadata) is substituted for the base URL (usually ending in netlify.app) of each commit or pull request.
+The `build:preview` script below is designed for [Netlify deploy previews](https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/), where [`$DEPLOY_PRIME_URL`](https://docs.netlify.com/configure-builds/environment-variables/#deploy-urls-and-metadata) is substituted for the base URL (usually ending in .netlify.app) of each pull request, branch, or commit preview.
 
 ```jsonc
+// package.json:
+
 {
   // ...
   "scripts": {
@@ -33,9 +41,9 @@ The `build:preview` script below is designed for [Netlify deploy previews](https
     "start": "hugo server"
   },
   "devDependencies": {
-    "autoprefixer": "^10.2.5",
-    "hugo-extended": "^0.83.1",
-    "postcss": "^8.2.9",
+    "autoprefixer": "^10.3.4",
+    "hugo-extended": "^0.88.1",
+    "postcss": "^8.3.6",
     "postcss-cli": "^8.3.1"
   }
   // ...
@@ -45,7 +53,8 @@ The `build:preview` script below is designed for [Netlify deploy previews](https
 ```bash
 $ npm run start
 
-Building sites …
+Start building sites …
+hugo v0.88.1-5BC54738+extended darwin/amd64 BuildDate=2021-09-04T09:39:19Z VendorInfo=gohugoio
 
                    | EN
 -------------------+------
@@ -59,6 +68,9 @@ Building sites …
   Cleaned          |   0
 
 Built in 2361 ms
+Watching for changes in {archetypes,assets,content,data,layouts,package.json,static}
+Watching for config changes in config.toml
+Environment: "development"
 Serving pages from memory
 Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
 ```
@@ -66,6 +78,8 @@ Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
 ### via API:
 
 ```js
+// version.js:
+
 import hugo from "hugo-extended";
 import { execFile } from "child_process";
 
@@ -74,12 +88,15 @@ execFile(hugo, ["version"], (error, stdout) => {
 });
 ```
 
+```bash
+$ node version.js
+hugo v0.88.1-5BC54738+extended darwin/amd64 BuildDate=2021-09-04T09:39:19Z VendorInfo=gohugoio
+```
+
 ## Examples
 
 - [jakejarvis/jarv.is](https://github.com/jakejarvis/jarv.is)
 
 ## License
 
-Forked from [fenneclab/hugo-bin](https://github.com/fenneclab/hugo-bin) under the [MIT License](https://github.com/fenneclab/hugo-bin/blob/master/LICENSE), (c) [Shun Sato](http://blog.fenneclab.com/).
-
-Hugo is distributed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).
+This project is distributed under the [MIT License](LICENSE.md). Hugo is distributed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).

package/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+
+/**
+ * @returns {string} Absolute path to the Hugo executable (`hugo.exe` on
+ * Windows, simply `hugo` otherwise).
+ */
+declare const hugo: string;
+export = hugo;

package/index.js

@@ -1,5 +1,6 @@
 import path from "path";
 import { fileURLToPath } from "url";
+import { getBinFilename } from "./lib/utils.js";
 
 // https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#what-do-i-use-instead-of-__dirname-and-__filename
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -7,7 +8,8 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const hugo = path.join(
   __dirname,
   "vendor",
-  process.platform === "win32" ? "hugo.exe" : "hugo",
+  getBinFilename(),
 );
 
+// The only thing this module really exports is the absolute path to Hugo:
 export default hugo;

package/lib/cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import { spawn } from "child_process";
+import hugo from "../index.js";
+
+const args = process.argv.slice(2);
+
+spawn(hugo, args, { stdio: "inherit" })
+  .on("exit", (code) => {
+    // forward Hugo's exit code so this module itself reports success/failure
+    process.exit(code);
+  });

package/lib/install.js

@@ -0,0 +1,66 @@
+import path from "path";
+import fs from "fs";
+import downloader from "careful-downloader";
+import logSymbols from "log-symbols";
+import {
+  getPkgVersion,
+  getReleaseUrl,
+  getReleaseFilename,
+  getBinFilename,
+  getBinVersion,
+  getChecksumFilename,
+  isExtended,
+} from "./utils.js";
+
+installHugo()
+  .then((bin) =>
+    // try querying hugo's version via CLI
+    getBinVersion(bin),
+  )
+  .then((version) => {
+    // print output of `hugo version` to console
+    console.log(`${logSymbols.success} Hugo installed successfully!`);
+    console.log(version);
+  })
+  .catch((error) => {
+    // pass whatever error occured along the way to console
+    console.error(`${logSymbols.error} Hugo installation failed. :(`);
+    throw error;
+  });
+
+async function installHugo() {
+  const version = getPkgVersion();
+  const releaseFile = getReleaseFilename(version);
+  const checksumFile = getChecksumFilename(version);
+  const binFile = getBinFilename();
+
+  // stop here if there's nothing we can download
+  if (!releaseFile) {
+    throw new Error(`Are you sure this platform is supported? See: https://github.com/gohugoio/hugo/releases/tag/v${version}`);
+  }
+
+  // warn if platform doesn't support Hugo Extended, proceed with vanilla Hugo
+  if (!isExtended(releaseFile)) {
+    console.warn(`${logSymbols.info} Hugo Extended isn't supported on this platform, downloading vanilla Hugo instead.`);
+  }
+
+  // download release from GitHub and verify its checksum
+  const download = await downloader(
+    getReleaseUrl(version, releaseFile),
+    getReleaseUrl(version, checksumFile),
+    {
+      filename: releaseFile,
+      destDir: "vendor",
+      cleanDestDir: false,
+      algorithm: "sha256",
+      encoding: "binary",
+      extract: true,
+    },
+  );
+
+  // ensure hugo[.exe] is executable
+  fs.chmodSync(path.join(download, binFile), 0o755);
+
+  // return the full path to our Hugo binary
+  return path.join(download, binFile);
+}

package/lib/utils.js

@@ -0,0 +1,94 @@
+import { execFileSync } from "child_process";
+import { readPackageUpSync } from "read-pkg-up";
+
+// This package's version number (should) always match the Hugo release we want.
+// We check for a `hugoVersion` field in package.json just in case it doesn't
+// match in the future (from pushing an emergency package update, etc.).
+export function getPkgVersion() {
+  const { packageJson } = readPackageUpSync();
+  return packageJson.hugoVersion || packageJson.version;
+}
+
+// Generate the full GitHub URL to a given release file.
+export function getReleaseUrl(version, filename) {
+  return `https://github.com/gohugoio/hugo/releases/download/v${version}/${filename}`;
+}
+
+// Binary is named `hugo.exe` on Windows, and simply `hugo` otherwise.
+export function getBinFilename() {
+  return process.platform === "win32" ? "hugo.exe" : "hugo";
+}
+
+// Returns the output of the `hugo version` command, i.e.:
+//   "hugo v0.88.1-5BC54738+extended darwin/arm64 BuildDate=..."
+export function getBinVersion(bin) {
+  const stdout = execFileSync(bin, ["version"]);
+  return stdout.toString();
+}
+
+// Hugo Extended supports: macOS x64, macOS ARM64, Linux x64, Windows x64.
+// all other combos fall back to vanilla Hugo. There are surely much better ways
+// to do this but this is easy to read/update. :)
+export function getReleaseFilename(version) {
+  const { platform, arch } = process;
+
+  const filename =
+    // macOS
+    platform === "darwin" && arch === "x64" ?
+      `hugo_extended_${version}_macOS-64bit.tar.gz` :
+    platform === "darwin" && arch === "arm64" ?
+      `hugo_extended_${version}_macOS-ARM64.tar.gz` :
+
+    // Windows
+    platform === "win32" && arch === "x64" ?
+      `hugo_extended_${version}_Windows-64bit.zip` :
+    platform === "win32" && arch.endsWith("32") ?
+      `hugo_${version}_Windows-32bit.zip` :
+    platform === "win32" && "arm" ?
+      `hugo_${version}_Windows-ARM.zip` :
+
+    // Linux
+    platform === "linux" && arch === "x64" ?
+      `hugo_extended_${version}_Linux-64bit.tar.gz` :
+    platform === "linux" && arch.endsWith("32") ?
+      `hugo_${version}_Linux-32bit.tar.gz` :
+    platform === "linux" && arch === "arm" ?
+      `hugo_${version}_Linux-ARM.tar.gz` :
+    platform === "linux" && arch === "arm64" ?
+      `hugo_${version}_Linux-ARM64.tar.gz` :
+
+    // FreeBSD
+    platform === "freebsd" && arch === "x64" ?
+      `hugo_${version}_FreeBSD-64bit.tar.gz` :
+    platform === "freebsd" && arch.endsWith("32") ?
+      `hugo_${version}_FreeBSD-32bit.tar.gz` :
+    platform === "freebsd" && arch === "arm" ?
+      `hugo_${version}_FreeBSD-ARM.tar.gz` :
+    platform === "freebsd" && arch === "arm64" ?
+      `hugo_${version}_FreeBSD-ARM64.tar.gz` :
+
+    // OpenBSD
+    platform === "openbsd" && arch === "x64" ?
+      `hugo_${version}_OpenBSD-64bit.tar.gz` :
+    platform === "openbsd" && arch.endsWith("32") ?
+      `hugo_${version}_OpenBSD-32bit.tar.gz` :
+    platform === "openbsd" && arch === "arm" ?
+      `hugo_${version}_OpenBSD-ARM.tar.gz` :
+    platform === "openbsd" && arch === "arm64" ?
+      `hugo_${version}_OpenBSD-ARM64.tar.gz` :
+
+    // not gonna work :(
+    null;
+
+  return filename;
+}
+
+// Simple formula for the checksums.txt file.
+export function getChecksumFilename(version) {
+  return `hugo_${version}_checksums.txt`;
+}
+
+// Check if Hugo extended is being downloaded (as opposed to plain Hugo) based on the release filename.
+export function isExtended(releaseFile) {
+  return releaseFile.startsWith("hugo_extended_");
+}

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "hugo-extended",
-  "version": "0.88.0",
+  "version": "0.88.1-patch1",
+  "hugoVersion": "0.88.1",
   "description": "✏️ Plug-and-play binary wrapper for Hugo Extended, the awesomest static-site generator.",
   "license": "MIT",
+  "homepage": "https://github.com/jakejarvis/hugo-extended",
   "author": {
     "name": "Jake Jarvis",
     "email": "jake@jarv.is",
@@ -14,31 +16,28 @@
   },
   "files": [
     "index.js",
-    "cli.js",
-    "install.js"
+    "index.d.ts",
+    "lib"
   ],
   "bin": {
-    "hugo": "cli.js",
-    "hugo-extended": "cli.js"
+    "hugo": "lib/cli.js",
+    "hugo-extended": "lib/cli.js"
   },
   "type": "module",
   "exports": "./index.js",
+  "types": "./index.d.ts",
   "dependencies": {
-    "chalk": "^4.1.2",
-    "decompress": "^4.2.1",
-    "execa": "^5.1.1",
-    "fs-extra": "^10.0.0",
-    "got": "^11.8.2",
-    "sumchecker": "^3.0.1",
-    "tempy": "^2.0.0"
+    "careful-downloader": "^1.4.0",
+    "log-symbols": "^5.0.0",
+    "read-pkg-up": "^9.0.0"
   },
   "devDependencies": {
     "@jakejarvis/eslint-config": "*",
-    "eslint": "^7.32.0",
-    "mocha": "^9.1.1"
+    "eslint": "^8.0.0",
+    "mocha": "^9.1.2"
   },
   "scripts": {
-    "postinstall": "node install.js",
+    "postinstall": "node lib/install.js",
     "test": "eslint . && mocha"
   },
   "engines": {
@@ -70,13 +69,12 @@
       "sourceType": "module"
     },
     "env": {
-      "node": true
-    },
-    "rules": {
-      "compat/compat": "off"
+      "node": true,
+      "es6": true
     },
     "ignorePatterns": [
-      "vendor/**"
+      "vendor/**",
+      "*.d.ts"
     ]
   }
 }

package/cli.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-import execa from "execa";
-import hugo from "./index.js";
-
-const args = process.argv.slice(2);
-
-execa(hugo, args, { stdio: "inherit" });

package/install.js

@@ -1,150 +0,0 @@
-import fs from "fs-extra";
-import stream from "stream";
-import { fileURLToPath } from "url";
-import { promisify } from "util";
-import path from "path";
-import tempy from "tempy";
-import execa from "execa";
-import chalk from "chalk";
-import got from "got";
-import decompress from "decompress";
-import sumchecker from "sumchecker";
-
-// https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#what-do-i-use-instead-of-__dirname-and-__filename
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
-installHugo()
-  .then((bin) => {
-    // print output of `hugo version` to console
-    const { stdout } = execa.sync(bin, ["version"]);
-    return stdout;
-  })
-  .then((version) => {
-    console.log(chalk.green("✔ Hugo installed successfully!"));
-    console.log(version);
-  })
-  .catch((error) => {
-    // pass whatever error occured along the way along to console
-    console.error(chalk.red("✖ Hugo installation failed. :("));
-    throw error;
-  });
-
-async function installHugo() {
-  // this package's version number (should) always match the Hugo release we want
-  const { version } = await fs.readJson("./package.json");
-  const downloadBaseUrl = `https://github.com/gohugoio/hugo/releases/download/v${version}/`;
-  const releaseFile = getArchiveFilename(version, process.platform, process.arch);
-  const checksumFile = `hugo_${version}_checksums.txt`;
-
-  // stop here if there's nothing we can download
-  if (!releaseFile) {
-    throw "Are you sure this platform is supported?";
-  }
-
-  const releaseUrl = downloadBaseUrl + releaseFile;
-  const checksumUrl = downloadBaseUrl + checksumFile;
-  const vendorDir = path.join(__dirname, "vendor");
-  const tempDir = tempy.directory({ prefix: "hugo-node" });
-  const archivePath = path.join(tempDir, releaseFile);
-  const checksumPath = path.join(tempDir, checksumFile);
-  const binName = process.platform === "win32" ? "hugo.exe" : "hugo";
-  const binPath = path.join(vendorDir, binName);
-
-  try {
-    // ensure the target directory exists
-    await fs.mkdirp(vendorDir, {
-      mode: 0o2775, // ensure binary is executable
-    });
-
-    await Promise.all([
-      // fetch the archive file from GitHub
-      downloadFile(releaseUrl, archivePath),
-      // fetch the checksum file from GitHub
-      downloadFile(checksumUrl, checksumPath),
-    ]);
-
-    // validate the checksum of the download
-    await checkChecksum(tempDir, checksumPath, releaseFile);
-
-    // extract the downloaded file
-    await decompress(archivePath, vendorDir);
-  } finally {
-    // delete temporary directory
-    await fs.remove(tempDir);
-  }
-
-  // return the full path to our Hugo binary
-  return binPath;
-}
-
-async function downloadFile(url, dest) {
-  const pipeline = promisify(stream.pipeline);
-
-  return await pipeline(
-    got.stream(url, { followRedirect: true }),  // GitHub releases redirect to unpredictable URLs
-    fs.createWriteStream(dest),
-  );
-}
-
-async function checkChecksum(baseDir, checksumFile, binFile) {
-  const checker = new sumchecker.ChecksumValidator("sha256", checksumFile, {
-    defaultTextEncoding: "binary",
-  });
-
-  return await checker.validate(baseDir, binFile);
-}
-
-// Hugo Extended supports: macOS x64, macOS ARM64, Linux x64, Windows x64.
-// all other combos fall back to vanilla Hugo. there are surely much better ways
-// to do this but this is easy to read/update. :)
-function getArchiveFilename(version, os, arch) {
-  const filename =
-    // macOS
-    os === "darwin" && arch === "x64" ?
-      `hugo_extended_${version}_macOS-64bit.tar.gz` :
-    os === "darwin" && arch === "arm64" ?
-      `hugo_extended_${version}_macOS-ARM64.tar.gz` :
-
-    // Windows
-    os === "win32" && arch === "x64" ?
-      `hugo_extended_${version}_Windows-64bit.zip` :
-    os === "win32" && arch.endsWith("32") ?
-      `hugo_${version}_Windows-32bit.zip` :
-
-    // Linux
-    os === "linux" && arch === "x64" ?
-      `hugo_extended_${version}_Linux-64bit.tar.gz` :
-    os === "linux" && arch.endsWith("32") ?
-      `hugo_${version}_Linux-32bit.tar.gz` :
-    os === "linux" && arch === "arm" ?
-      `hugo_${version}_Linux-ARM.tar.gz` :
-    os === "linux" && arch === "arm64" ?
-      `hugo_${version}_Linux-ARM64.tar.gz` :
-
-    // FreeBSD
-    os === "freebsd" && arch === "x64" ?
-      `hugo_${version}_FreeBSD-64bit.tar.gz` :
-    os === "freebsd" && arch.endsWith("32") ?
-      `hugo_${version}_FreeBSD-32bit.tar.gz` :
-    os === "freebsd" && arch === "arm" ?
-      `hugo_${version}_FreeBSD-ARM.tar.gz` :
-    os === "freebsd" && arch === "arm64" ?
-      `hugo_${version}_FreeBSD-ARM64.tar.gz` :
-
-    // OpenBSD
-    os === "openbsd" && arch === "x64" ?
-      `hugo_${version}_OpenBSD-64bit.tar.gz` :
-    os === "openbsd" && arch.endsWith("32") ?
-      `hugo_${version}_OpenBSD-32bit.tar.gz` :
-    os === "openbsd" && arch === "arm" ?
-      `hugo_${version}_OpenBSD-ARM.tar.gz` :
-    os === "openbsd" && arch === "arm64" ?
-      `hugo_${version}_OpenBSD-ARM64.tar.gz` :
-
-    // not gonna work :(
-    null;
-
-  return filename;
-}
-
-export { installHugo };