fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 #1757

azu · 2024-07-21T07:08:08Z

サマリ

commanderパッケージは使わずに、node:utilのparseArg関数を使うように変更した
npm installを初めて使うのがmarkedパッケージに変わったため、整合性のためpackage.jsonの説明とnpm installの説明を分離して移動した

変更内容

Node.jsでHello World
- "Node.jsプロジェクトのセットアップ "を追加 (package.jsonの作成)
コマンドライン引数を処理する
- commander を node:util の parseArgs関数に変更
- デフォルト設定を定義する {#declare-default}セクションは削除(defaultオプションでいいため)
- --gfmの呼び方をフラグに統一(オプションと呼んでる場所があった)
MarkdownをHTMLに変換する
- npm install の説明を移動
- [コラム] node: prefix を追加
  - 本文は node: に統一したので、逆に本文にはいらなくなった

Preview

Diffで見るのは結構厳しい量なので、Previewで見ておかしいところを治すがよさそう

https://deploy-preview-1757--js-primer.netlify.app/use-case/nodecli/

cc @yossydev @jp-knj

fix #1698

bot-user · 2024-07-21T07:08:55Z

✅ Deploy Preview for js-primer ready!

Name	Link
🔨 Latest commit	`f6525b4`
🔍 Latest deploy log	https://app.netlify.com/sites/js-primer/deploys/66ade321b6ee570008ffe042
😎 Deploy Preview	https://deploy-preview-1757--js-primer.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

azu

Node CLIの章全体を変えてる

azu · 2024-07-21T11:23:40Z

source/use-case/nodecli/md-to-html/README.md

+### [コラム] `node:` プリフィックス {#node-prefix}
+
+Node.jsの標準モジュールは、`node:util`や`node:fs`のように`node:`というプリフィックスがモジュール名についています。
+この`node:`プリフィックスは後から導入された仕組みであるため、`util`や`fs`のようにプリフィックスなしでもモジュールを読み込むことができます。
+
+しかしながら、`node:`プリフィックスがあることでnpmからインストールしたサードパーティ製のモジュールとの区別が明確になるため、付けておくことが推奨されます。


デフォルトがnode:になってるので、あえて本文にいる必要がない気がするのでコラムに切り出した。

azu · 2024-07-21T11:25:45Z

source/use-case/nodecli/helloworld/README.md

+## Node.jsプロジェクトのセットアップ {#setup-nodejs-project}
+
+今回作成するNode.jsのCLIアプリケーションは、`main.js`ファイル以外にも複数のファイルが必要になります。
+また、外部のnpmパッケージのインストールやテストスクリプトの実行なども行います。
+そのため、Node.jsプロジェクトのセットアップとして`package.json`というファイルを作成します。
+
+`package.json`とは、プロジェクトの情報、プロジェクトが依存するパッケージの種類やバージョンの情報、プロジェクトで実行するスクリプトなどを記録するJSON形式のファイルです。
+`package.json`ファイルのひな形は、`npm init`コマンドで生成できます。
+まだ`npm`コマンドの用意ができていなければ、先に「[アプリケーション開発の準備][]」の章を参照してください。
+
+通常は対話式のプロンプトによって情報を設定しますが、ここではすべてデフォルト値で`package.json`を作成する`--yes`オプションを付与します。
+`nodecli`のディレクトリ内で、`npm init --yes`コマンドを実行して`package.json`を作成しましょう。
+
+```shell
+$ npm init --yes
+```
+
+生成された`package.json`ファイルは次のようになっています。
+
+[import, title:"package.json"](src/package.json)
+
+現時点では`package.json`にはあまり情報が記述されていませんが、後ほどアプリケーションの情報や依存パッケージを追加する際に利用します。
+


package.jsonを作るところだけを最初に移動した。
type=moduleの設定のところで色々書くと大変なので、プロジェクトセットアップ的な話で置いてる。
ここでtype=module設定までやても良い気はするけど…

npm initにはいまだに type=module を設定する方法がなかった
npm/rfcs#347

azu · 2024-07-21T11:26:08Z

source/use-case/nodecli/md-to-html/README.md

-## markedパッケージを使う {#use-marked-package}
+## `marked`パッケージをインストールする {#install-marked}

-JavaScriptでMarkdownをHTMLへ変換するために、今回は[marked][]というライブラリを使用します。
-markedのパッケージはnpmで配布されているので、commanderと同様に`npm install`コマンドでパッケージをインストールしましょう。
+MarkdownをHTMLへ変換するために、今回は[marked][]というライブラリを使用します。
+markedのパッケージは[npm][]で配布されているので、`npm install`コマンドを使ってインストールできます。
+まだ、`package.json`を作成していない場合は、先に「[Node.jsプロジェクトのセットアップ][]」を参照してください。
+
+それでは、`npm install`コマンドを使って`marked`パッケージをインストールします。
+このコマンドの引数にはインストールするパッケージの名前とそのバージョンを`@`記号でつなげて指定できます。
+バージョンを指定せずにインストールすれば、その時点での最新の安定版が自動的に選択されます。
+次のコマンドを実行して、markedのバージョン4.0をインストールします。[^1]

 ```shell
 $ npm install marked@4.0
 ```

+インストールが完了すると、`package.json`ファイルは次のようになっています。
+
+[import, title:"package.json"](src/package.json)
+
+また、`npm install`をすると同時に`package-lock.json`ファイルが生成されています。
+このファイルはnpmがインストールしたパッケージの、実際のバージョンを記録するためのものです。
+先ほどmarkedのバージョンを`4.0`としましたが、実際にインストールされるのは`4.0.x`に一致する最新のバージョンです。
+`package-lock.json`ファイルには実際にインストールされたバージョンが記録されています。
+これによって、再び`npm install`を実行したときに、異なるバージョンがインストールされるのを防ぎます。
+


ここで npm installは初登場になる

azu · 2024-07-21T11:26:37Z

source/use-case/nodecli/refactor-and-unittest/src/package.json

@@ -11,7 +11,6 @@
  "author": "",
  "license": "ISC",
  "dependencies": {
-    "commander": "^9.0.0",


commanderはアンインストール

azu · 2024-07-21T11:28:47Z

source/use-case/nodecli/argument-parse/README.md

+`parseArgs`関数は、コマンドライン引数をパースした結果として`values`と`positionals`の2つのプロパティを持つオブジェクトを返します。
+`values`オブジェクトには、`--key=value`のようなオプションや`--flag`のようなフラグをパースした結果が保存されています。
+`positionals`配列には、オプションやフラグ以外の引数が配列として順番に格納されています。
+デフォルトでは、`positionals`配列はパース結果には含まれないため、`allowPositionals`オプションを`true`にすることで含まれるようになります。


positionals を説明する誰でもわかる日本語が思いつかなかったので、オプションやフラグ以外という表現にしてる。

* mochaを`node:test`に変更する (#1737) * fix(nodecli): ユニットテストのMochaをnode:testに変更 * fix(nodecli): Mochaのリンクを削除 * fix(nodecli): 修正箇所の言い回しを訂正 * fix(nodecli): Windowsで動作しないサンプルコードを削除 * fix(nodecli): refactor-and-unittestからMochaを削除 * fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 (#1757) * fix(nodecli): commanderをコードから削除 * refactor: commanderのインストールを削除、セットアップセクションを追加 * fix: commanderをparseArgに置き換える * fix * fix * fix: main-3.jsは利用しな苦なった * fix * fix * fix * fix order * fix: node:fsに統一 * `node:`をコラムに移動 * fix * fix * fix * fix * fix * remove empty line * fix * fix * npm link * link * fix * fix * fix * シンプルに * 標準モジュールはインストールが不要なことを明記 * fix --------- Co-authored-by: WhyK <windchimeyk@gmail.com>

fix(nodecli): commanderをコードから削除

e0a2e80

azu added 2 commits July 21, 2024 17:19

refactor: commanderのインストールを削除、セットアップセクションを追加

0366d66

fix: commanderをparseArgに置き換える

ccbeab9

azu changed the title ~~fix(nodecli): commander を node:util parseArgsに変更~~ fix(nodecli): commanderパッケージを node:util の parseArgs に変更 Jul 21, 2024

azu added 22 commits July 21, 2024 18:02

fix

cacc465

fix

1801053

fix: main-3.jsは利用しな苦なった

75b49f3

fix

9f76369

fix

2be5ce5

fix

6cbaa5a

fix order

1afe34e

fix: node:fsに統一

75211ce

node:をコラムに移動

4d8a909

fix

6e1e1e4

fix

64a2fb1

fix

ddb7ae7

fix

6ecb2f8

fix

6a61ce6

remove empty line

23b5c70

fix

a91f888

fix

6b97fc0

npm link

61c94bd

link

76da329

fix

8b6873b

fix

ee9f8ad

fix

23716ba

azu changed the title ~~fix(nodecli): commanderパッケージを node:util の parseArgs に変更~~ fix(nodecli): commanderパッケージを node:util の parseArg に変更 Jul 21, 2024

azu marked this pull request as ready for review July 21, 2024 11:22

azu requested a review from lacolaco July 21, 2024 11:22

azu commented Jul 21, 2024

View reviewed changes

azu added 3 commits August 3, 2024 16:49

シンプルに

4735798

標準モジュールはインストールが不要なことを明記

2a3ae71

fix

f6525b4

azu merged commit 2a0712b into v6-node-updates Aug 3, 2024
13 checks passed

azu deleted the node-utils branch August 3, 2024 08:00

azu mentioned this pull request Aug 3, 2024

feat: Node.jsの章の変更をmainにマージ #1758

Merged

This was referenced Aug 25, 2024

v6 リリースノートを書く #1763

Closed

Open Collectiveの経費精算のルールを決める #1736

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 #1757

fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 #1757

azu commented Jul 21, 2024 •

edited

Loading

bot-user commented Jul 21, 2024 •

edited

Loading

azu left a comment

azu Jul 21, 2024

azu Jul 21, 2024

azu Jul 21, 2024

azu Jul 21, 2024

azu Jul 21, 2024

fix(nodecli): commanderパッケージ を node:util の parseArg に変更 #1757

fix(nodecli): commanderパッケージ を node:util の parseArg に変更 #1757

Conversation

azu commented Jul 21, 2024 • edited Loading

サマリ

変更内容

Preview

bot-user commented Jul 21, 2024 • edited Loading

✅ Deploy Preview for js-primer ready!

azu left a comment

Choose a reason for hiding this comment

azu Jul 21, 2024

Choose a reason for hiding this comment

azu Jul 21, 2024

Choose a reason for hiding this comment

azu Jul 21, 2024

Choose a reason for hiding this comment

azu Jul 21, 2024

Choose a reason for hiding this comment

azu Jul 21, 2024

Choose a reason for hiding this comment

fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 #1757

fix(nodecli): commanderパッケージを `node:util` の `parseArg` に変更 #1757

azu commented Jul 21, 2024 •

edited

Loading

bot-user commented Jul 21, 2024 •

edited

Loading