hugo-extended 0.160.1 → 0.161.0

package/dist/cli.mjs

@@ -1,7 +1,6 @@
 #!/usr/bin/env node
 import hugo_default from "./hugo.mjs";
 import { spawn } from "node:child_process";
-
 //#region src/cli.ts
 process.on("unhandledRejection", (reason) => {
 	console.error("Unhandled promise rejection:", reason);
@@ -23,6 +22,5 @@ process.on("unhandledRejection", (reason) => {
 		process.exitCode = 1;
 	}
 })();
-
 //#endregion
-export {  };
+export {};

package/dist/generated/types.mjs

@@ -1 +1 @@
-export {  };
+export {};

package/dist/hugo.mjs

@@ -3,7 +3,6 @@ import { ENV_VAR_DOCS, getEnvConfig } from "./lib/env.mjs";
 import { doesBinExist, getBinPath, logger } from "./lib/utils.mjs";
 import install from "./lib/install.mjs";
 import { spawn } from "node:child_process";
-
 //#region src/hugo.ts
 /**
 * Gets the path to the Hugo binary, automatically installing it if it's missing.
@@ -183,25 +182,33 @@ async function execWithOutput(command, positionalArgsOrOptions, options) {
 * ```
 */
 const hugo = {
+	/** Build your site */
 	build: (options) => exec("build", options),
+	/** Generate shell completion scripts */
 	completion: {
 		bash: (options) => exec("completion bash", options),
 		fish: (options) => exec("completion fish", options),
 		powershell: (options) => exec("completion powershell", options),
 		zsh: (options) => exec("completion zsh", options)
 	},
+	/** Print Hugo configuration */
 	config: (options) => exec("config", options),
+	/** Convert content to different formats */
 	convert: {
 		toJSON: (options) => exec("convert toJSON", options),
 		toTOML: (options) => exec("convert toTOML", options),
 		toYAML: (options) => exec("convert toYAML", options)
 	},
+	/** Print Hugo environment info */
 	env: (options) => exec("env", options),
+	/** Generate documentation */
 	gen: {
 		doc: (options) => exec("gen doc", options),
 		man: (options) => exec("gen man", options)
 	},
+	/** Import your site from others */
 	import: { jekyll: (options) => exec("import jekyll", options) },
+	/** List various types of content */
 	list: {
 		all: (options) => exec("list all", options),
 		drafts: (options) => exec("list drafts", options),
@@ -209,6 +216,7 @@ const hugo = {
 		future: (options) => exec("list future", options),
 		published: (options) => exec("list published", options)
 	},
+	/** Module operations */
 	mod: {
 		clean: (options) => exec("mod clean", options),
 		get: (options) => exec("mod get", options),
@@ -219,6 +227,7 @@ const hugo = {
 		vendor: (options) => exec("mod vendor", options),
 		verify: (options) => exec("mod verify", options)
 	},
+	/** Create new content */
 	new: Object.assign((pathOrOptions, options) => {
 		if (typeof pathOrOptions === "string") return exec("new", [pathOrOptions], options);
 		return exec("new", pathOrOptions);
@@ -236,11 +245,11 @@ const hugo = {
 			return exec("new theme", nameOrOptions);
 		}
 	}),
+	/** Start the Hugo development server */
 	server: (options) => exec("server", options),
+	/** Print the Hugo version */
 	version: (options) => exec("version", options)
 };
-const hugoCompat = getHugoBinary;
-var hugo_default = Object.assign(hugoCompat, hugo);
-
+var hugo_default = Object.assign(getHugoBinary, hugo);
 //#endregion
-export { ENV_VAR_DOCS, hugo_default as default, exec, execWithOutput, getEnvConfig, getHugoBinary, hugo };
+export { ENV_VAR_DOCS, hugo_default as default, exec, execWithOutput, getEnvConfig, getHugoBinary, hugo };

package/dist/lib/args.mjs

@@ -1,7 +1,6 @@
 import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
-
 //#region src/lib/args.ts
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 let cachedSpec = null;
@@ -121,6 +120,5 @@ function inferKind(value) {
 	}
 	return "string";
 }
-
 //#endregion
-export { buildArgs };
+export { buildArgs };

package/dist/lib/env.mjs

@@ -42,6 +42,15 @@ function getFirstDefined(names) {
 * All supported environment variable configurations.
 */
 const ENV_VARS = {
+	/**
+	* Override the Hugo version to install.
+	* When set, ignores the version from package.json.
+	*
+	* Intentionally not aliased to HUGO_VERSION to avoid confusion and
+	* conflicts with Netlify, etc.
+	*
+	* @example HUGO_OVERRIDE_VERSION=0.139.0 npm install hugo-extended
+	*/
 	overrideVersion: {
 		name: "HUGO_OVERRIDE_VERSION",
 		aliases: [],
@@ -49,6 +58,12 @@ const ENV_VARS = {
 		parse: parseVersion,
 		defaultValue: void 0
 	},
+	/**
+	* Force installation of vanilla Hugo instead of Extended.
+	* Useful when SCSS/SASS features aren't needed or to reduce binary size.
+	*
+	* @example HUGO_NO_EXTENDED=1 npm install hugo-extended
+	*/
 	forceStandard: {
 		name: "HUGO_NO_EXTENDED",
 		aliases: ["HUGO_FORCE_STANDARD"],
@@ -56,6 +71,13 @@ const ENV_VARS = {
 		parse: parseBoolean,
 		defaultValue: false
 	},
+	/**
+	* Skip the postinstall Hugo binary download entirely.
+	* Useful for CI caching, Docker layer optimization, or when Hugo is
+	* already installed system-wide.
+	*
+	* @example HUGO_SKIP_DOWNLOAD=1 npm ci
+	*/
 	skipInstall: {
 		name: "HUGO_SKIP_DOWNLOAD",
 		aliases: [],
@@ -63,6 +85,12 @@ const ENV_VARS = {
 		parse: parseBoolean,
 		defaultValue: false
 	},
+	/**
+	* Use a pre-existing Hugo binary instead of the bundled one.
+	* When set, the package will use this path for all Hugo operations.
+	*
+	* @example HUGO_BIN_PATH=/usr/local/bin/hugo npm start
+	*/
 	binPath: {
 		name: "HUGO_BIN_PATH",
 		aliases: [],
@@ -70,6 +98,16 @@ const ENV_VARS = {
 		parse: parseString,
 		defaultValue: void 0
 	},
+	/**
+	* Override the base URL for downloading Hugo releases.
+	* Useful for air-gapped environments, corporate mirrors, or faster
+	* regional mirrors.
+	*
+	* The URL should be the base path where release files are hosted.
+	* The version and filename will be appended automatically.
+	*
+	* @example HUGO_MIRROR_BASE_URL=https://mirror.example.com/hugo npm install
+	*/
 	downloadBaseUrl: {
 		name: "HUGO_MIRROR_BASE_URL",
 		aliases: [],
@@ -77,6 +115,12 @@ const ENV_VARS = {
 		parse: parseString,
 		defaultValue: void 0
 	},
+	/**
+	* Skip SHA-256 checksum verification of downloaded files.
+	* Use with caution - only recommended for trusted mirrors or development.
+	*
+	* @example HUGO_SKIP_CHECKSUM=1 npm install hugo-extended
+	*/
 	skipChecksum: {
 		name: "HUGO_SKIP_CHECKSUM",
 		aliases: ["HUGO_SKIP_VERIFY"],
@@ -84,6 +128,12 @@ const ENV_VARS = {
 		parse: parseBoolean,
 		defaultValue: false
 	},
+	/**
+	* Suppress installation progress output.
+	* Useful for cleaner CI logs or scripted automation.
+	*
+	* @example HUGO_QUIET=1 npm install hugo-extended
+	*/
 	quiet: {
 		name: "HUGO_QUIET",
 		aliases: ["HUGO_SILENT"],
@@ -133,6 +183,5 @@ const ENV_VAR_DOCS = Object.entries(ENV_VARS).map(([key, config]) => ({
 	type: config.defaultValue === void 0 ? "string" : typeof config.defaultValue === "boolean" ? "boolean" : "string",
 	default: config.defaultValue
 }));
-
 //#endregion
-export { ENV_VAR_DOCS, getEnvConfig };
+export { ENV_VAR_DOCS, getEnvConfig };

package/dist/lib/install.mjs

@@ -10,7 +10,6 @@ import { Readable } from "node:stream";
 import { pipeline } from "node:stream/promises";
 import AdmZip from "adm-zip";
 import * as tar from "tar";
-
 //#region src/lib/install.ts
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 /**
@@ -184,6 +183,5 @@ async function install() {
 		throw error;
 	}
 }
-
 //#endregion
-export { install as default, extractPkg, getArchiveType, parseChecksumFile };
+export { install as default, extractPkg, getArchiveType, parseChecksumFile };

package/dist/lib/utils.mjs

@@ -3,7 +3,6 @@ import { execFileSync } from "node:child_process";
 import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
-
 //#region src/lib/utils.ts
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 /**
@@ -176,16 +175,24 @@ function isExtended(releaseFile) {
 * Logger utility that respects the HUGO_QUIET setting.
 */
 const logger = {
+	/**
+	* Log an info message (respects HUGO_QUIET).
+	*/
 	info: (message) => {
 		if (!getEnvConfig().quiet) console.info(message);
 	},
+	/**
+	* Log a warning message (respects HUGO_QUIET).
+	*/
 	warn: (message) => {
 		if (!getEnvConfig().quiet) console.warn(`⚠ ${message}`);
 	},
+	/**
+	* Log an error message (always shown, even in quiet mode).
+	*/
 	error: (message) => {
 		console.error(`✖ ${message}`);
 	}
 };
-
 //#endregion
-export { compareVersions, doesBinExist, getBinFilename, getBinPath, getBinVersion, getChecksumFilename, getPkgVersion, getReleaseFilename, getReleaseUrl, isExtended, logger, usesMacOSPkg };
+export { compareVersions, doesBinExist, getBinFilename, getBinPath, getBinVersion, getChecksumFilename, getPkgVersion, getReleaseFilename, getReleaseUrl, isExtended, logger, usesMacOSPkg };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hugo-extended",
-  "version": "0.160.1",
+  "version": "0.161.0",
   "description": "✏️ Plug-and-play binary wrapper for Hugo Extended, the awesomest static-site generator.",
   "license": "MIT",
   "repository": {
@@ -58,19 +58,19 @@
     "prepublishOnly": "npm run generate-types && npm run build"
   },
   "dependencies": {
-    "adm-zip": "^0.5.16",
-    "tar": "^7.5.9"
+    "adm-zip": "^0.5.17",
+    "tar": "^7.5.13"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.4.2",
-    "@types/adm-zip": "^0.5.7",
-    "@types/node": "^25.3.0",
+    "@biomejs/biome": "^2.4.13",
+    "@types/adm-zip": "^0.5.8",
+    "@types/node": "^25.6.0",
     "@types/tar": "^6.1.13",
-    "@vitest/coverage-v8": "^4.0.18",
-    "tinyexec": "^1.0.2",
-    "tsdown": "^0.20.3",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "@vitest/coverage-v8": "^4.1.5",
+    "tinyexec": "^1.1.1",
+    "tsdown": "^0.21.10",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.5"
   },
   "engines": {
     "node": ">=18.17"