Haskell Day 2018 の発表資料

1. Haskell で CLI
@matsubara0507

2. 新しくプログラミング言語を学んだ
ら何をするか？

3. コマンドを作りますね！

4. Agenda
1. コマンドライン引数
2. Alt. Prelude: RIO
3. Stack Template

5. コマンドライン引数

6. Haskell でコマンドライン引数
他にもたくさんあるけど、例えば
System.Environment.getArgs
System.Console.GetOpt
optparse-applicative

7. System.Environment.getArgs
base パッケージにある関数
getLine や getEnv のような他の IO 系と同じように扱
える
-- getArgs :: IO [String]
import System.Environment (getArgs)
main :: IO ()
main = do
args <- getArgs
print $ "Hi, " ++ head args
しかし，ただの空白区切

8. System.Console.GetOpt
これも base にある
getArgs で得た文字列を特定の型に変換してくれる．
getOpt
:: ArgOrder a -- ^ non-opts な文字列の取り扱い方
-> [OptDescr a] -- ^ opts な文字列の扱い方
-> [String] -- ^ getArgs などで得た文字列
-> ([a], [String], [String])
返り値の型は (オプションの型, non-opts な文字列, エラー)
(細かい説明は割愛)

9. System.Console.GetOpt の使用例
import System.Console.GetOpt
main :: IO ()
main = do
args <- getArgs
let (opts, rest, err) = getOpt Permute options args
print opts
data Flag = Verbose | Version deriving (Show, Eq)
options :: [OptDescr Flag]
options =
[ Option ['v'] ["verbose"] (NoArg Verbose) "..."
, Option ['V'] ["version"] (NoArg Version) "..."
]

10. optparse-applicative
というパッケージ，よりリッチな事がたくさんできる
stack でも使われている（実質サンプル置き場）
少し使い方が難しいので，簡単にしたラッパーライブ
ラリがたくさんある
optparse­applicative­simple
optparse­generic
optparse­helper
optparse­simple

11. optparse-applicative の使用例
import Options.Applicative
main :: IO ()
main = print =<< execParser options
where
opts = sample `withInfo` "Print a greeting for TARGET"
data Sample = Sample { hello :: String, verbose :: Bool }
sample :: Parser Sample
sample = Sample
<$> strOption ( long "hello" <> help ".." )
<*> switch ( long "verbose" <> short 'v' <> help ".." )
withInfo :: Parser a -> String -> ParserInfo a
withInfo opts = info (helper <*> opts) . progDesc

12. optparse-applicative でサブコマンド
(おまけ話？本題？)
なんか ToDo タスクを処理できそうなサブコマンドの
型
data SubCmd
= NewCmd
| AddCmd Int Text
| DoneCmd Int
| ListCmd
deriving (Show, Eq)

13. optparse-applicative でサブコマンド
サブコマンドのパーサー
subcmdParser :: Parser SubCmd
subcmdParser = subparser
$ command "new" (pure NewCmd `withInfo` "...")
<> command "add" (AddCmd <$> ... `withInfo` "...")
<> command "done" (DoneCmd <$> ... `withInfo` "...")
<> command "list" (pure ListCmd `withInfo` "...")
hoge new とか hoge add ってサブコマンドになる
Semigroup の結合( <> )しかしてないんで網羅性チェッ
クは無理

14. 拡張可能バリアントの導入
extensible というパッケージを使います
type SubCmd = Variant
'[ "new" >: ()
, "add" >: (Int, Text)
, "done" >: Int
, "list" >: ()
]
(extensible については wiki を参照してください)

15. 拡張可能バリアントの導入
これで網羅性のチェックをしてくれるし、
ついでにサブコマンド文字列も自動で導出
subcmdParser :: Parser SubCmd
subcmdParser = variantFrom -- `variantFrom` 関数は自作
$ #new @= (pure () `withInfo` "...")
<: #add @= (... `withInfo` "...")
<: #done @= (... `withInfo` "...")
<: #list @= (pure () `withInfo` "...")
<: nil
詳しくは: オレ的 Haskell で CLI を作る方法 2018 ­
ひげメモ の extensible で optparse­applicative

16. 拡張可能バリアントの導入
variantFrom ::
Forall (KeyIs KnownSymbol) xs =>
RecordOf ParserInfo xs -> Parser (Variant xs)
variantFrom = subparser . subcmdVariant
where
subcmdVariant =
hfoldMapWithIndexFor (Proxy @ (KeyIs KnownSymbol))
$ m x ->
let k = symbolVal (proxyAssocKey m)
in command k
((EmbedAt m . Field . pure) <$> getField x)
instance Wrapper ParserInfo where
type Repr ParserInfo a = ParserInfo a
_Wrapper = id

