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

オープン 初心者向け
#1,203 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
92/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
node.js
領域
documentation

調査の方向性

issue でリンクされている README.md の npm install セクションを開き、その前提条件のテキストを、ここで説明されているパッケージインストールの動作と比較してください。古い Python/C/C++ の前提条件に関する注記と VS Code wiki リンクを削除し、そのうえで、そのセクションがビルドツールチェーンなしで @devcontainers/cli をインストールする方法を正確に説明していることを確認してください。

索引モデルが issue の本文から書いたものです。

説明

The README's npm install section says:

To install the npm package you will need Python and C/C++ installed to build one of the dependencies (see, e.g., here 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
主要言語
TypeScript
スター
3k
フォーク
461
平均マージ
13時間 17分
マージ済み PR(30日)
6

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

devcontainers/cli のほかの issue

devcontainers/cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。