このブログみたいにNext.jsやGatsbyなどJSの静的サイトジェネレータで、マークダウンでテンプレートからコンテンツを素早く書き始められるcliを作り、npm module として公開した。

使い方は簡単。1行のコマンドで設定からファイルを生成。npm.cofig.jsでmdを自作のテンプレに設定できる。今日の日付(date) も組み込める。

npm run mdg today_whether
# => create blog/2021-4-14-today_whether.md

こちら: @shuent/markdown-generator

初めてnpmモジュールを作成して公開するにあたり、学んだこと、ハマったことをいったん箇条書きで全部書く。需要があればコードと共に解説する。

• node.jsはCommonJSで基本動く。
  • const hoge = require('hoge') とモジュールを宣言する。
  • module.exportsとしてモジュールをエクスポートする。
  • importなどは使うのに工夫がいる。Babelでトランスパイラする。今回はやらず。
• ユーザー定義の設定ファイルどこで設定するか迷った結果
  • app-root-pathでプロジェクトルートパスにアクセスできる
    • しかし、ローカルでテスト用のプロジェクトを作り読み込むと link されるため、app-root-pathが開発中のモジュールのルートを参照してしまう
      • 公開してから読み込んでみるしかない。テストできない。困った。
• testを書いた。
  • 基本的にentry point(index.js)に全部実装してしまったので、module.exportsしていない関数をテストできない。
  • よってロジックファイルだけを切り出し。
  • mochaとNode.js標準のモジュール assert.strictEqualを使用。
  • rewire が有能
    • エクスポートしていない関数__get__で呼び出し、テストできる
    • 内部の関数をモックできる__set__を使う
    • ローカルで成功したテストがgithub actionsでは失敗した。パスの問題ぽい。
      • 今回はスルー。すみませんという気持ち。今度格闘する。
• cli として機能させるために
  • index.jsの行頭に #! /usr/bin/env node と書く。
  • package.json内で "bin": { "mdg": "index.js" } とする
    • すると node_module/.bin/mdg で実行できる。
• その他Javascriptに関して
  • {} === {}がfalse. これは衝撃。
    • isEqual(obj)という関数を作ってオブジェクトの空判定をした。
    • テストファイルを作ってから判明したので、テストは大事だった。

初めてOSSとして公開したので、いい経験になった。自分が欲しいものを作るに限る。反応があればもっと cli らしくオプションを入力できたりコマンドを増やしたりしたい。