ClojureScriptでコマンドライン・スクリプトを書く

本記事は、原著者の許諾のもと、翻訳・掲載しています。 Command line scripting with ClojureScript / akiroz

ClojureScriptコミュニティによる開発のおかげで、コマンドライン・スクリプトをClojureで書くのが楽しくなってきました。ClojureScriptの中心チームとlumoを開発しているanmonteiroさんには、心から敬意を表します。

Clojureは、データを処理するための短いスクリプトを書くのに良い言語だと思います。操作用の関数やイミュータブルな構造が言語に組み込まれているので、参照性やdeep-cloningについて心配する必要がありません。

Lumoでスクリプトを起動する

では、始めるために簡単な方法を紹介します。lumoをシステムにインストールして、Clojureのファイルを起動します。hello.cljsという名前でファイルを作り、次のように編集して保存してください。

(println "Hello World!")

では、次のように実行してみましょう。

$ npm i -g lumo-cljs # lumoをインストールする
$ lumo hello.cljs
Hello World!

簡単でしょう？では次は、より実用的なプログラムを書くために、Node.jsのAPIを利用する方法を紹介します。

;; 次のプログラムでは、https://randomuser.meで生成されたjsonのペイロードをパーズして、
;; データの一部を抽出します。予め、次のコマンドでデータをダウンロードしてください。
;; $ wget 'https://randomuser.me/api/?results=10' -O randomUsers.json

;; 注: シングルクォートをお忘れなく
(require
  '[clojure.string :refer [capitalize]]   ;; Clojureのライブラリをrequireします
  '[fs :refer [writeFileSync]]            ;; Node.JSのfilesystem関連のモジュールをrequireします
  '["./randomUsers.json" :as input-json]  ;; JSONファイルをJSのデータとしてrequireします
  )

(defn parse-user
  [{:keys [email name]
    {:keys [username password]} :login}]
  {:id         (str (random-uuid)) ;; built-in
   :username   username
   :password   password
   :email      email
   :full-name  (str (capitalize (:first name))
                    " "
                    (capitalize (:last name)))
   })

(let [results (:results (js->clj input-json :keywordize-keys true))]
  (writeFileSync
    "randomUsers.edn"
    (pr-str (mapv parse-user results))))

ご覧の通り、このrequire関数は、JSのrequire関数と同じように動作します。次のようにすることと同じです。

const { writeFileSync } = require('fs');
const inputJson = require('./randomUsers.json');

npmからインストールされるnode_modulesにあるモジュールとも上手く動作します(現状lumo1.8.0)。残念ながら、Clojure側の依存関係を管理する簡単な方法はありません。現状は、Clojureのライブラリが収められるjarファイルを手動で管理する必要があります。詳しくは、lumoのWikiを参考にしてください。

npmとの連携

少し大きなプロジェクトのためには、npmで依存関係を管理するために、package.jsonを使いたいでしょう。もしlumoをグローバル環境にインストールしたくなければ、lumoをプロジェクト内だけにインストールすることもできます。

次の例では、上の例と同様に動作します。NPMにあるrequestのライブラリを使ってJSONをhttps://randomuser.me から取得します。先ほどのコードを、適切に名前空間をつけて、2つのClojureScriptのファイルに分割します。

my-tool
|\_ package.json
 \_ src
     \_ my_tool
        |\_ core.cljs
         \_ user.cljs

Clojureの名前空間のシステムは、ディレクトリ構造を反映するので、my-tool.coreは、my_tool/core.cljsでなければいけません。名前空間でハイフンで区切られた名前は、ファイルシステムではsnake_caseに変換されなければいけません。

core.cljs:

(ns my-tool.core
  (:require [my-tool.user :as user]
            [fs :refer [writeFileSync]]
            ;; request library from npm, since the imported name
            ;; is the same as the package name, :as isn't needed.
            ;; const request = require('request');
            [request]))

;; The -main function is called by lumo with CLI args
(defn -main [n]
  (request
    #js{:url (str "https://randomuser.me/api/?results=" n)
        :json true}
    (fn [_ _ body]
      (let [results (:results (js->clj body :keywordize-keys true))]
        (writeFileSync
          "randomUsers.edn"
          (pr-str (mapv user/parse results)))))))

user.cljs:

(ns my-tool.user
  (:require [clojure.string :refer [capitalize]]))

(defn parse
  [{:keys [email name]
    {:keys [username password]} :login
    }]
  {:id         (str (random-uuid))
   :username   username
   :password   password
   :email      email
   :full-name  (str (capitalize (:first name))
                    " "
                    (capitalize (:last name)))
   })

package.json:

{
  "name": "my-tool",
  "version": "1.0.0",
  "scripts": {
    "start": "lumo -c src -m my-tool.core"
  },
  "dependencies": {
    "lumo-cljs": "^1.8.0",
    "request": "^2.85.0"
  }
}

package.json内の"script"の行をご覧ください。

-cフラグは、lumoに対して、あなたのソースコードがどこにあるのかを知らせます。

-mフラグは、あなたの-main関数がどの名詞空間にあるのかを特定します。

ではこのツールをnpmを使って起動してみましょう。

$ npm install
$ npm start 12 ## 12人のユーザを取得して、randomUsers.ednを出力します

REPLでの開発

Clojureを経験するのに、REPLを元にしたインタラクティブな開発なしには終われません。 package.jsonのscriptsセクションに次の行を足してください。

"repl": "lumo -c src -i src/my_tool/core.cljs -n 5777 -r"

-iフラグは、core.cljsを起点にREPLを初期化します。

-nフラグは、portを5777番でソケットのREPLを開始します。

-rフラグは、ターミナルでREPLを起動します。

このようにしてREPLを開始することで、状態(state)を失うことなく、任意のコードをあなたのランタイムで実行できます。

$ npm run repl
...
cljs.user=> (in-ns 'my-tool.core) ;; switch to our core namespace
my-tool.core=> (user/parse {:name {:first "john" :last "smith"}})
{:id "c1b61773-133e-434c-afbd-d82b95b814d3",
 :username nil,
 :password nil,
 :email nil,
:full-name "John Smith"}

さいごに

現状でのツールには荒い点がいくつかありますが、Clojureでコマンドラインスクリプトを書き始めるのも、選択肢の1つにあげてもいい時期にきています。Lumoの起動時間は、Clojureが起動する時間と比べてはるかに早いので、新鮮な感じがすると思います。

もしClojureが好きならば、この記事の内容を試してみてください。