17. Alt. Prelude

18. Haskell の標準ライブラリ
(Haskell というか GHC というか)
base という名前
Prelude というモジュールが標準インポート
NoImplicitPrelude プラグマでオフにできる

19. 標準ライブラリの代替
昔，Haskell­jp Slack で話題に上がった
slack­link (いずれなくなると思う)
classy­prelude
universum
rio
protolude
などなど

20. RIO ライブラリ
stack を開発しているチームが開発している
彼らのベストプラクティスをを詰め込んである
大域環境・ログ・エラーハンドリング
よく使うライブラリのラッパー
text , bytestring , directory , filepath
containers , lens , time , vector
などなど

21. RIO ライブラリの使用例
run :: RIO Env () -> Options -> IO ()
run cmd opts = do
token <- liftIO $ getEnv "MEDIUM_TOKEN"
logOpts <- logOptionsHandle stdout (opts ^. #verbose)
withLogFunc logOpts $ logger -> do
let env = #logger @= logger
<: #token @= fromString token
<: nil
runRIO env cmd
callMeAPI :: RIO Env ()
callMeAPI = do
logDebug "Run cmd: call me api"
token <- asks (view #token)
user <- API.getMe token
logDebug $ display ("get: " <> tshow user)
logInfo $ display ("Hi " <> user ^. #name <> "!!")

22. 実行してみる
$ mdium --version
Version 0.2.0.0, Git revision
efcf1856b6b065141a6d366663b97b0301053ffd (23 commits)
$ mdium --verbose --me
2018-11-10 10:28:53.049919: [debug] Run cmd: call me api
@(src/Mdium/Cmd/Run.hs:57:3)
2018-11-10 10:28:54.721968: [debug] get: id @= "..." <:
username @= "nobutada" <: name @= "matsubara" <: url @=
"https://medium.com/@nobutada" <: imageUrl @= ".." <: nil
@(src/Mdium/Cmd/Run.hs:60:3)
2018-11-10 10:28:54.722133: [info] Hi matsubara!!
@(src/Mdium/Cmd/Run.hs:61:3)

23. Stack Template

24. Haskell Stack
Haskell のビルドツール
処理系自体は GHC
プロジェクト内の各パッケージのバージョン管理
などなど
$ stack new sample hoge-template
$ cd sample-project
$ stack build
$ stack exec -- application

25. stack new の後がパターン化
stack new した後に各基本的なコードが同じ
よく使うパッケージを package.yaml に追加
コマンドライン引数の処理する部分を追加
などなど
これを「オレオレテンプレート化」できる

26. 自作テンプレートの例 (hsfiles)
{-# START_FILE package.yaml #-}
name: {{name}}
version: 0.1.0.0
homepage: https://github.com/{{github-username}}/{{name}}
...
dependencies:
- base >= 4.7 && < 5
- rio >= 0.1.1.0
- extensible >= 0.4.9
- yaml
...
{-# START_FILE app/Main.hs #-}
module Main where
import RIO
import Data.Extensible
...

27. 公開できる！
今まではテンプレートファイルを特定のローカルパス
に置く必要があった．
stack­1.9 から GitHub, GitLab, BitBucket のリポジト
リから取得できる．
$ stack new sample github:matsubara0507/hoge.hsfiles
詳しくは: namespaced templates ­ BIG MOON

28. こんな感じ

29. おまけ: stack­tpls
matsubara0507/stack­tpls ­ GitHub
公開されているテンプレートを取得するコマンド
(まだ GitHub にしか対応していない...)
$ stack-tpls -l
github:commercialhaskell/chrisdone.hsfiles
github:commercialhaskell/foundation.hsfiles
github:commercialhaskell/franklinchen.hsfiles
github:commercialhaskell/ghcjs-old-base.hsfiles
github:commercialhaskell/ghcjs.hsfiles
github:commercialhaskell/hakyll-template.hsfiles
...

30. まとめ
コマンドライン引数の取得方法はいろいろ
単純なものからリッチなものまで
標準ライブラリや Prelude が微妙と思い始めたら
Alt. Prelude を探そう
オレオレプラクティスやパターンが出てきたらテ
ンプレート化しよう
(stack­tpls 使ってみて)

31. おしまい