docs-review-package

Validate package.json metadata, dependency ranges, and peer dependency compatibility.

Updated Mar 24, 2026

Search Tags:#npm #dependencies #audit #compliance #metadata #package.json

Ready to run

npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill docs-review-package

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-review-package
Source: https://github.com/spencerbeggs/design-docs-plugin/tree/main/plugin/skills/docs-review-package
Command: npx skills add https://github.com/spencerbeggs/design-docs-plugin --skill docs-review-package

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the common issue of poorly configured package.json files that lead to discoverability problems, dependency conflicts, and broken peer dependency contracts.

Core Features & Use Cases

Metadata Validation: Ensures essential fields like name, description, and license are present and correctly formatted.
Dependency Analysis: Evaluates dependency and peerDependency ranges to ensure compatibility and adherence to best practices.
Use Case: Use this skill when preparing a module for release to ensure it meets organizational standards and will function correctly when installed by consumers.

Quick Start

Run the docs-review-package skill on your current module to receive a comprehensive audit report of your package.json file.

Frequently Asked Questions about docs-review-package

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I audit a package.json file for metadata completeness?▼

To audit a package.json file for metadata completeness, validate that essential fields like name, description, and license are present and correctly formatted to prevent discoverability problems.

How do I validate peer dependency compatibility in an npm module?▼

Validate peer dependency compatibility in an npm module by evaluating dependency and peerDependency ranges to ensure adherence to best practices and prevent broken contracts.

What is the best way to check dependency version ranges before releasing a module?▼

The best way to check dependency version ranges before releasing a module is to evaluate them against best practices, ensuring compatibility and accurate version ranges for consumers.

Does package.json auditing work for software modules within monorepos?▼

Yes, package.json auditing applies to software modules within monorepos or standalone projects requiring standardized npm configuration and dependency contract verification.

Why do poorly configured package.json files cause dependency conflicts?▼

Poorly configured package.json files cause dependency conflicts and broken peer dependency contracts due to inaccurate version ranges and missing metadata fields.

When do I need to verify my npm package configuration?▼

You need to verify your npm package configuration when preparing a module for release, ensuring it meets organizational standards and functions correctly when installed by consumers.