refactor(nodecli): リファクタリング、文章の修正 #919

azu · 2019-08-03T12:36:29Z

ファイル名を明示するように修正
process.exit(error.code) -> process.exit(1)
文章の統一

azu · 2019-08-03T12:37:22Z

source/use-case/nodecli/read-file/src/read-file-3.js

@@ -7,8 +7,10 @@ const filePath = program.args[0];
 fs.readFile(filePath, "utf8", (err, file) => {
    if (err) {
        console.error(err);
-        process.exit(err.code);
+        // 終了ステータス 1（一般的なエラー）としてプロセスを終了
+        process.exit(1);


❯ node src/read-file-3.js test { [Error: ENOENT: no such file or directory, open 'test'] errno: -2, code: 'ENOENT', syscall: 'open', path: 'test' } ~/.ghq/github.com/asciidwango/js-primer/source/use-case/nodecli/read-file 2019-nodecli-refactoring* ❯ echo $? 0

err.code はundefined なので明示的に 1 を指定

bot-user · 2019-08-03T12:38:53Z

Deploy preview for js-primer ready!

Built with commit 62fd648

https://deploy-preview-919--js-primer.netlify.com

azu · 2019-08-03T12:43:16Z

@lacolaco nodecli どういう風に読んで書いていく構造になっている?
readあたりはファイル名が毎回違うけど、どんどんファイルを増やしながら実装していくイメージ?

https://jsprimer.net/use-case/nodecli/read-file/

でも https://jsprimer.net/use-case/nodecli/md-to-html/ の

前のセクションの最後で書いたスクリプトに、markedパッケージの読み込み処理を追加します。

とかを見ると同じファイルに追加してる感じになって、写しながらやっていくと結構困った。

fix #879

azu · 2019-08-03T12:37:41Z

source/use-case/setup-local-env/README.md

 また、ブラウザで実行するアプリケーションであっても、その開発にはツールとしてのNode.jsが欠かせません。
 このセクションではユースケースの学習へ進むために必要なアプリケーション開発環境の準備をおこないます。

 ## Node.jsのインストール {#install-nodejs}

 [Node.js][]はサーバーサイドJavaScript実行環境のひとつで、次のような特徴があります。

- WebブラウザのChromeと同じ[V8][] JavaScriptエンジンで動作する
+- ウェブブラウザのChromeと同じ[V8][] JavaScriptエンジンで動作する


ウェブブラウザに統一

azu · 2019-08-03T13:44:04Z

source/use-case/ajaxapp/entrypoint/README.md


 ここでは `ajaxapp` という名前で新しいディレクトリを作成します。ここからは作成した`ajaxapp`ディレクトリ以下で作業していきます。

+またこのプロジェクトで作成するファイルは、必ず文字コード（エンコーディング）を**UTF-8**、改行コードを**LF**にしてファイルを保存します。


ユースケースに文字コードと改行コードの指定を追加

azu · 2019-08-03T13:44:43Z

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


-`--foo`オプションに値を与えて実行すれば、文字列が`options.foo`プロパティにセットされていることがわかります。
+`--bar`オプションに値を与えて実行すれば、文字列が`options.bar`プロパティにセットされていることがわかります。


--foo だと被るので --bar に変更してみた

azu · 2019-08-03T13:45:29Z

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


 ECMAScriptで定義されているグローバルオブジェクトはブラウザとNode.jsどちらの環境にも存在します。
-たとえば`Boolean`、`String`などのラッパーオブジェクトや、`Map`、`Array`、`Promise`のようなビルトインオブジェクトがそれにあたります。
+たとえば`Boolean`や`String`などのラッパーオブジェクト、`Map`や`Promise`のようなビルトインオブジェクトはどちらの環境にも存在します。


Arrayはややこしいので、省いた

azu · 2019-08-03T13:46:51Z

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

+今回のアプリケーションでは次の2つのオプションを扱います。
+
+- gfm
+- sanitize


marked #918 sanitizeオプションの問題出てきそう。
バージョンは固定されてるけど将来消える

azu · 2019-08-03T13:50:49Z

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

-テストコード中でエラーを投げるために、今回はNode.jsの標準モジュールのひとつである[assertモジュール][]から提供される`assert`関数を利用します。
-`assert`関数は引数の評価結果がfalseであるとき、実行時にエラーを投げます。
+テストコード中でエラーを投げるために、今回はNode.jsの標準モジュールのひとつである[assertモジュール][]から提供される`assert.strictEqual`メソッドを利用します。
+`assert.strictEqual`メソッドは第1引数と第2引数の評価結果が`===`で比較して異なる場合に、例外を投げる関数です。


エラーのときの情報量を考えた assert.strictEqual に変更した。

azu · 2019-08-03T13:51:13Z

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


 ```json
 {
    ...
    "scripts": {
-        "test": "mocha"
+        "test": "mocha test/"


なんかディレクトリが暗黙的に決まるのは説明的にもしにくいので test/ を明示するようにした。

azu · 2019-08-03T13:51:28Z

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

@@ -107,7 +110,15 @@ Mochaのユニットテストは`test`ディレクトリの中にJavaScriptフ
 `test/fixtures`ディレクトリにはユニットテストで用いるファイルを配置しています。
 今回は変換元のMarkdownファイルと、期待する変換結果のHTMLファイルの2つが存在します。

-ユニットテストを記述したら、もう一度改めて`npm test`コマンドを実行しましょう。1件のテストが通れば成功です。
+次のように変換元のMarkdownファイルを`test/fixtures/sample.md`に配置します。


実際にどういうファイルを作るのかをちゃんと書くようにした。

azu · 2019-08-03T13:52:25Z

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

@@ -118,6 +129,12 @@ $ npm test
  1 passing (18ms)
 ```

+ユニットテストが通らなかった場合は、次のことを確認してみましょう


https://pagain.hatenablog.com/entry/2019/06/24/120820 テスト通らなかったときの確認事項を適当に足してみた。

azu · 2019-08-03T13:52:44Z

source/use-case/nodecli/refactor-and-unittest/src/example/functions.js

-module.exports.foo = function() { /**/ };
-module.exports.bar = function() { /**/ };
+module.exports.foo = function() {
+    console.log("foo関数が呼び出されました");


実際に書いて試してる人は何かよばれたのかを確認したいと思うのでログを出す

azu · 2019-08-03T14:07:31Z

source/use-case/nodecli/argument-parse/src/commander-param.js

@@ -1,5 +1,5 @@
 const program = require("commander");
-program.option("--foo <text>");
+program.option("--bar <text>");


<text> ってどういう意味なのか結局よくわかってない
type checkとかあるのかな

lacolaco · 2019-08-04T03:23:25Z

@lacolaco nodecli どういう風に読んで書いていく構造になっている?
readあたりはファイル名が毎回違うけど、どんどんファイルを増やしながら実装していくイメージ?

https://jsprimer.net/use-case/nodecli/read-file/

でも https://jsprimer.net/use-case/nodecli/md-to-html/ の

前のセクションの最後で書いたスクリプトに、markedパッケージの読み込み処理を追加します。

とかを見ると同じファイルに追加してる感じになって、写しながらやっていくと結構困った。

commander-param.jsとか分けてるけど、多分main.jsでやっていったほうがいいですよねえこれ

lacolaco · 2019-08-04T03:24:38Z

なんか学び用のサンプルコードと、アプリのためのコードの区別が難しいんだな

azu · 2019-08-05T13:49:02Z

とりあえずマージしました。

@lacolaco 残りは #928 にしました。

azu added 4 commits August 3, 2019 17:49

fix(prh): Webブラウザ -> ウェブブラウザ

0744fdc

fix(nodecli/helloworld): リファクタリング

735487c

refactor(nodecli): CommonJSのリファクタリング

204361f

fix(nodecli/read-file): ファイルの読み込みを修正

e0d006e

azu commented Aug 3, 2019

View reviewed changes

azu added 4 commits August 3, 2019 21:54

fix: main.jsのファイル名を指定

ab2ac9b

fix(use-case): ファイルの文字コードと改行コードを指定

3ddcfdc

fix #879

fix(nodecli): unit testの修正

111430d

fix: code

9959258

azu commented Aug 3, 2019

View reviewed changes

azu requested a review from lacolaco August 3, 2019 13:52

fix

62fd648

azu marked this pull request as ready for review August 3, 2019 14:06

azu commented Aug 3, 2019

View reviewed changes

azu mentioned this pull request Aug 5, 2019

2019-08-05のミーティングアジェンダ #924

Closed

azu merged commit c23ab2e into master Aug 5, 2019

azu deleted the 2019-nodecli-refactoring branch August 5, 2019 13:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(nodecli): リファクタリング、文章の修正 #919

refactor(nodecli): リファクタリング、文章の修正 #919

azu commented Aug 3, 2019 •

edited

Loading

azu Aug 3, 2019 •

edited

Loading

bot-user commented Aug 3, 2019 •

edited

Loading

azu commented Aug 3, 2019 •

edited

Loading

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019

azu Aug 3, 2019 •

edited

Loading

lacolaco commented Aug 4, 2019

lacolaco commented Aug 4, 2019

azu commented Aug 5, 2019


		ここでは `ajaxapp` という名前で新しいディレクトリを作成します。ここからは作成した`ajaxapp`ディレクトリ以下で作業していきます。

		またこのプロジェクトで作成するファイルは、必ず文字コード（エンコーディング）をUTF-8、改行コードをLFにしてファイルを保存します。


		`--foo`オプションに値を与えて実行すれば、文字列が`options.foo`プロパティにセットされていることがわかります。
		`--bar`オプションに値を与えて実行すれば、文字列が`options.bar`プロパティにセットされていることがわかります。

refactor(nodecli): リファクタリング、文章の修正 #919

refactor(nodecli): リファクタリング、文章の修正 #919

Conversation

azu commented Aug 3, 2019 • edited Loading

azu Aug 3, 2019 • edited Loading

Choose a reason for hiding this comment

bot-user commented Aug 3, 2019 • edited Loading

azu commented Aug 3, 2019 • 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azu Aug 3, 2019 • edited Loading

Choose a reason for hiding this comment

lacolaco commented Aug 4, 2019

lacolaco commented Aug 4, 2019

azu commented Aug 5, 2019

azu commented Aug 3, 2019 •

edited

Loading

azu Aug 3, 2019 •

edited

Loading

bot-user commented Aug 3, 2019 •

edited

Loading

azu commented Aug 3, 2019 •

edited

Loading

azu Aug 3, 2019 •

edited

Loading