mochaを`node:test`に変更する #1737

windchime-yk · 2024-04-01T11:18:18Z

ref: #1717
これはテキスト修正のみの対応になります。
実装側の修正については、#1698 が終わり次第着手する予定です。

修正内容としては、表題の通りMochaからnode:testへの変更になります。
変更に際し、以下を考慮しました。

Mocha互換のdescribe/itも実装されていましたが、Node.js公式ドキュメントではtestが主流とされていたため、そちらに寄せました
Mochaではテストフォルダまでコマンド実行時に指定していますが、node --test test/だとmacOS上でエラーとなるため、デフォルトでtestフォルダが指定されていることも加味してnode --testとしました
コマンドライン上で表示されるパスは、本ユースケース内を参照して、Users/laco/nodecli/に統一しています

Preview

https://deploy-preview-1737--js-primer.netlify.app/use-case/nodecli/refactor-and-unittest/

bot-user · 2024-04-01T11:19:12Z

✅ Deploy Preview for js-primer ready!

Name	Link
🔨 Latest commit	`ba1b84a`
🔍 Latest deploy log	https://app.netlify.com/sites/js-primer/deploys/6653ffb217c58a00080d9b5c
😎 Deploy Preview	https://deploy-preview-1737--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 · 2024-04-02T00:08:26Z

関連しそうなので一応 cc @yossydev @jp-knj @SotaYamaguchi

azu · 2024-04-02T00:04:35Z

source/use-case/nodecli/refactor-and-unittest/README.md

-この記述により、`npm test`コマンドを実行すると、`mocha`コマンドで`test/`ディレクトリにあるテストファイルを実行します。
-試しに`npm test`コマンドを実行し、Mochaによるテストが行われることを確認しましょう。
-まだテストファイルを作っていないので、`Error: No test files found`というエラーが表示されます。
+この記述により、`npm test`コマンドを実行すると、`node --test`で`test/`ディレクトリにあるテストファイルを実行します。


