list-npm-package-content

Name: list-npm-package-content
Availability: InStock
Author: Vercel

List npm package tarball contents before publishing.

26.1k|4.9k|Updated May 23, 2023

Search Tags:#debugging #npm #verification #build #package #pack #tarball

Ready to run

npx skills add https://github.com/vercel/ai --skill list-npm-package-content

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: list-npm-package-content
Source: https://github.com/vercel/ai/tree/main/skills/list-npm-package-content
Command: npx skills add https://github.com/vercel/ai --skill list-npm-package-content

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pnpm, tar, and includes scripts (resource) components.

What problem does it solve?

This skill lists the exact contents of an npm package tarball before publish. It helps engineers verify what files would be included in a bundle and diagnose npm publish issues.

Core Features & Use Cases

Tarball contents listing: Reveals exactly which files and directories are packaged into the tarball.
Deterministic packaging: Uses a repeatable build and pack process via pnpm to ensure consistency.
Use Case: When preparing for an npm release, quickly verify that only intended files are published.

Quick Start

From the package directory, run the script to build, package, and list the tarball contents: bash scripts/list-package-files.sh

Frequently Asked Questions about list-npm-package-content

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

FAQPage Schema

How do I list the contents of an npm package tarball before publishing?▼

To list npm package tarball contents before publishing, run the build and pack process using pnpm to generate the tarball, then extract and list its file structure. This verifies exactly which files are bundled for release.

What is the best way to verify which files are included in an npm publish?▼

The best way to verify npm publish contents is to pack the source into a tarball using a deterministic build process and list its files. This reveals exactly which directories and files will be published to the registry.

Do I need pnpm and tar to inspect npm package contents before release?▼

Yes, you need pnpm and tar to inspect npm package contents before release. The verification process requires a Node environment with pnpm to build and pack the package, and the tar utility to list the tarball files.

How can I debug npm publish issues where unexpected files are bundled?▼

To debug npm publish issues with unexpected bundled files, pack the package source into a tarball and list its contents. This allows you to inspect the exact file structure and verify that only intended files are included.

Can I check my npm package file structure during a CI build workflow?▼

Yes, you can check your npm package file structure during a CI build workflow. The tarball listing process applies during package build and release workflows to verify deterministic packaging and ensure only intended files are published.