npm / npm/cli

Feature request: Streaming when publishing

Open
#6,897 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
10.1k
Forks
4.7k
Avg merge
2d 2h
Merged PRs (30d)
19

Description

We've been working on a small private registry, and we needed to be able to stream when publishing a package. From what we can see in the docs and source code, npm only supports uploading files when publishing.

The way we imagine this working is that npm would hit the server to see which methods it supports:

  • The default/fallback would be uploading.
  • If the server responds that it supports streaming, npm will stream the metadata (JSON).

We'd be happy to contribute code around this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the npm publishing documentation and tracing the publishing path in the source code to identify how files and metadata are currently uploaded. Determine where server capability detection and the upload fallback would fit. Done means the behavior is specified and tested for both streaming-capable and upload-only registries.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.