https://nodejs.org/api/test.html#running-tests-from-the-command-line
node --test もデフォルトで test/** 見るんですね。
コマンドからtest/ を省く場合は、デフォルトで test/ を探索する的な説明があった方がいい気はしますね(自明ではないので、mochaの場合は意図的にtest/を入れていたんだと思います)

azu · 2024-04-02T00:10:19Z

source/use-case/nodecli/refactor-and-unittest/README.md

-まだテストファイルを作っていないので、`Error: No test files found`というエラーが表示されます。
+この記述により、`npm test`コマンドを実行すると、`node --test`で`test/`ディレクトリにあるテストファイルを実行します。
+試しに`npm test`コマンドを実行し、テストが行われることを確認しましょう。
+まだテストファイルを作っていないので、テストが何も走らず正常終了します。


テストが何も走らず正常終了します。

Mochaと違って正常終了なんですね。

"テストが何も走らず"というのが、node --test 自体が何も動いてないように見えるので、
0個のテストが実行されて正常終了という感じの言い方の方もありかな。

実行するテストがないため正常終了します

0個のテストが実行されて正常終了します

テストを実行した結果は0件となり正常終了します

$ node --test ℹ tests 0 ℹ suites 0 ℹ pass 0 ℹ fail 0 ℹ cancelled 0 ℹ skipped 0 ℹ todo 0 ℹ duration_ms 27.760042 $ echo $? 0

azu · 2024-04-02T00:17:46Z

source/use-case/nodecli/refactor-and-unittest/README.md

 ```

 ## ユニットテストを記述する {#write-unit-test}

 テストの実行環境ができたので、実際にユニットテストを記述します。
-Mochaのユニットテストは`test`ディレクトリの中にJavaScriptファイルを配置して記述します。
+Node.jsのユニットテストは`test`ディレクトリの中にJavaScriptファイルを配置して記述します。


"Node.jsのユニットテスト"というと広いので、 node:test でのユニットテストな気はするので、

[testモジュール][]でのユニットテストはtestディレクトリの中にJavaScriptファイルを配置して記述します。

とかなのかなとは思います。

testディレクトリを探索するのはTest Runnerなので、ちょっと言い方が難しいですが…

確かに言い方が難しいですね……。
こちらについては言い方を考えてみます！ご指摘ありがとうございます！

@azu
こちらについて書き方を考えていたのですが、句末に4回記述します。が続いているのが気になったため、以下のように修正するのはいかがでしょうか？

記述する際には、testディレクトリの中にJavaScriptファイルを配置します。

全体的にはこういった修正を考えております。

テストの実行環境ができたので、実際にユニットテストを記述します。 - Node.jsのユニットテストは`test`ディレクトリの中にJavaScriptファイルを配置して記述します。 + 記述する際には、`test`ディレクトリの中にJavaScriptファイルを配置します。 `test/md2html-test.js`ファイルを作成し、`md2html.js`に対するユニットテストを次のように記述します。 - `test`関数は第一引数にテストのタイトルを入れ、第二引数にテストの内容を記述します。 + `test`関数は第一引数にテストのタイトルを入れ、第二引数にテストの内容を入れます。

良いと思います

`test`関数は第一引数にテストのタイトルを入れ、第二引数にテストの内容を書きます。

入れるだと枠っぽいので、実際には自由記述なので、書くや記述が良いかなと思います

なるほど、ありがとうございます！書くで修正させていただきます！

lacolaco · 2024-04-03T02:15:02Z

source/use-case/nodecli/refactor-and-unittest/README.md

-
-ユニットテストを実行するには、Mochaが提供する`mocha`コマンドを使います。
-Mochaをインストールした後、`package.json`の`scripts`プロパティを次のように記述します。
+ユニットテストを実行するには、Node.jsが提供する`node`コマンドに`--test`オプションを付与して使います。


Suggested change

ユニットテストを実行するには、Node.jsが提供する`node`コマンドに`--test`オプションを付与して使います。

ユニットテストを実行するには、Node.jsが提供する`node`コマンドを`--test`オプションを付与して実行します。

「使います」の対象がわかりにくかったので「nodeコマンドを実行する」を軸にしてみましたが、「を」お連続がこれはこれで気持ち悪いですね

Suggested change

ユニットテストを実行するには、Node.jsが提供する`node`コマンドに`--test`オプションを付与して使います。

ユニットテストを実行するには、Node.jsが提供する`node`コマンドの`--test`オプションを使います。

このほうがいいかも？

レビューありがとうございます！
私としても下のほうが読みやすいと感じるので、そちらで修正させていただきます！

windchime-yk · 2024-04-14T12:56:20Z

@azu @lacolaco
レビューありがとうございました！
ご指摘をいただいた部分を修正しましたので、再レビューをお願いします！ 🙇

azu

他はLGTMです

残り

コードの変更
依存の変更

azu · 2024-04-15T00:28:07Z

source/use-case/nodecli/refactor-and-unittest/README.md

+
+$ echo $?
+0


ここは省略していいかなと思います。

Suggested change

$ echo $?

0

Windowsでは動かないため。

How do I get the application exit code from a Windows command line? - Stack Overflow

Windowsを失念しておりました！ご指摘ありがとうございます！

@azu
ご指摘の点を修正しました！

lacolaco

LGTMです

azu · 2024-04-16T02:57:57Z

先にコードと依存の変更までやってマージしちゃっていい気がしてきました

windchime-yk · 2024-05-21T14:58:18Z

@azu
すみません、通知に埋もれていて気づくのが遅れてしまいました！
今見た限りですと前段のutils.parseArgsが未着手なようなので、先にこちらの変更を進めようと思います！

windchime-yk · 2024-05-27T03:43:34Z

@azu @lacolaco
修正遅くなりました！
『ユニットテストを記述する』ディレクトリのテスト実装をMochaからnode:testに変更いたしましたので、レビューをお願いいたします！
また、IssueのTODOを見る限り変更範囲は『ユニットテストを記述する』ディレクトリのみと判断しましたが、読み間違えていればご指摘ください。

azu

ありがとうございます！
LGTM

* 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 <[email protected]>

windchime-yk added 2 commits April 1, 2024 19:45

fix(nodecli): ユニットテストのMochaをnode:testに変更

a74e73d

fix(nodecli): Mochaのリンクを削除

91bd34d

azu requested a review from lacolaco April 2, 2024 00:08

azu reviewed Apr 2, 2024

View reviewed changes

lacolaco reviewed Apr 3, 2024

View reviewed changes

fix(nodecli): 修正箇所の言い回しを訂正

d095db6

windchime-yk requested review from azu and lacolaco April 14, 2024 12:56

azu reviewed Apr 15, 2024

View reviewed changes

lacolaco approved these changes Apr 15, 2024

View reviewed changes

fix(nodecli): Windowsで動作しないサンプルコードを削除

0530871

windchime-yk requested a review from azu April 15, 2024 16:03

azu approved these changes Apr 16, 2024

View reviewed changes

azu added Status: Blocked Type: Refactoring labels Apr 16, 2024

fix(nodecli): refactor-and-unittestからMochaを削除

ba1b84a

windchime-yk requested review from azu and lacolaco May 27, 2024 03:43

azu approved these changes May 27, 2024

View reviewed changes

azu merged commit f93189f into asciidwango:v6-node-updates May 27, 2024
7 checks passed

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

mochaを`node:test`に変更する #1737

mochaを`node:test`に変更する #1737

windchime-yk commented Apr 1, 2024 •

edited by azu

Loading

bot-user commented Apr 1, 2024 •

edited

Loading

azu commented Apr 2, 2024

azu Apr 2, 2024 •

edited

Loading

azu Apr 2, 2024 •

edited

Loading

azu Apr 2, 2024

windchime-yk Apr 2, 2024

windchime-yk Apr 11, 2024

azu Apr 14, 2024 •

edited

Loading

windchime-yk Apr 14, 2024

lacolaco Apr 3, 2024 •

edited

Loading

windchime-yk Apr 4, 2024

windchime-yk commented Apr 14, 2024

azu left a comment

azu Apr 15, 2024

windchime-yk Apr 15, 2024

windchime-yk Apr 15, 2024

lacolaco left a comment

azu commented Apr 16, 2024

windchime-yk commented May 21, 2024

windchime-yk commented May 27, 2024

azu left a comment

	ユニットテストを実行するには、Node.jsが提供する`node`コマンドに`--test`オプションを付与して使います。
	ユニットテストを実行するには、Node.jsが提供する`node`コマンドを`--test`オプションを付与して実行します。

	ユニットテストを実行するには、Node.jsが提供する`node`コマンドに`--test`オプションを付与して使います。
	ユニットテストを実行するには、Node.jsが提供する`node`コマンドの`--test`オプションを使います。

mochaをnode:testに変更する #1737

mochaをnode:testに変更する #1737

Conversation

windchime-yk commented Apr 1, 2024 • edited by azu Loading

Preview

bot-user commented Apr 1, 2024 • edited Loading

✅ Deploy Preview for js-primer ready!

azu commented Apr 2, 2024

azu Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

azu Apr 2, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azu Apr 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lacolaco Apr 3, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

windchime-yk commented Apr 14, 2024

azu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lacolaco left a comment

Choose a reason for hiding this comment

azu commented Apr 16, 2024

windchime-yk commented May 21, 2024

windchime-yk commented May 27, 2024

azu left a comment

Choose a reason for hiding this comment

mochaを`node:test`に変更する #1737

mochaを`node:test`に変更する #1737

windchime-yk commented Apr 1, 2024 •

edited by azu

Loading

bot-user commented Apr 1, 2024 •

edited

Loading

azu Apr 2, 2024 •

edited

Loading

azu Apr 2, 2024 •

edited

Loading

azu Apr 14, 2024 •

edited

Loading

lacolaco Apr 3, 2024 •

edited

Loading