terminal/src/Main.hs · elk

git.iko.soy/elk

on f4401ac help sign in

elk/terminal/src/Main.hs

338 lines 10 kB history raw

1{-# LANGUAGE OverloadedStrings #-}

2module Main

3 ( main

4 )

5 where

8import Prelude hiding (init)

9import qualified Data.List as List

10import qualified Text.PrettyPrint.ANSI.Leijen as P

11import Text.PrettyPrint.ANSI.Leijen ((<>))

12import Text.Read (readMaybe)

14import qualified Elm.Version as V

15import Terminal.Args

16import Terminal.Args.Helpers

18import qualified Bump

19import qualified Develop

20import qualified Diff

21import qualified Init

22import qualified Install

23import qualified Make

24import qualified Publish

25import qualified Repl

29-- MAIN

32main :: IO ()

33main =

34 complex intro outro

35 [ repl

36 , init

37 , reactor

38 , make

39 , install

40 , bump

41 , diff

42 , publish

43 ]

46intro :: P.Doc

47intro =

48 P.vcat

49 [ P.fillSep

50 ["Hi,","thank","you","for","trying","out"

51 ,P.green "Elm"

52 ,P.green (P.text (V.toChars V.compiler)) <> "."

53 ,"I hope you like it!"

54 ]

55 , ""

56 , P.black "-------------------------------------------------------------------------------"

57 , P.black "I highly recommend working through <https://guide.elm-lang.org> to get started."

58 , P.black "It teaches many important concepts, including how to use `elm` in the terminal."

59 , P.black "-------------------------------------------------------------------------------"

60 ]

63outro :: P.Doc

64outro =

65 P.fillSep $ map P.text $ words $

66 "Be sure to ask on the Elm slack if you run into trouble! Folks are friendly and\

67 \ happy to help out. They hang out there because it is fun, so be kind to get the\

68 \ best results!"

72-- INIT

75init :: Interface

76init =

77 let

78 summary =

79 "Start an Elm project. It creates a starter elm.json file and\

80 \ provides a link explaining what to do from there."

82 details =

83 "The `init` command helps start Elm projects:"

85 example =

86 reflow

87 "It will ask permission to create an elm.json file, the one thing common\

88 \ to all Elm projects. It also provides a link explaining what to do from there."

89 in

90 Interface "init" (Common summary) details example noArgs noFlags Init.run

94-- REPL

97repl :: Interface

98repl =

99 let

100 summary =

101 "Open up an interactive programming session. Type in Elm expressions\

102 \ like (2 + 2) or (String.length \"test\") and see if they equal four!"

103

104 details =

105 "The `repl` command opens up an interactive programming session:"

106

107 example =

108 reflow

109 "Start working through <https://guide.elm-lang.org> to learn how to use this!\

110 \ It has a whole chapter that uses the REPL for everything, so that is probably\

111 \ the quickest way to get started."

112

113 replFlags =

114 flags Repl.Flags

115 |-- flag "interpreter" interpreter "Path to a alternate JS interpreter, like node or nodejs."

116 |-- onOff "no-colors" "Turn off the colors in the REPL. This can help if you are having trouble reading the values. Some terminals use a custom color scheme that diverges significantly from the standard ANSI colors, so another path may be to pick a more standard color scheme."

117 in

118 Interface "repl" (Common summary) details example noArgs replFlags Repl.run

119

120

121interpreter :: Parser String

122interpreter =

123 Parser

124 { _singular = "interpreter"

125 , _plural = "interpreters"

126 , _parser = Just

127 , _suggest = \_ -> return []

128 , _examples = \_ -> return ["node","nodejs"]

129 }

133-- REACTOR

136reactor :: Interface

137reactor =

138 let

139 summary =

140 "Compile code with a click. It opens a file viewer in your browser, and\

141 \ when you click on an Elm file, it compiles and you see the result."

142

143 details =

144 "The `reactor` command starts a local server on your computer:"

145

146 example =

147 reflow

148 "After running that command, you would have a server at <http://localhost:8000>\

149 \ that helps with development. It shows your files like a file viewer. If you\

150 \ click on an Elm file, it will compile it for you! And you can just press\

151 \ the refresh button in the browser to recompile things."

152

153 reactorFlags =

154 flags Develop.Flags

155 |-- flag "port" port_ "The port of the server (default: 8000)"

156 in

157 Interface "reactor" (Common summary) details example noArgs reactorFlags Develop.run

158

159

160port_ :: Parser Int

161port_ =

162 Parser

163 { _singular = "port"

164 , _plural = "ports"

165 , _parser = readMaybe

166 , _suggest = \_ -> return []

167 , _examples = \_ -> return ["3000","8000"]

168 }

172-- MAKE

175make :: Interface

176make =

177 let

178 details =

179 "The `make` command compiles Elm code into JS or HTML:"

180

181 example =

182 stack

183 [ reflow

184 "For example:"

185 , P.indent 4 $ P.green "elm make src/Main.elm"

186 , reflow

187 "This tries to compile an Elm file named src/Main.elm, putting the resulting\

188 \ JavaScript code in an elm.js file."

189 ]

190

191 makeFlags =

192 flags Make.Flags

193 |-- onOff "debug" "Turn on the time-travelling debugger. It allows you to rewind and replay events. The events can be imported/exported into a file, which makes for very precise bug reports!"

194 |-- onOff "optimize" "Turn on optimizations to make code smaller and faster. For example, the compiler renames record fields to be as short as possible and unboxes values to reduce allocation."

195 |-- flag "output" Make.output "Specify the name of the resulting JS file. For example --output=assets/elm.js to generate the JS at assets/elm.js or --output=/dev/null to generate no output at all!"

196 |-- flag "report" Make.reportType "You can say --report=json to get error messages as JSON. This is only really useful if you are an editor plugin. Humans should avoid it!"

197 |-- flag "docs" Make.docsFile "Generate a JSON file of documentation for a package. Eventually it will be possible to preview docs with `reactor` because it is quite hard to deal with these JSON files directly."

198 in

199 Interface "make" Uncommon details example (zeroOrMore elmFile) makeFlags Make.run

203-- INSTALL

206install :: Interface

207install =

208 let

209 details =