aspect-build / aspect-build/rules_js

[Documentation] npm_import and transitive dependencies

Open
#1,266 1 comment 0 reactions 0 assignees View on GitHub
documentation help wanted
Dominant language
Starlark
Stars
378
Forks
183
Avg merge
1d 9h
Merged PRs (30d)
32

Description

Hi,

I was experimenting with the new ts_proto rules, and it seems I need [npm dependencies](https://github.com/aspect-build/rules_ts/blob/main/docs/proto.md) to get that to work. I don't have any use of npm yet (just starting a Typescript project), so I was trying `npm_import` rather than a lock file, since I'd just have a couple.

But I realized (and correct me if I'm wrong), that it does not give you any of the `npn_import`ed package's dependencies or transitive dependencies - though they can be manually specified right?

If IIUC, I plan to send a PR to just make that clear in the documentation (essentially motivating why it is rarely used).

Thanks!

Kyle

Contributor guide

Open the contributing guide

Research direction

Start with docs/proto.md and the npm_import references described in the issue. Confirm how npm_import handles package dependencies and transitive dependencies, then make the documentation state that behavior and its implications clearly; the documentation should answer whether dependencies must be specified manually.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.