Is Shipcheck safe for automated build processes?

Yes, Shipcheck performs only read-only operations, meaning it never modifies your package files. This makes it completely safe to integrate into CI/CD pipelines and other automated development workflows without risk.

Shipcheck is a developer tool designed to audit npm packages for publish-readiness. It helps prevent common publishing issues by analyzing package configurations and providing a comprehensive readiness report.

What aspects of an npm package does Shipcheck audit?

It thoroughly audits `package.json`, `tsconfig.json`, `exports` mappings, and verifies file existence. It also previews the exact contents and file sizes of the `npm pack` tarball.

How does Shipcheck help ensure a successful npm publish?

Shipcheck generates a publish-readiness score (0-100), identifies potential failures with detailed explanations and fixes, and shows exactly what files will be included in your tarball, turning 'release anxiety' into a machine-checkable artifact.

Shipcheck

Name: Shipcheck
Author: mcp-tool-shop-org

0•

Audits npm packages for publish-readiness, scoring package.json, previewing tarball contents, and explaining potential failures.

Shipcheck acts as an 'NPM Readiness Sheriff', providing a deterministic publish-readiness report for local package folders. It transforms 'release anxiety' into a machine-checkable artifact by analyzing `package.json`, `tsconfig.json`, exports, and file existence. This tool not only scores readiness but also previews exactly what files will be included in the tarball, identifying obvious foot-guns like missing types, broken exports, or the absence of a LICENSE, while offering human-readable context and suggested fixes for specific error codes. All operations are read-only, ensuring safety for automated calls.

Key Features

010 GitHub stars

02Generates a score (0-100) and structured findings (fails, warnings, infos)

03Previews exact tarball contents and file sizes using `npm pack --json`

04Performs read-only operations, safe for automated workflows

05Provides detailed explanations and fixes for specific error codes

06Audits package.json, tsconfig.json, and exports for publish-readiness

Use Cases

01Reducing release anxiety by proactively identifying potential issues and providing fixes

02Integrating into CI/CD pipelines for automated package integrity and readiness checks

03Ensuring an npm package is fully prepared and compliant before publication