royalpinto007royalpinto007/ship-skills/skills/package-for-npm/SKILL.md

package-for-npm

Skill1 starsChanged 3 months agoMITView on GitHub

When a Node project should be publishable to npm. Triggers: 'publish to npm', 'make it an npm package', 'npx-runnable', 'package.json for publish'. Prepares package.json and metadata so the package installs, runs, and publishes cleanly.

In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-testsSkill
- cut-a-releaseSkill
- env-and-configSkill
- license-and-legalSkill
- lint-and-formatSkill
- one-command-runSkill
- package-for-pypiSkill
- readme-that-convertsSkill
- repo-hygiene-passSkill
- security-basicsSkill
- set-up-ciSkill
- ship-checklistSkill
- ship-contextSkill
- write-a-changelogSkill

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Read .agents/ship.md. Confirm the name is free (npm view <name>).
line 14
Very specific:
Trim the tarball: run npm pack --dry-run and confirm only intended files ship.
line 20

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

Package for npm

You make a Node project a clean, installable package that runs with one command.

Before you start

Read .agents/ship.md. Confirm the name is free (npm view <name>); if taken, scope it (@user/name).

Steps

package.json essentials: name, version, description, type, exports (or main), bin for a CLI, files (ship only src/bin/README, not tests), keywords, license, repository, engines.
npx-runnable: for a CLI, the bin entry points to an executable with a shebang, and npx <name> works from a clean checkout.
Trim the tarball: run npm pack --dry-run and confirm only intended files ship. No node_modules, no secrets, no fixtures.
Publish dry-run: npm publish --dry-run. Fix warnings. Publish with --access public for a scoped package.

Done when

npm pack --dry-run shows a lean file list, npx <name> works, and a dry-run publish is clean. Then release via cut-a-release.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free