devcontainers / devcontainers/cli

README npm install section mentions Python and C/C++ but they are no longer needed

未关闭 适合新手
#1,203 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
3k
派生
457
平均合并
13 小时 17 分钟
30 天内合并 PR
6

描述

The README's [npm install section](https://github.com/devcontainers/cli/blob/v0.86.0/README.md?plain=1#L59) says:

> To install the npm package you will need Python and C/C++ installed to build one of the dependencies (see, e.g., [here](https://github.com/microsoft/vscode/wiki/How-to-Contribute) for instructions).

This hasn't been true since v0.50.0. PR #585 removed `node-pty` from the published package, and `build/patch-packagejson.js` strips all `dependencies` before `npm pack`, so the tarball on npm has no deps to install at all.

Quick check with `node:24-slim`, which has no build toolchain:

```
$ docker run --rm node:24-slim sh -c "which python3 || echo 'not found'; which gcc || echo 'not found'; which make || echo 'not found'"
not found
not found
not found

$ docker run --rm node:24-slim sh -c "npm install -g @devcontainers/cli 2>&1 && npm list -g && devcontainer --version"
added 1 package in 1s
/usr/local/lib
+-- @devcontainers/cli@0.86.0
+-- corepack@0.34.6
`-- npm@11.11.0

0.86.0
```

Installs and runs fine without any build toolchain.

The prerequisite note and the link to the VS Code "How to Contribute" wiki should be removed from this section.

## Related

- #63
- #585

贡献指南

打开贡献指南

调研方向

打开 issue 中链接的 README.md 的 npm install 部分,将其中的先决条件文本与此处所述的软件包安装行为进行比较。删除过时的 Python/C/C++ 先决条件说明和 VS Code wiki 链接,然后验证该部分是否准确描述了无需构建工具链即可安装 @devcontainers/cli。

由索引模型根据 Issue 内容生成。

评估

技术栈
node.js
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
冷清
描述清晰度
描述清楚
新手友好度
92/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。