sindresorhus/np
Np
np is a command line tool for managing the versioning and publication of packages to the npm registry. It serves as a release automator and semantic versioning tool that handles version bumps, git tagging, and the upload of packages to public or private registries.
The tool distinguishes itself by providing an interactive workflow that guides users through sequential publishing steps, including a preview of all scheduled tasks before remote changes are performed. It includes automated release drafting to generate summary notes and audit capabilities to identify extraneous files or unpublished assets before publication.
The software covers a broad range of release automation capabilities, including git state validation, pre-flight task sequencing for tests and dependency cleaning, and registry access control for scoped packages. It utilizes manifest-driven configuration to manage project-specific preferences for branch names and package managers.
Features
- Automated Version Incrementing - Programmatically calculates and applies version increments to project manifests according to semantic versioning rules.
- Release Automation - Automates the full release cycle including dependency cleaning, test execution, and package publishing.
- Package Publishing - Handles the complete process of uploading JavaScript packages to the npm registry with correct versioning.
- Package Publishing Tools - Provides a command line tool specifically designed for managing the versioning and publication of npm packages.
- Package Publishing Utilities - Coordinates the full sequence of bumping versions, running tests, tagging code, and uploading to a registry.
- Package Registry Clients - Acts as a client for interacting with and publishing to custom npm registries with secure authentication.
- Registry Authentication - Manages authentication tokens and credentials for securely uploading packages to public or private registries.
- Registry Routing Rules - Controls how scoped or private packages are routed to default or custom npm registries.
- Git Release Automators - Automates the process of staging, committing, and tagging release changes within a Git repository.
- Repository State Validation - Verifies the git working directory is clean and the correct branch is active before starting the publishing process.
- Version Control Workflows - Enforces a clean transition from development to production by validating git state and applying release tags.
- Registry Access Controls - Implements authentication and authorization policies for publishing to public, private, or scoped registries.
- Interactive CLI Wizards - Provides a guided terminal interface that leads users through a sequential series of release verification steps.
- Unpublished File Detection - Identifies new or unpublished files in git to prevent the accidental exclusion of essential assets from a release.
- Published File Filtering - Audits the final package content to identify and exclude extraneous files based on ignore strategies.
- Pre-versioning Tasks - Executes a sequence of dependency cleaning and test scripts as a prerequisite to the package upload process.
- Working Directory Validations - Verifies that the working directory is clean and the correct branch is active before starting the publishing process.
- Release Note Generation - Generates prefilled release drafts and summary notes automatically after a successful package publication.
- Publishing Step Previews - Provides a detailed preview of all scheduled publishing tasks to verify actions before performing remote changes.
- Release Automation - Improved npm package publishing.
- Publishing Tools - A better, more streamlined publishing workflow.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
