Open source · Web & UX

Web Share Preview Checker

Check share metadata and preview dimensions for links passed between platforms.

v1.0.0 · Node.js 22+ · MIT

Browse the public repository · View releases

TOOLID=web-share-preview-checker. Zero-dependency Node 22+ policy estimator for exported page metadata, configured preview profiles, and a local image file. It makes no network request, opens no browser, and generates no image or platform screenshot. Its previews are privacy-safe measurements, expressly labeled approximations.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/web-share-preview-checker.mjs --root examples --page passing.json --profiles wide-profile.json
node bin/web-share-preview-checker.mjs --root examples --page wide.json --profiles both-profiles.json
node bin/web-share-preview-checker.mjs --root examples --page square.json --profiles both-profiles.json
npm run check

Read the result

The commands exit 0, 1, and 1. The wide image produces warnings for the square profile; the square image produces warnings for the wide profile. --help prints usage; --human writes a terse stderr summary. src/index.mjs exports TOOLID, LIMITS, imageDimensions, and async evaluatePreviews(page,profiles,{readImage,now}). The CLI confines all three real file paths within the real --root and writes nothing.