vercel / vercel/ncc

Add types to distributed package

Open
#581 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
9.8k
Forks
326
PR merge metrics
No merged PRs in 30d

Description

It would be great if ncc would ship with a types definition in the package.

So that programmatic use can provide information in the IDE. Afaik it would be enough to describe the default export as demonstrated in the README.

Contributor guide

No contributing guide indexed for this repository

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 with the README's default export example and inspect the package entry point used by programmatic consumers. Add a type definition that describes that default export and ensure it is shipped with the package so IDEs can provide information; verify the published package exposes the definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.