mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-19 22:55:44 +01:00
Publish the bundle size in the README and fail the gate when it drifts a tenth
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
import { build } from "esbuild";
|
||||
import { execFileSync } from "node:child_process";
|
||||
import { gzipSync } from "node:zlib";
|
||||
|
||||
const bytesPerKilobyte = 1000;
|
||||
// A published figure stays true while it is within this share of the measure.
|
||||
const tolerance = 0.1;
|
||||
|
||||
// What a consumer's bundler ships for the package: its code and its dependencies, minified, gzipped.
|
||||
export const minifiedGzippedBytes = async (resolveDir, specifier) => {
|
||||
const { outputFiles } = await build({
|
||||
bundle: true,
|
||||
format: "esm",
|
||||
logLevel: "silent",
|
||||
minify: true,
|
||||
platform: "node",
|
||||
stdin: { contents: `export * from ${JSON.stringify(specifier)};`, resolveDir },
|
||||
write: false,
|
||||
});
|
||||
return gzipSync(outputFiles[0].contents, { level: 9 }).length;
|
||||
};
|
||||
|
||||
export const packedBytes = (packageDir) => {
|
||||
const [{ size, unpackedSize }] = JSON.parse(execFileSync("npm", ["pack", "--dry-run", "--json"], { cwd: packageDir, encoding: "utf8", env: { ...process.env, npm_config_update_notifier: "false" } }));
|
||||
return { tarball: size, unpacked: unpackedSize };
|
||||
};
|
||||
|
||||
const number = "(\\d+(?:\\.\\d+)?)";
|
||||
const published = [
|
||||
["minified", "minified and gzipped", new RegExp(`^\\| Size \\|.*?${number} kB minified and gzipped`, "m")],
|
||||
["tarball", "tarball", new RegExp(`^\\| Size \\|.*?${number} kB tarball`, "m")],
|
||||
["unpacked", "unpacked", new RegExp(`^\\| Size \\|.*?${number} kB unpacked`, "m")],
|
||||
];
|
||||
const tableCell = new RegExp(`^\\| \`@larvit/adf-codec\` \\|.*\\| ${number} kB \\|$`, "m");
|
||||
|
||||
const offBy = (claimed, bytes) => Math.abs(Number(claimed) - bytes / bytesPerKilobyte) > tolerance * bytes / bytesPerKilobyte;
|
||||
const kilobytes = (bytes) => (bytes / bytesPerKilobyte).toFixed(1);
|
||||
|
||||
// The README's size claims that no longer match the measure, each as a sentence.
|
||||
export const drift = (readme, measured) => [
|
||||
...published.flatMap(([key, label, pattern]) => {
|
||||
const found = pattern.exec(readme);
|
||||
if (!found) return [`README has no ${label} figure in its Size row`];
|
||||
return offBy(found[1], measured[key]) ? [`README says ${found[1]} kB ${label}; measured ${kilobytes(measured[key])} kB`] : [];
|
||||
}),
|
||||
...(() => {
|
||||
const found = tableCell.exec(readme);
|
||||
if (!found) return ["README's comparison table has no size for @larvit/adf-codec"];
|
||||
return offBy(found[1], measured.minified) ? [`README's comparison table says ${found[1]} kB for @larvit/adf-codec; measured ${kilobytes(measured.minified)} kB`] : [];
|
||||
})(),
|
||||
];
|
||||
Reference in New Issue
Block a user