OSS Gate Workshop: online: 2024-03-09: unikounio: minimist Work log

[unikounio]

This is a work log of a "OSS Gate workshop". "OSS Gate workshop" is an activity to increase OSS developers. Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

• スライド：ワークショップの進行に使っているスライドがあります。
• チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[unikounio]

なににしよう フィヨルドの課題でつくるnpmがOSSのはずだけど、知り合いのじゃない方がいいのかしら

[unikounio]

RubyのOSSの探し方例

• 自分がつくったRailsアプリのGemを一つ選んで見に行く

[unikounio]

Toggle Trackを見に行ってみる。 https://toggl.com/

[otegami]

^Google Chrome の拡張機能を見る流れから

[otegami]

https://github.com/toggl/track-extension

[unikounio]

GitHubのStarが100未満くらいのOSSを探す

[unikounio]

npmをつくったときの依存ライブラリを確認してみる

[otegami]

https://github.com/unikounio/capital-city-quiz

[unikounio]

countries-list - npmを確認中

[unikounio]

minimistjs/minimist: parse argument optionsのREADMEにes-module形式が記載されていないかも（otegamiさんが気づいてくださった！）

[unikounio]

スクールの学習で利用したGemを確認中

[unikounio]

minimistを触ってみる！ https://github.com/minimistjs/minimist

[unikounio]

READMEのコピペだとファイル名がひっかかってエラーになってしまう

[otegami]

ライセンスの確認をするのを一緒に確認するのを失念していましたmm

• https://opensource.org/licenses

[unikounio]

現在報告したいこと

• READMEが手順通りに動くようにする
• es-module形式の例示を追加する

[unikounio]

どこに入力すべきコマンド／コードなのかがわかりにくい。 各コードブロックの手前に「JavaScriptのファイルに記述する」「コマンドラインに入力する」等の案内があった方がよさそう。

[unikounio]

ES Module形式の例示を追加するIssueを立てる方向で進めていく。

[unikounio]

似たIssueはなさそう。 ES Moduleのサポートに言及しているIssueはあったけど、READMEの修正ではないよう。 https://github.com/minimistjs/minimist/issues/58

[otegami]

ES Module 形式で利用していそうな記述を発見

• https://github.com/minimistjs/minimist/issues/59#issuecomment-1933052800

[unikounio]

報告のルールも特になさそう。 Issueのテンプレートもなし。

[otegami]

ES Module 形式で動くサンプルコードを書いてみる

[otegami]

# ./example/parse.rb

[unikounio]

ES Modules形式サンプルコードをREADMEのexampleに追加するのはいかがでしょうか。 初学者がES Modules形式で利用しようとした際に説明がなくて困ったため。 以下に例を示させていただきます。実行結果は確認済みです。 ※Node.js バージョン20.9.0で実行

CommonJS

// ./example/parse.js
var argv = require('minimist')(process.argv.slice(2));
console.log(argv);

$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz
{
    _: ['foo', 'bar', 'baz'],
    x: 3,
    y: 4,
    n: 5,
    a: true,
    b: true,
    c: true,
    beep: 'boop',
    ding: false
}

ES Modules

// ./example/parse.mjs
import minimist from "minimist";
const argv = minimist(process.argv.slice(2));
console.log(argv);

$ node example/parse.mjs -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.mjs -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz
{
    _: ['foo', 'bar', 'baz'],
    x: 3,
    y: 4,
    n: 5,
    a: true,
    b: true,
    c: true,
    beep: 'boop',
    ding: false
}

[unikounio]

日本語での報告文が概ねできあがったので、英文にしていく。

[unikounio]

How about adding ES Modules format sample code to the examples in the README? Beginners might be confused when there are no sample codes in the ES Modules format. I will show an example below. The execution result has been confirmed. Executed with Node.js version 20.9.0

CommonJS

// ./example/parse.js
var argv = require('minimist')(process.argv.slice(2));
console.log(argv);

$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz
{
    _: ['foo', 'bar', 'baz'],
    x: 3,
    y: 4,
    n: 5,
    a: true,
    b: true,
    c: true,
    beep: 'boop',
    ding: false
}

ES Modules

// ./example/parse.mjs
import minimist from "minimist";
const argv = minimist(process.argv.slice(2));
console.log(argv);

$ node example/parse.mjs -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.mjs -x 3 -y 4 -n5 -abc --beep=boop --no-ding foo bar baz
{
    _: ['foo', 'bar', 'baz'],
    x: 3,
    y: 4,
    n: 5,
    a: true,
    b: true,
    c: true,
    beep: 'boop',
    ding: false
}

[unikounio]

otegamiさんの助けを借りて英文が完成！ いざ報告

[otegami]

I am a beginner and I had a problem because there was no explanation when I tried to use the ES Modules format.

Beginners might be confused when there are no sample codes in the ES Modules format.

[unikounio]

【タイトル】 READMEのexampleにES Modules形式のサンプルコードを追加したい

[unikounio]

【Title】 Docs: Add sample code ES Modules format to the examples in the README.

[unikounio]

以下のような文章を追加したい。

• Issueを受け入れてくださった場合、私がPRをつくりますよ。

[unikounio]

If you accept my idea, I will create a PR.

[unikounio]

Issueを立てられた！！ https://github.com/minimistjs/minimist/issues/61

[github-actions[bot]]

おつかれさまでした！

ワークショップの終了にともないissueを閉じますが、このまま作業メモとして使っても構いません :ok_hand:

ワークショップの感想を集めています！

ブログなどに書かれた際は、このページへリンクの追加をお願いします :pray:

またの参加をお待ちしています！

[otegami]

@unikounio 昨日はお疲れ様でした。 Issue にメンテナーから返信が来ていたのでお時間のある時に返信して対応してあげると良さそうに思います！

[unikounio]

@otegami さん 一昨日はありがとうございました！ メンテナーさんお二人ともご対応が早くて嬉しいです😄 対応させていただきます～

[otegami]

@unikounio メンテナーさんからのコメントにリアクションだけではなくコメントで反応しておくと良さそうに思います。 リアクションだけだと次 PR をつくるまで対応してくれるのかな？などメンテナーさんが不安になっちゃうかなとおもったためです。

[unikounio]

@otegami さん お疲れ様です！ ご協力いただいたminimistのIssueについて、先ほど関連PRがマージされました！ otegamiさんにお力添えいただいたおかげで、貴重な経験ができました！ ありがとうございました～🙏✨

[otegami]

@unikounio おめでとうございます🎉