@vanhanit/pre-compress 1.0.1

package/LICENSE

@@ -0,0 +1,91 @@
+Required Notice: Copyright (c) 2021-2026 Thomas Vanhaniemi (https://github.com/vanhanit)
+
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms.  Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures.  Goods and services compete even when provided free of charge.  If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business.  For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce [Noncompete](#noncompete) for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+**Affiliates** means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+**Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,103 @@
+# pre-compress
+
+[![CI](https://github.com/vanhanit/pre-compress/actions/workflows/main.yml/badge.svg)](https://github.com/vanhanit/pre-compress/actions/workflows/main.yml)
+[![Quality gate status](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vanhanit_pre-compress)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=bugs)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=code_smells)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=coverage)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=ncloc)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=security_rating)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=vanhanit_pre-compress&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=vanhanit_pre-compress)
+
+> Compress static files to be served by a web server.
+
+pre-compress writes a gzip (`.gz`) and a brotli (`.br`) version next to each file matched by the glob patterns, using
+the highest compression levels. A web server can then send the compressed file from disk instead of compressing it on
+every request, for example with `gzip_static` and `brotli_static` in nginx.
+
+- Files that are already compressed (`.gz` and `.br`) are never compressed again.
+- Compressed files are written atomically, so a server never sends a partially written file.
+- No dependencies, only Node.js built-ins.
+- Free to use, also in companies, under the [PolyForm Shield License](#license).
+
+Requires Node.js 22.18 or newer.
+
+## Install
+
+The package is published as `@vanhanit/pre-compress` and installs the `pre-compress` command.
+
+Run it without installing:
+
+```shell
+npx @vanhanit/pre-compress --files "dist/**/*.{html,css,js,svg}"
+```
+
+Install it globally:
+
+```shell
+npm install --global @vanhanit/pre-compress
+```
+
+Or add it to a project and compress the build output after each build:
+
+```shell
+npm install --save-dev @vanhanit/pre-compress
+```
+
+```json
+{
+  "scripts": {
+    "build": "vite build",
+    "postbuild": "pre-compress --delete-larger --skip-existing --files \"dist/**/*.{html,css,js,svg}\""
+  }
+}
+```
+
+## Usage
+
+```shell
+Usage: pre-compress [options]
+
+Compress static files to be served by a web server.
+
+Options:
+  -f, --files <files...>  the files to compress, supports glob patterns to match multiple files
+  -d, --delete-larger     delete compressed files that are not smaller than the source
+  -s, --skip-existing     don't compress if the compressed version is newer than the source
+  -V, --version           output the version number
+  -h, --help              display help for command
+```
+
+Quote the patterns so the shell passes them on unexpanded:
+
+```shell
+pre-compress --delete-larger --skip-existing --files "dist/**/*.{html,css,js,svg}"
+```
+
+- `--delete-larger` removes compressed versions that would not save any bytes, so the server sends the source instead.
+- `--skip-existing` only compresses files that changed since they were last compressed, which speeds up repeated runs.
+
+The command exits with code 1 when the arguments are invalid or a file cannot be compressed.
+
+## Development
+
+```shell
+npm ci
+npm run check  # lint, formatting, type check and tests
+npm run build  # compile to dist/
+```
+
+## License
+
+pre-compress is licensed under the [PolyForm Shield License 1.0.0](LICENSE). You may use it for any purpose, also in
+commercial projects and companies of any size, and you may fork, change and redistribute it. You may not use it to
+provide a product that competes with it, such as selling pre-compress or a service built on it.
+
+For a commercial license without these limits, contact [@vanhanit](https://github.com/vanhanit).
+
+Contributions are welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+Version 1.0.0 was published under the MIT License.

package/dist/args.js

@@ -0,0 +1,59 @@
+import { parseArgs } from "node:util";
+/**
+ * Invalid command line arguments.
+ */
+export class ArgumentError extends Error {
+    name = "ArgumentError";
+}
+const OPTIONS = {
+    files: { type: "string", short: "f", multiple: true },
+    "delete-larger": { type: "boolean", short: "d" },
+    "skip-existing": { type: "boolean", short: "s" },
+    version: { type: "boolean", short: "V" },
+    help: { type: "boolean", short: "h" }
+};
+const HELP = [
+    ["-f, --files <files...>", "the files to compress, supports glob patterns to match multiple files"],
+    ["-d, --delete-larger", "delete compressed files that are not smaller than the source"],
+    ["-s, --skip-existing", "don't compress if the compressed version is newer than the source"],
+    ["-V, --version", "output the version number"],
+    ["-h, --help", "display help for command"]
+];
+function parse(args) {
+    try {
+        return parseArgs({ args: [...args], options: OPTIONS, allowPositionals: true });
+    }
+    catch (error) {
+        throw new ArgumentError(error.message);
+    }
+}
+/**
+ * Parses the command line arguments, without the node and script paths. Patterns may follow `-f` or be repeated.
+ */
+export function parseArguments(args) {
+    const { values, positionals } = parse(args);
+    if (values.help) {
+        return { name: "help" };
+    }
+    if (values.version) {
+        return { name: "version" };
+    }
+    const patterns = [...(values.files ?? []), ...positionals];
+    if (patterns.length === 0) {
+        throw new ArgumentError("required option '-f, --files <files...>' not specified");
+    }
+    return {
+        name: "compress",
+        patterns,
+        deleteLarger: values["delete-larger"] ?? false,
+        skipExisting: values["skip-existing"] ?? false
+    };
+}
+/**
+ * Returns the help text.
+ */
+export function usage(name, description) {
+    const width = Math.max(...HELP.map(([flags]) => flags.length));
+    const options = HELP.map(([flags, text]) => `  ${flags.padEnd(width)}  ${text}`);
+    return [`Usage: ${name} [options]`, "", description, "", "Options:", ...options].join("\n");
+}

package/dist/cli.js

@@ -0,0 +1,64 @@
+import { availableParallelism } from "node:os";
+import { performance } from "node:perf_hooks";
+import { styleText } from "node:util";
+import { ArgumentError, parseArguments, usage } from "./args.js";
+import { compressFile, isCompressed } from "./compress.js";
+import { mapConcurrently } from "./concurrency.js";
+import { findFiles } from "./files.js";
+import { formatDuration, pluralize } from "./format.js";
+import { readPackageInfo } from "./package-info.js";
+function report({ file, size, outputs }, io) {
+    for (const output of outputs) {
+        if (output.status === "written") {
+            io.log(`Compressed file ${styleText("yellow", file)} to ${styleText("green", output.file)}`);
+        }
+        else if (output.status === "skipped") {
+            io.log(`Skipped file ${styleText("yellow", output.file)} because it is up to date`);
+        }
+        else {
+            io.log(`Deleted file ${styleText("red", output.file)} because ${output.size} byte(s) is not smaller than ${size} byte(s)`);
+        }
+    }
+}
+async function compress(command, io) {
+    const startTime = performance.now();
+    const files = (await findFiles(command.patterns)).filter((file) => !isCompressed(file));
+    const results = await mapConcurrently(files, availableParallelism(), async (file) => {
+        const result = await compressFile(file, command);
+        report(result, io);
+        return result;
+    });
+    const timeTakenMs = performance.now() - startTime;
+    const outputs = results.flatMap((result) => result.outputs);
+    const count = (status) => outputs.filter((output) => output.status === status).length;
+    io.log(`Processed ${pluralize(files.length, "file")} in ${styleText("green", formatDuration(timeTakenMs))}: ` +
+        `${styleText("green", String(count("written")))} written, ` +
+        `${styleText("yellowBright", String(count("skipped")))} skipped, ` +
+        `${styleText("red", String(count("deleted")))} deleted`);
+}
+/**
+ * Runs the command line interface with the arguments, without the node and script paths, and returns the exit code.
+ */
+export async function run(args, io = console) {
+    const { command: name, version, description } = readPackageInfo();
+    try {
+        const command = parseArguments(args);
+        if (command.name === "help") {
+            io.log(usage(name, description));
+        }
+        else if (command.name === "version") {
+            io.log(version);
+        }
+        else {
+            await compress(command, io);
+        }
+        return 0;
+    }
+    catch (error) {
+        io.error(`error: ${error instanceof Error ? error.message : String(error)}`);
+        if (error instanceof ArgumentError) {
+            io.error(`Run '${name} --help' for usage.`);
+        }
+        return 1;
+    }
+}

package/dist/compress.js

@@ -0,0 +1,56 @@
+import { readFile, rm, stat } from "node:fs/promises";
+import { extname } from "node:path";
+import { promisify } from "node:util";
+import { brotliCompress, constants, gzip } from "node:zlib";
+import { replaceFile, statFile } from "./files.js";
+const gzipAsync = promisify(gzip);
+const brotliCompressAsync = promisify(brotliCompress);
+const ENCODINGS = [
+    {
+        extension: "gz",
+        compress: (data) => gzipAsync(data, { level: constants.Z_BEST_COMPRESSION })
+    },
+    {
+        extension: "br",
+        compress: (data) => brotliCompressAsync(data, {
+            params: {
+                [constants.BROTLI_PARAM_MODE]: constants.BROTLI_MODE_TEXT,
+                [constants.BROTLI_PARAM_QUALITY]: constants.BROTLI_MAX_QUALITY,
+                [constants.BROTLI_PARAM_SIZE_HINT]: data.length
+            }
+        })
+    }
+];
+/**
+ * Whether the file has the extension of a compressed file this tool writes.
+ */
+export function isCompressed(file) {
+    const extension = extname(file).slice(1).toLowerCase();
+    return ENCODINGS.some((encoding) => encoding.extension === extension);
+}
+async function isUpToDate(target, source) {
+    const stats = await statFile(target);
+    return stats !== undefined && stats.mtimeMs >= source.mtimeMs;
+}
+/**
+ * Writes a compressed file next to the source for every encoding.
+ */
+export async function compressFile(file, options) {
+    const source = await stat(file);
+    let data;
+    const outputs = await Promise.all(ENCODINGS.map(async (encoding) => {
+        const target = `${file}.${encoding.extension}`;
+        if (options.skipExisting && (await isUpToDate(target, source))) {
+            return { file: target, status: "skipped" };
+        }
+        data ??= readFile(file);
+        const compressed = await encoding.compress(await data);
+        if (options.deleteLarger && compressed.length >= source.size) {
+            await rm(target, { force: true });
+            return { file: target, status: "deleted", size: compressed.length };
+        }
+        await replaceFile(target, compressed);
+        return { file: target, status: "written", size: compressed.length };
+    }));
+    return { file, size: source.size, outputs };
+}

package/dist/concurrency.js

@@ -0,0 +1,28 @@
+/**
+ * Maps items with an async mapper, running at most `concurrency` mappers at once. The results keep the input order.
+ * Rejects with the first error, after which no more items are started.
+ */
+export async function mapConcurrently(items, concurrency, mapper) {
+    if (!Number.isInteger(concurrency) || concurrency < 1) {
+        throw new RangeError(`Concurrency must be a positive integer, got ${concurrency}`);
+    }
+    const results = [];
+    let next = 0;
+    let failed = false;
+    const worker = async () => {
+        if (failed || next >= items.length) {
+            return;
+        }
+        const index = next++;
+        try {
+            results[index] = await mapper(items[index]);
+        }
+        catch (error) {
+            failed = true;
+            throw error;
+        }
+        return worker();
+    };
+    await Promise.all(Array.from({ length: Math.min(concurrency, items.length) }, worker));
+    return results;
+}

package/dist/files.js

@@ -0,0 +1,51 @@
+import { randomUUID } from "node:crypto";
+import { glob, rename, rm, stat, writeFile } from "node:fs/promises";
+import { basename, dirname, join, resolve } from "node:path";
+/**
+ * Returns the stats of the file at the path, following symbolic links. Undefined when it is missing or not a file.
+ */
+export async function statFile(path) {
+    try {
+        const stats = await stat(path);
+        return stats.isFile() ? stats : undefined;
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return undefined;
+        }
+        throw error;
+    }
+}
+/**
+ * Finds the files matching any of the glob patterns. Paths are relative to `cwd`, unless the pattern is absolute.
+ * Directories, dotfiles and broken symbolic links are skipped.
+ */
+export async function findFiles(patterns, cwd = process.cwd()) {
+    const matches = new Map();
+    for await (const match of glob([...patterns], { cwd })) {
+        const path = resolve(cwd, match);
+        if (!matches.has(path)) {
+            matches.set(path, match);
+        }
+    }
+    const entries = [...matches];
+    const stats = await Promise.all(entries.map(([path]) => statFile(path)));
+    return entries
+        .filter((_, index) => stats[index] !== undefined)
+        .map(([, match]) => match)
+        .sort((a, b) => a.localeCompare(b));
+}
+/**
+ * Writes the data to a hidden temporary file and renames it to the path, so readers never see a partial file.
+ */
+export async function replaceFile(path, data) {
+    const temporary = join(dirname(path), `.${basename(path)}.${randomUUID()}.tmp`);
+    try {
+        await writeFile(temporary, data);
+        await rename(temporary, path);
+    }
+    catch (error) {
+        await rm(temporary, { force: true });
+        throw error;
+    }
+}

package/dist/format.js

@@ -0,0 +1,32 @@
+const TENTHS_PER_UNIT = [
+    ["hour", 36_000],
+    ["minute", 600]
+];
+/**
+ * Returns the count with the unit, adding an s unless the count is one.
+ */
+export function pluralize(count, unit) {
+    return `${count} ${unit}${count === 1 ? "" : "s"}`;
+}
+/**
+ * Formats a duration for humans, e.g. `1 minute 1.5 seconds`.
+ */
+export function formatDuration(milliseconds) {
+    const rounded = Math.round(milliseconds);
+    if (rounded < 1000) {
+        return pluralize(rounded, "millisecond");
+    }
+    let tenths = Math.round(milliseconds / 100);
+    const parts = [];
+    for (const [unit, size] of TENTHS_PER_UNIT) {
+        const count = Math.floor(tenths / size);
+        if (count > 0) {
+            parts.push(pluralize(count, unit));
+            tenths -= count * size;
+        }
+    }
+    if (tenths > 0) {
+        parts.push(pluralize(tenths / 10, "second"));
+    }
+    return parts.join(" ");
+}

package/dist/main.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import { run } from "./cli.js";
+process.exitCode = await run(process.argv.slice(2));

package/dist/package-info.js

@@ -0,0 +1,8 @@
+import { readFileSync } from "node:fs";
+/**
+ * Reads the command name, version and description from package.json.
+ */
+export function readPackageInfo() {
+    const { bin, version, description } = JSON.parse(readFileSync(new URL("../package.json", import.meta.url), "utf8"));
+    return { command: Object.keys(bin)[0], version, description };
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@vanhanit/pre-compress",
+  "version": "1.0.1",
+  "description": "Compress static files to be served by a web server.",
+  "author": "Thomas Vanhaniemi",
+  "type": "module",
+  "bin": {
+    "pre-compress": "dist/main.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/vanhanit/pre-compress.git"
+  },
+  "homepage": "https://github.com/vanhanit/pre-compress#readme",
+  "bugs": {
+    "url": "https://github.com/vanhanit/pre-compress/issues"
+  },
+  "license": "PolyForm-Shield-1.0.0",
+  "keywords": [
+    "compress",
+    "compression",
+    "precompress",
+    "pre-compress",
+    "glob",
+    "br",
+    "brotli",
+    "gz",
+    "gzip",
+    "static",
+    "assets"
+  ],
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^22.20.5",
+    "eslint": "^10.12.0",
+    "prettier": "^3.9.10",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.71.2"
+  },
+  "scripts": {
+    "test": "node --test --test-reporter=spec \"tests/**/*.test.ts\"",
+    "pretest:coverage": "node -e \"fs.mkdirSync('coverage', { recursive: true })\"",
+    "test:coverage": "node --test --experimental-test-coverage --test-coverage-include=\"src/**\" --test-reporter=spec --test-reporter-destination=stdout --test-reporter=lcov --test-reporter-destination=coverage/lcov.info \"tests/**/*.test.ts\"",
+    "clean": "node -e \"fs.rmSync('dist', { recursive: true, force: true })\"",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "prepack": "npm run build",
+    "typecheck": "tsc",
+    "lint": "eslint .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "check": "npm run lint && npm run format:check && npm run typecheck && npm test"
+  }
+}