1{-# OPTIONS_GHC -Wall #-}
2{-# LANGUAGE OverloadedStrings #-}
3module Reporting.Error.Syntax
47import Prelude hiding (Char, String)
48import qualified Data.Char as Char
49import qualified Data.Name as Name
50import Data.Word (Word16)
51import Numeric (showHex)
53import qualified Elm.ModuleName as ModuleName
54import Parse.Primitives (Row, Col)
55import Parse.Symbol (BadOperator(..))
56import qualified Reporting.Annotation as A
57import qualified Reporting.Doc as D
58import qualified Reporting.Report as Report
59import qualified Reporting.Render.Code as Code
67 = ModuleNameUnspecified ModuleName.Raw
68 | ModuleNameMismatch ModuleName.Raw (A.Located ModuleName.Raw)
69 | UnexpectedPort A.Region
79 = ModuleSpace Space Row Col
80 | ModuleEndOfFile Row Col
82 | ModuleProblem Row Col
84 | ModuleExposing Exposing Row Col
86 | PortModuleProblem Row Col
87 | PortModuleName Row Col
88 | PortModuleExposing Exposing Row Col
98 | ImportExposing Row Col
99 | ImportExposingList Exposing Row Col
100 | ImportEnd Row Col -- different based on col=1 or if greater
102 | ImportIndentName Row Col
103 | ImportIndentAlias Row Col
104 | ImportIndentExposingList Row Col
108 | Declarations Decl Row Col
112 = ExposingSpace Space Row Col
113 | ExposingStart Row Col
114 | ExposingValue Row Col
115 | ExposingOperator Row Col
116 | ExposingOperatorReserved BadOperator Row Col
117 | ExposingOperatorRightParen Row Col
118 | ExposingTypePrivacy Row Col
119 | ExposingEnd Row Col
121 | ExposingIndentEnd Row Col
122 | ExposingIndentValue Row Col
131 | DeclSpace Space Row Col
134 | DeclType DeclType Row Col
135 | DeclDef Name.Name DeclDef Row Col
137 | DeclFreshLineAfterDocComment Row Col
141 = DeclDefSpace Space Row Col
142 | DeclDefEquals Row Col
143 | DeclDefType Type Row Col
144 | DeclDefArg Pattern Row Col
145 | DeclDefBody Expr Row Col
146 | DeclDefNameRepeat Row Col
147 | DeclDefNameMatch Name.Name Row Col
149 | DeclDefIndentType Row Col
150 | DeclDefIndentEquals Row Col
151 | DeclDefIndentBody Row Col
155 = PortSpace Space Row Col
158 | PortType Type Row Col
159 | PortIndentName Row Col
160 | PortIndentColon Row Col
161 | PortIndentType Row Col
169 = DT_Space Space Row Col
171 | DT_Alias TypeAlias Row Col
172 | DT_Union CustomType Row Col
174 | DT_IndentName Row Col
178 = AliasSpace Space Row Col
180 | AliasEquals Row Col
181 | AliasBody Type Row Col
183 | AliasIndentEquals Row Col
184 | AliasIndentBody Row Col
188 = CT_Space Space Row Col
193 | CT_VariantArg Type Row Col
195 | CT_IndentEquals Row Col
196 | CT_IndentBar Row Col
197 | CT_IndentAfterBar Row Col
198 | CT_IndentAfterEquals Row Col
210 | Record Record Row Col
211 | Tuple Tuple Row Col
216 | OperatorRight Name.Name Row Col
217 | OperatorReserved BadOperator Row Col
221 | String String Row Col
222 | Number Number Row Col
223 | Space Space Row Col
224 | EndlessShader Row Col
225 | ShaderProblem [Char.Char] Row Col
226 | IndentOperatorRight Name.Name Row Col
227 | IndentMoreExpr Row Col
233 | RecordField Row Col
234 | RecordEquals Row Col
235 | RecordExpr Expr Row Col
236 | RecordSpace Space Row Col
238 | RecordIndentOpen Row Col
239 | RecordIndentEnd Row Col
240 | RecordIndentField Row Col
241 | RecordIndentEquals Row Col
242 | RecordIndentExpr Row Col
246 = TupleExpr Expr Row Col
247 | TupleSpace Space Row Col
249 | TupleOperatorClose Row Col
250 | TupleOperatorReserved BadOperator Row Col
252 | TupleIndentExpr1 Row Col
253 | TupleIndentExprN Row Col
254 | TupleIndentEnd Row Col
258 = ListSpace Space Row Col
260 | ListExpr Expr Row Col
263 | ListIndentOpen Row Col
264 | ListIndentEnd Row Col
265 | ListIndentExpr Row Col
269 = FuncSpace Space Row Col
270 | FuncArg Pattern Row Col
271 | FuncBody Expr Row Col
274 | FuncIndentArg Row Col
275 | FuncIndentArrow Row Col
276 | FuncIndentBody Row Col
280 = CaseSpace Space Row Col
282 | CasePattern Pattern Row Col
284 | CaseExpr Expr Row Col
285 | CaseBranch Expr Row Col
287 | CaseIndentOf Row Col
288 | CaseIndentExpr Row Col
289 | CaseIndentPattern Row Col
290 | CaseIndentArrow Row Col
291 | CaseIndentBranch Row Col
292 | CasePatternAlignment Word16 Row Col
296 = IfSpace Space Row Col
299 | IfElseBranchStart Row Col
301 | IfCondition Expr Row Col
302 | IfThenBranch Expr Row Col
303 | IfElseBranch Expr Row Col
305 | IfIndentCondition Row Col
306 | IfIndentThen Row Col
307 | IfIndentThenBranch Row Col
308 | IfIndentElseBranch Row Col
309 | IfIndentElse Row Col
313 = LetSpace Space Row Col
315 | LetDefAlignment Word16 Row Col
317 | LetDef Name.Name Def Row Col
318 | LetDestruct Destruct Row Col
319 | LetBody Expr Row Col
320 | LetIndentDef Row Col
321 | LetIndentIn Row Col
322 | LetIndentBody Row Col
326 = DefSpace Space Row Col
327 | DefType Type Row Col
328 | DefNameRepeat Row Col
329 | DefNameMatch Name.Name Row Col
330 | DefArg Pattern Row Col
332 | DefBody Expr Row Col
333 | DefIndentEquals Row Col
334 | DefIndentType Row Col
335 | DefIndentBody Row Col
336 | DefAlignment Word16 Row Col
340 = DestructSpace Space Row Col
341 | DestructPattern Pattern Row Col
342 | DestructEquals Row Col
343 | DestructBody Expr Row Col
344 | DestructIndentEquals Row Col
345 | DestructIndentBody Row Col
353 = PRecord PRecord Row Col
354 | PTuple PTuple Row Col
355 | PList PList Row Col
359 | PString String Row Col
360 | PNumber Number Row Col
361 | PFloat Word16 Row Col
363 | PWildcardNotVar Name.Name Int Row Col
364 | PSpace Space Row Col
366 | PIndentStart Row Col
367 | PIndentAlias Row Col
371 = PRecordOpen Row Col
373 | PRecordField Row Col
374 | PRecordSpace Space Row Col
376 | PRecordIndentOpen Row Col
377 | PRecordIndentEnd Row Col
378 | PRecordIndentField Row Col
384 | PTupleExpr Pattern Row Col
385 | PTupleSpace Space Row Col
387 | PTupleIndentEnd Row Col
388 | PTupleIndentExpr1 Row Col
389 | PTupleIndentExprN Row Col
395 | PListExpr Pattern Row Col
396 | PListSpace Space Row Col
398 | PListIndentOpen Row Col
399 | PListIndentEnd Row Col
400 | PListIndentExpr Row Col
408 = TRecord TRecord Row Col
409 | TTuple TTuple Row Col
412 | TSpace Space Row Col
414 | TIndentStart Row Col
418 = TRecordOpen Row Col
421 | TRecordField Row Col
422 | TRecordColon Row Col
423 | TRecordType Type Row Col
425 | TRecordSpace Space Row Col
427 | TRecordIndentOpen Row Col
428 | TRecordIndentField Row Col
429 | TRecordIndentColon Row Col
430 | TRecordIndentType Row Col
431 | TRecordIndentEnd Row Col
437 | TTupleType Type Row Col
438 | TTupleSpace Space Row Col
440 | TTupleIndentType1 Row Col
441 | TTupleIndentTypeN Row Col
442 | TTupleIndentEnd Row Col
452 | CharNotString Word16
456 = StringEndless_Single
457 | StringEndless_Multi
458 | StringEscape Escape
463 | BadUnicodeFormat Word16
464 | BadUnicodeCode Word16
465 | BadUnicodeLength Word16 Int Int
472 | NumberNoLeadingZero
481 | EndlessMultiComment
488toReport :: Code.Source -> Error -> Report.Report
491 ModuleNameUnspecified name ->
493 region = toRegion 1 1
495 Report.Report "MODULE NAME MISSING" region [] $
498 "I need the module name to be declared at the top of this file, like this:"
499 , D.indent 4 $ D.fillSep $
500 [ D.cyan "module", D.fromName name, D.cyan "exposing", "(..)" ]
502 "Try adding that as the first line of your file!"
504 "It is best to replace (..) with an explicit list of types and\
505 \ functions you want to expose. When you know a value is only used\
506 \ within this module, you can refactor without worrying about uses\
507 \ elsewhere. Limiting exposed values can also speed up compilation\
508 \ because I can skip a bunch of work if I see that the exposed API\
512 ModuleNameMismatch expectedName (A.At region actualName) ->
513 Report.Report "MODULE NAME MISMATCH" region [ModuleName.toChars expectedName] $
514 Code.toSnippet source region Nothing
516 "It looks like this module name is out of sync:"
520 "I need it to match the file path, so I was expecting it to see `"
521 ++ ModuleName.toChars expectedName
522 ++ "` here. Make the following change, and you should be all set!"
524 D.dullyellow (D.fromName actualName) <> " -> " <> D.green (D.fromName expectedName)
526 "I require that module names correspond to file paths. This makes it much\
527 \ easier to explore unfamiliar codebases! So if you want to keep the current\
528 \ module name, try renaming the file instead."
532 UnexpectedPort region ->
533 Report.Report "UNEXPECTED PORTS" region [] $
534 Code.toSnippet source region Nothing
537 "You are declaring ports in a normal module."
541 ["Switch","this","to","say",D.cyan "port module","instead,"
542 ,"marking","that","this","module","contains","port","declarations."
545 "Ports are not a traditional FFI for calling JS functions directly. They need a different mindset! Read"
547 "to learn the syntax and how to use it effectively."
552 Report.Report "NO PORTS" region [] $
553 Code.toSnippet source region Nothing
556 "This module does not declare any ports, but it says it will:"
559 ["Switch","this","to",D.cyan "module"
560 ,"and","you","should","be","all","set!"
565 toParseErrorReport source modul
568toParseErrorReport :: Code.Source -> Module -> Report.Report
569toParseErrorReport source modul =
571 ModuleSpace space row col ->
572 toSpaceReport source space row col
574 ModuleEndOfFile row col ->
575 case Code.whatIsNext source row col of
576 Code.Keyword keyword ->
578 region = toKeywordRegion row col keyword
580 Report.Report "RESERVED WORD" region [] $
581 Code.toSnippet source region Nothing
584 "I got stuck on this reserved word:"
587 "The name `" ++ keyword ++ "` is reserved, so try using a different name?"
592 region = toKeywordRegion row col op
594 Report.Report "UNEXPECTED SYMBOL" region [] $
595 Code.toSnippet source region Nothing
598 "I ran into an unexpected symbol:"
601 "I was not expecting to see a " ++ op ++ " here. Try deleting it? Maybe\
602 \ I can give a better hint from there?"
605 Code.Close term bracket ->
607 region = toRegion row col
609 Report.Report ("UNEXPECTED " ++ map Char.toUpper term) region [] $
610 Code.toSnippet source region Nothing
613 "I ran into an unexpected " ++ term ++ ":"
616 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
621 region = toRegion row col
623 Report.Report "SYNTAX PROBLEM" region [] $
624 Code.toSnippet source region Nothing
630 "Whatever I am running into is confusing me a lot! Normally I can give fairly\
631 \ specific hints, but something is really tripping me up this time."
634 ModuleProblem row col ->
636 region = toRegion row col
638 Report.Report "UNFINISHED MODULE DECLARATION" region [] $
639 Code.toSnippet source region Nothing
642 "I am parsing an `module` declaration, but I got stuck here:"
646 "Here are some examples of valid `module` declarations:"
647 , D.indent 4 $ D.vcat $
648 [ D.fillSep [D.cyan "module","Main",D.cyan "exposing","(..)"]
649 , D.fillSep [D.cyan "module","Dict",D.cyan "exposing","(Dict, empty, get)"]
652 "I generally recommend using an explicit exposing list. I can skip compiling a bunch\
653 \ of files when the public interface of a module stays the same, so exposing fewer\
654 \ values can help improve compile times!"
658 ModuleName row col ->
660 region = toRegion row col
662 Report.Report "EXPECTING MODULE NAME" region [] $
663 Code.toSnippet source region Nothing
666 "I was parsing an `module` declaration until I got stuck here:"
670 "I was expecting to see the module name next, like in these examples:"
671 , D.indent 4 $ D.vcat $
672 [ D.fillSep [D.cyan "module","Dict",D.cyan "exposing","(..)"]
673 , D.fillSep [D.cyan "module","Maybe",D.cyan "exposing","(..)"]
674 , D.fillSep [D.cyan "module","Html.Attributes",D.cyan "exposing","(..)"]
675 , D.fillSep [D.cyan "module","Json.Decode",D.cyan "exposing","(..)"]
678 "Notice that the module names all start with capital letters. That is required!"
682 ModuleExposing exposing row col ->
683 toExposingReport source exposing row col
685 PortModuleProblem row col ->
687 region = toRegion row col
689 Report.Report "UNFINISHED PORT MODULE DECLARATION" region [] $
690 Code.toSnippet source region Nothing
693 "I am parsing an `port module` declaration, but I got stuck here:"
697 "Here are some examples of valid `port module` declarations:"
698 , D.indent 4 $ D.vcat $
699 [ D.fillSep [D.cyan "port",D.cyan "module","WebSockets",D.cyan "exposing","(send, listen, keepAlive)"]
700 , D.fillSep [D.cyan "port",D.cyan "module","Maps",D.cyan "exposing","(Location, goto)"]
702 , D.link "Note" "Read" "ports" "for more help."
706 PortModuleName row col ->
708 region = toRegion row col
710 Report.Report "EXPECTING MODULE NAME" region [] $
711 Code.toSnippet source region Nothing
714 "I was parsing an `module` declaration until I got stuck here:"
718 "I was expecting to see the module name next, like in these examples:"
719 , D.indent 4 $ D.vcat $
720 [ D.fillSep [D.cyan "port",D.cyan "module","WebSockets",D.cyan "exposing","(send, listen, keepAlive)"]
721 , D.fillSep [D.cyan "port",D.cyan "module","Maps",D.cyan "exposing","(Location, goto)"]
724 "Notice that the module names start with capital letters. That is required!"
728 PortModuleExposing exposing row col ->
729 toExposingReport source exposing row col
733 region = toRegion row col
735 Report.Report "BAD MODULE DECLARATION" region [] $
736 Code.toSnippet source region Nothing
739 "I cannot parse this module declaration:"
742 "This type of module is reserved for the @elm organization. It is used to\
743 \ define certain effects, avoiding building them into the compiler."
748 region = toRegion row col
750 toBadFirstLineReport keyword =
751 Report.Report "TOO MUCH INDENTATION" region [] $
752 Code.toSnippet source region Nothing
755 "This `" ++ keyword ++ "` should not have any spaces before it:"
758 "Delete the spaces before `" ++ keyword ++ "` until there are none left!"
762 case Code.whatIsNext source row col of
763 Code.Keyword "module" -> toBadFirstLineReport "module"
764 Code.Keyword "import" -> toBadFirstLineReport "import"
765 Code.Keyword "type" -> toBadFirstLineReport "type"
766 Code.Keyword "port" -> toBadFirstLineReport "port"
768 Report.Report "SYNTAX PROBLEM" region [] $
769 Code.toSnippet source region Nothing
776 "I am not sure what is going on, but I recommend starting an Elm\
777 \ file with the following lines:"
779 [ D.fillSep [D.cyan "import","Html"]
781 , D.fillSep [D.green "main","="]
782 , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
785 "You should be able to copy those lines directly into your file. Check out\
786 \ some of the examples on https://elm-lang.org for more help getting started!"
788 "This can also happen when something is indented too much!"
792 ImportStart row col ->
793 toImportReport source row col
795 ImportName row col ->
797 region = toRegion row col
799 Report.Report "EXPECTING IMPORT NAME" region [] $
800 Code.toSnippet source region Nothing
803 "I was parsing an `import` until I got stuck here:"
807 "I was expecting to see a module name next, like in these examples:"
808 , D.indent 4 $ D.vcat $
809 [ D.fillSep [D.cyan "import","Dict"]
810 , D.fillSep [D.cyan "import","Maybe"]
811 , D.fillSep [D.cyan "import","Html.Attributes"]
812 , D.fillSep [D.cyan "import","Json.Decode"]
815 "Notice that the module names all start with capital letters. That is required!"
820 toImportReport source row col
822 ImportAlias row col ->
824 region = toRegion row col
826 Report.Report "EXECTING IMPORT ALIAS" region [] $
827 Code.toSnippet source region Nothing
830 "I was parsing an `import` until I got stuck here:"
834 "I was expecting to see an alias next, like in these examples:"
835 , D.indent 4 $ D.vcat $
836 [ D.fillSep [D.cyan "import","Html.Attributes",D.cyan "as","Attr"]
837 , D.fillSep [D.cyan "import","WebGL.Texture",D.cyan "as","Texture"]
838 , D.fillSep [D.cyan "import","Json.Decode",D.cyan "as","D"]
841 "Notice that the alias always starts with a capital letter. That is required!"
845 ImportExposing row col ->
846 toImportReport source row col
848 ImportExposingList exposing row col ->
849 toExposingReport source exposing row col
852 toImportReport source row col
854 ImportIndentName row col ->
855 toImportReport source row col
857 ImportIndentAlias row col ->
858 toImportReport source row col
860 ImportIndentExposingList row col ->
862 region = toRegion row col
864 Report.Report "UNFINISHED IMPORT" region [] $
865 Code.toSnippet source region Nothing
868 "I was parsing an `import` until I got stuck here:"
872 "I was expecting to see the list of exposed values next. For example, here\
873 \ are two ways to expose values from the `Html` module:"
874 , D.indent 4 $ D.vcat $
875 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
876 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
879 "I generally recommend the second style. It is more explicit, making it\
880 \ much easier to figure out where values are coming from in large projects!"
886 region = toRegion row col
888 Report.Report "BAD INFIX" region [] $
889 Code.toSnippet source region Nothing
892 "Something went wrong in this infix operator declaration:"
895 "This feature is used by the @elm organization to define the\
896 \ languages built-in operators."
899 Declarations decl _ _ ->
900 toDeclarationsReport source decl
907toImportReport :: Code.Source -> Row -> Col -> Report.Report
908toImportReport source row col =
910 region = toRegion row col
912 Report.Report "UNFINISHED IMPORT" region [] $
913 Code.toSnippet source region Nothing
916 "I am partway through parsing an import, but I got stuck here:"
920 "Here are some examples of valid `import` declarations:"
921 , D.indent 4 $ D.vcat $
922 [ D.fillSep [D.cyan "import","Html"]
923 , D.fillSep [D.cyan "import","Html",D.cyan "as","H"]
924 , D.fillSep [D.cyan "import","Html",D.cyan "as","H",D.cyan "exposing","(..)"]
925 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
928 "You are probably trying to import a different module, but try to make it look like one of these examples!"
937toExposingReport :: Code.Source -> Exposing -> Row -> Col -> Report.Report
938toExposingReport source exposing startRow startCol =
940 ExposingSpace space row col ->
941 toSpaceReport source space row col
943 ExposingStart row col ->
945 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
946 region = toRegion row col
948 Report.Report "PROBLEM IN EXPOSING" region [] $
949 Code.toSnippet source surroundings (Just region)
952 "I want to parse exposed values, but I am getting stuck here:"
956 ["Exposed","values","are","always","surrounded","by","parentheses."
957 ,"So","try","adding","a",D.green "(","here?"
959 , D.toSimpleNote "Here are some valid examples of `exposing` for reference:"
960 , D.indent 4 $ D.vcat $
961 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
962 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
965 "If you are getting tripped up, you can just expose everything for now. It should\
966 \ get easier to make an explicit exposing list as you see more examples in the wild."
970 ExposingValue row col ->
971 case Code.whatIsNext source row col of
972 Code.Keyword keyword ->
974 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
975 region = toKeywordRegion row col keyword
977 Report.Report "RESERVED WORD" region [] $
978 Code.toSnippet source surroundings (Just region)
981 "I got stuck on this reserved word:"
984 "It looks like you are trying to expose `" ++ keyword ++ "` but that is a reserved word. Is there a typo?"
989 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
990 region = toKeywordRegion row col op
992 Report.Report "UNEXPECTED SYMBOL" region [] $
993 Code.toSnippet source surroundings (Just region)
996 "I got stuck on this symbol:"
1000 "If you are trying to expose an operator, add parentheses around it like this:"
1001 , D.indent 4 $ D.dullyellow (D.fromChars op) <> " -> " <> D.green ("(" <> D.fromChars op <> ")")
1007 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1008 region = toRegion row col
1010 Report.Report "PROBLEM IN EXPOSING" region [] $
1011 Code.toSnippet source surroundings (Just region)
1014 "I got stuck while parsing these exposed values:"
1018 "I do not have an exact recommendation, so here are some valid examples\
1019 \ of `exposing` for reference:"
1020 , D.indent 4 $ D.vcat $
1021 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
1022 , D.fillSep [D.cyan "import","Basics",D.cyan "exposing","(Int, Float, Bool(..), (+), not, sqrt)"]
1025 "These examples show how to expose types, variants, operators, and functions. Everything\
1026 \ should be some permutation of these examples, just with different names."
1030 ExposingOperator row col ->
1032 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1033 region = toRegion row col
1035 Report.Report "PROBLEM IN EXPOSING" region [] $
1036 Code.toSnippet source surroundings (Just region)
1039 "I just saw an open parenthesis, so I was expecting an operator next:"
1042 ["It","is","possible","to","expose","operators,","so","I","was","expecting"
1043 ,"to","see","something","like",D.dullyellow "(+)","or",D.dullyellow "(|=)"
1044 ,"or",D.dullyellow "(||)","after","I","saw","that","open","parenthesis."
1048 ExposingOperatorReserved op row col ->
1050 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1051 region = toRegion row col
1053 Report.Report "RESERVED SYMBOL" region [] $
1054 Code.toSnippet source surroundings (Just region)
1057 "I cannot expose this as an operator:"
1060 BadDot -> D.reflow "Try getting rid of this entry? Maybe I can give you a better hint after that?"
1061 BadPipe -> D.fillSep ["Maybe","you","want",D.dullyellow "(||)","instead?"]
1062 BadArrow -> D.reflow "Try getting rid of this entry? Maybe I can give you a better hint after that?"
1063 BadEquals -> D.fillSep ["Maybe","you","want",D.dullyellow "(==)","instead?"]
1064 BadHasType -> D.fillSep ["Maybe","you","want",D.dullyellow "(::)","instead?"]
1067 ExposingOperatorRightParen row col ->
1069 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1070 region = toRegion row col
1072 Report.Report "PROBLEM IN EXPOSING" region [] $
1073 Code.toSnippet source surroundings (Just region)
1076 "It looks like you are exposing an operator, but I got stuck here:"
1079 ["I","was","expecting","to","see","the","closing","parenthesis","immediately"
1080 ,"after","the","operator.","Try","adding","a",D.green ")","right","here?"
1084 ExposingEnd row col ->
1086 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1087 region = toRegion row col
1089 Report.Report "UNFINISHED EXPOSING" region [] $
1090 Code.toSnippet source surroundings (Just region)
1093 "I was partway through parsing exposed values, but I got stuck here:"
1096 "Maybe there is a comma missing before this?"
1099 ExposingTypePrivacy row col ->
1101 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1102 region = toRegion row col
1104 Report.Report "PROBLEM EXPOSING CUSTOM TYPE VARIANTS" region [] $
1105 Code.toSnippet source surroundings (Just region)
1108 "It looks like you are trying to expose the variants of a custom type:"
1112 ["You","need","to","write","something","like"
1113 ,D.dullyellow "Status(..)","or",D.dullyellow "Entity(..)"
1114 ,"though.","It","is","all","or","nothing,","otherwise","`case`"
1115 ,"expressions","could","miss","a","variant","and","crash!"
1118 "It is often best to keep the variants hidden! If someone pattern matches on\
1119 \ the variants, it is a MAJOR change if any new variants are added. Suddenly\
1120 \ their `case` expressions do not cover all variants! So if you do not need\
1121 \ people to pattern match, keep the variants hidden and expose functions to\
1122 \ construct values of this type. This way you can add new variants as a MINOR change!"
1126 ExposingIndentEnd row col ->
1128 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1129 region = toRegion row col
1131 Report.Report "UNFINISHED EXPOSING" region [] $
1132 Code.toSnippet source surroundings (Just region)
1135 "I was partway through parsing exposed values, but I got stuck here:"
1139 ["I","was","expecting","a","closing","parenthesis."
1140 ,"Try","adding","a",D.green ")","right","here?"
1143 "I can get confused when there is not enough indentation, so if you already\
1144 \ have a closing parenthesis, it probably just needs some spaces in front of it."
1148 ExposingIndentValue row col ->
1150 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1151 region = toRegion row col
1153 Report.Report "UNFINISHED EXPOSING" region [] $
1154 Code.toSnippet source surroundings (Just region)
1157 "I was partway through parsing exposed values, but I got stuck here:"
1160 "I was expecting another value to expose."
1168toSpaceReport :: Code.Source -> Space -> Row -> Col -> Report.Report
1169toSpaceReport source space row col =
1173 region = toRegion row col
1175 Report.Report "NO TABS" region [] $
1176 Code.toSnippet source region Nothing
1179 "I ran into a tab, but tabs are not allowed in Elm files."
1182 "Replace the tab with spaces."
1185 EndlessMultiComment ->
1187 region = toWiderRegion row col 2
1189 Report.Report "ENDLESS COMMENT" region [] $
1190 Code.toSnippet source region Nothing
1193 "I cannot find the end of this multi-line comment:"
1196 [ D.reflow "Add a -} somewhere after this to end the comment."
1198 "Multi-line comments can be nested in Elm, so {- {- -} -} is a comment\
1199 \ that happens to contain another comment. Like parentheses and curly braces,\
1200 \ the start and end markers must always be balanced. Maybe that is the problem?"
1209toRegion :: Row -> Col -> A.Region
1212 pos = A.Position row col
1217toWiderRegion :: Row -> Col -> Word16 -> A.Region
1218toWiderRegion row col extra =
1220 (A.Position row col)
1221 (A.Position row (col + extra))
1224toKeywordRegion :: Row -> Col -> [Char.Char] -> A.Region
1225toKeywordRegion row col keyword =
1227 (A.Position row col)
1228 (A.Position row (col + fromIntegral (length keyword)))
1231toDeclarationsReport :: Code.Source -> Decl -> Report.Report
1232toDeclarationsReport source decl =
1234 DeclStart row col ->
1235 case Code.whatIsNext source row col of
1236 Code.Close term bracket ->
1238 region = toRegion row col
1240 Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
1241 Code.toSnippet source region Nothing
1244 "I was not expecting to see a " ++ term ++ " here:"
1246 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
1249 Code.Keyword keyword ->
1251 region = toKeywordRegion row col keyword
1253 Report.Report "RESERVED WORD" region [] $
1254 Code.toSnippet source region Nothing
1257 "I was not expecting to run into the `" ++ keyword ++ "` keyword here:"
1262 "It is reserved for declaring imports at the top of your module. If you want\
1263 \ another import, try moving it up top with the other imports. If you want to\
1264 \ define a value or function, try changing the name to something else!"
1269 "It is reserved for writing `case` expressions. Try using a different name?"
1271 "If you are trying to write a `case` expression, it needs to be part of a\
1272 \ definition. So you could write something like this instead:"
1274 [ D.indent 0 $ D.fillSep [D.green "getWidth","maybeWidth","="]
1275 , D.indent 2 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
1276 , D.indent 4 $ D.fillSep [D.blue "Just","width","->"]
1277 , D.indent 6 $ D.fillSep ["width","+",D.dullyellow "200"]
1279 , D.indent 4 $ D.fillSep [D.blue "Nothing","->"]
1280 , D.indent 6 $ D.fillSep [D.dullyellow "400"]
1283 "This defines a `getWidth` function that we can use elsewhere in our program."
1289 "It is reserved for writing `if` expressions. Try using a different name?"
1291 "If you are trying to write an `if` expression, it needs to be part of a\
1292 \ definition. So you could write something like this instead:"
1294 [ D.indent 0 $ D.fillSep [D.green "reviewPowerLevel","powerLevel","="]
1295 , D.indent 2 $ D.fillSep $
1296 [D.cyan "if","powerLevel",">",D.dullyellow "9000"
1297 ,D.cyan "then",D.dullyellow "\"OVER 9000!!!\""
1298 ,D.cyan "else",D.dullyellow "\"not bad\""
1302 "This defines a `reviewPowerLevel` function that we can use elsewhere in our program."
1307 "It is a reserved word. Try changing the name to something else?"
1312 region = toRegion row col
1314 Report.Report "SYNTAX PROBLEM" region [] $
1315 Code.toSnippet source region Nothing
1318 "I was expecting to see a new declaration here:"
1322 "I am not sure what is going wrong exactly, but here are a couple valid\
1323 \ declarations for reference:"
1325 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1326 , D.fillSep [D.green "add","x","y","="]
1327 , D.fillSep [" ","x","+","y"]
1329 , D.fillSep [D.cyan "type",D.green "User","=","Anonymous","|","LoggedIn String"]
1331 "Note that all declarations start with lower-case letters in Elm. Capitalization\
1332 \ makes a difference, so be consious of that if you are working from examples!"
1336 DeclSpace space row col ->
1337 toSpaceReport source space row col
1339 Port port_ row col ->
1340 toPortReport source port_ row col
1342 DeclType declType row col ->
1343 toDeclTypeReport source declType row col
1345 DeclDef name declDef row col ->
1346 toDeclDefReport source name declDef row col
1348 DeclFreshLineAfterDocComment row col ->
1350 region = toRegion row col
1352 Report.Report "EXPECTING DECLARATION" region [] $
1353 Code.toSnippet source region Nothing
1356 "I just saw a doc comment, but then I got stuck here:"
1359 "I was expecting to see the corresponding declaration next, starting on a fresh\
1360 \ line with no indentation."
1368toPortReport :: Code.Source -> Port -> Row -> Col -> Report.Report
1369toPortReport source port_ startRow startCol =
1371 PortSpace space row col ->
1372 toSpaceReport source space row col
1375 case Code.whatIsNext source row col of
1376 Code.Keyword keyword ->
1378 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1379 region = toKeywordRegion row col keyword
1381 Report.Report "RESERVED WORD" region [] $
1382 Code.toSnippet source surroundings (Just region)
1385 "I cannot handle ports with names like this:"
1388 "You are trying to make a port named `" ++ keyword
1389 ++ "` but that is a reserved word. Try using some other name?"
1394 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1395 region = toRegion row col
1397 Report.Report "PORT PROBLEM" region [] $
1398 Code.toSnippet source surroundings (Just region)
1401 "I just saw the start of a `port` declaration, but then I got stuck here:"
1405 ["I","was","expecting","to","see","a","name","like"
1406 ,D.dullyellow "send","or",D.dullyellow "receive","next."
1407 ,"Something","that","starts","with","a","lower-case","letter."
1413 PortColon row col ->
1415 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1416 region = toRegion row col
1418 Report.Report "PORT PROBLEM" region [] $
1419 Code.toSnippet source surroundings (Just region)
1422 "I just saw the start of a `port` declaration, but then I got stuck here:"
1426 "I was expecting to see a colon next. And then a type that tells me\
1427 \ what type of values are going to flow through."
1432 PortType tipe row col ->
1433 toTypeReport source TC_Port tipe row col
1435 PortIndentName row col ->
1437 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1438 region = toRegion row col
1440 Report.Report "UNFINISHED PORT" region [] $
1441 Code.toSnippet source surroundings (Just region)
1444 "I just saw the start of a `port` declaration, but then I got stuck here:"
1448 ["I","was","expecting","to","see","a","name","like"
1449 ,D.dullyellow "send","or",D.dullyellow "receive","next."
1450 ,"Something","that","starts","with","a","lower-case","letter."
1456 PortIndentColon row col ->
1458 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1459 region = toRegion row col
1461 Report.Report "UNFINISHED PORT" region [] $
1462 Code.toSnippet source surroundings (Just region)
1465 "I just saw the start of a `port` declaration, but then I got stuck here:"
1469 "I was expecting to see a colon next. And then a type that tells me\
1470 \ what type of values are going to flow through."
1475 PortIndentType row col ->
1477 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1478 region = toRegion row col
1480 Report.Report "UNFINISHED PORT" region [] $
1481 Code.toSnippet source surroundings (Just region)
1484 "I just saw the start of a `port` declaration, but then I got stuck here:"
1488 "I was expecting to see a type next. Here are examples of outgoing and\
1489 \ incoming ports for reference:"
1491 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
1492 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
1495 "The first line defines a `send` port so you can send strings out to JavaScript.\
1496 \ Maybe you send them on a WebSocket or put them into IndexedDB. The second line\
1497 \ defines a `receive` port so you can receive strings from JavaScript. Maybe you\
1498 \ get receive messages when new WebSocket messages come in or when an entry in\
1499 \ IndexedDB changes for some external reason."
1508 "Here are some example `port` declarations for reference:"
1510 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
1511 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
1514 "The first line defines a `send` port so you can send strings out to JavaScript.\
1515 \ Maybe you send them on a WebSocket or put them into IndexedDB. The second line\
1516 \ defines a `receive` port so you can receive strings from JavaScript. Maybe you\
1517 \ get receive messages when new WebSocket messages come in or when the IndexedDB\
1518 \ is changed for some external reason."
1526toDeclTypeReport :: Code.Source -> DeclType -> Row -> Col -> Report.Report
1527toDeclTypeReport source declType startRow startCol =
1529 DT_Space space row col ->
1530 toSpaceReport source space row col
1534 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1535 region = toRegion row col
1537 Report.Report "EXPECTING TYPE NAME" region [] $
1538 Code.toSnippet source surroundings (Just region)
1541 "I think I am parsing a type declaration, but I got stuck here:"
1545 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1546 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1552 DT_Alias typeAlias row col ->
1553 toTypeAliasReport source typeAlias row col
1555 DT_Union customType row col ->
1556 toCustomTypeReport source customType row col
1558 DT_IndentName row col ->
1560 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1561 region = toRegion row col
1563 Report.Report "EXPECTING TYPE NAME" region [] $
1564 Code.toSnippet source surroundings (Just region)
1567 "I think I am parsing a type declaration, but I got stuck here:"
1571 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1572 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1579toTypeAliasReport :: Code.Source -> TypeAlias -> Row -> Col -> Report.Report
1580toTypeAliasReport source typeAlias startRow startCol =
1582 AliasSpace space row col ->
1583 toSpaceReport source space row col
1585 AliasName row col ->
1587 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1588 region = toRegion row col
1590 Report.Report "EXPECTING TYPE ALIAS NAME" region [] $
1591 Code.toSnippet source surroundings (Just region)
1594 "I am partway through parsing a type alias, but I got stuck here:"
1598 ["I","was","expecting","a","name","like",D.dullyellow "Person","or",D.dullyellow "Point"
1599 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1605 AliasEquals row col ->
1606 case Code.whatIsNext source row col of
1607 Code.Keyword keyword ->
1609 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1610 region = toKeywordRegion row col keyword
1612 Report.Report "RESERVED WORD" region [] $
1613 Code.toSnippet source surroundings (Just region)
1616 "I ran into a reserved word unexpectedly while parsing this type alias:"
1620 "It looks like you are trying use `" ++ keyword
1621 ++ "` as a type variable, but it is a reserved word. Try using a different name?"
1628 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1629 region = toRegion row col
1631 Report.Report "PROBLEM IN TYPE ALIAS" region [] $
1632 Code.toSnippet source surroundings (Just region)
1635 "I am partway through parsing a type alias, but I got stuck here:"
1639 "I was expecting to see a type variable or an an equals sign next."
1644 AliasBody tipe row col ->
1645 toTypeReport source TC_TypeAlias tipe row col
1647 AliasIndentEquals row col ->
1649 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1650 region = toRegion row col
1652 Report.Report "UNFINISHED TYPE ALIAS" region [] $
1653 Code.toSnippet source surroundings (Just region)
1656 "I am partway through parsing a type alias, but I got stuck here:"
1660 "I was expecting to see a type variable or an an equals sign next."
1665 AliasIndentBody row col ->
1667 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1668 region = toRegion row col
1670 Report.Report "UNFINISHED TYPE ALIAS" region [] $
1671 Code.toSnippet source surroundings (Just region)
1674 "I am partway through parsing a type alias, but I got stuck here:"
1678 ["I","was","expecting","to","see","a","type","next.","Something","as","simple"
1679 ,"as",D.dullyellow "Int","or",D.dullyellow "Float","would","work!"
1686typeAliasNote :: D.Doc
1690 "Here is an example of a valid `type alias` for reference:"
1692 [ D.indent 0 $ D.fillSep [D.cyan "type",D.cyan "alias",D.green "Person","="]
1693 , D.indent 2 $ D.vcat $
1701 "This would let us use `Person` as a shorthand for that record type. Using this\
1702 \ shorthand makes type annotations much easier to read, and makes changing code\
1703 \ easier if you decide later that there is more to a person than age and height!"
1707toCustomTypeReport :: Code.Source -> CustomType -> Row -> Col -> Report.Report
1708toCustomTypeReport source customType startRow startCol =
1710 CT_Space space row col ->
1711 toSpaceReport source space row col
1715 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1716 region = toRegion row col
1718 Report.Report "EXPECTING TYPE NAME" region [] $
1719 Code.toSnippet source surroundings (Just region)
1722 "I think I am parsing a type declaration, but I got stuck here:"
1726 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1727 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1733 CT_Equals row col ->
1734 case Code.whatIsNext source row col of
1735 Code.Keyword keyword ->
1737 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1738 region = toKeywordRegion row col keyword
1740 Report.Report "RESERVED WORD" region [] $
1741 Code.toSnippet source surroundings (Just region)
1744 "I ran into a reserved word unexpectedly while parsing this custom type:"
1748 "It looks like you are trying use `" ++ keyword
1749 ++ "` as a type variable, but it is a reserved word. Try using a different name?"
1756 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1757 region = toRegion row col
1759 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1760 Code.toSnippet source surroundings (Just region)
1763 "I am partway through parsing a custom type, but I got stuck here:"
1767 "I was expecting to see a type variable or an an equals sign next."
1774 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1775 region = toRegion row col
1777 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1778 Code.toSnippet source surroundings (Just region)
1781 "I am partway through parsing a custom type, but I got stuck here:"
1785 "I was expecting to see a vertical bar like | next."
1790 CT_Variant row col ->
1792 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1793 region = toRegion row col
1795 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1796 Code.toSnippet source surroundings (Just region)
1799 "I am partway through parsing a custom type, but I got stuck here:"
1803 ["I","was","expecting","to","see","a","variant","name","next."
1804 ,"Something","like",D.dullyellow "Success","or",D.dullyellow "Sandwich" <> "."
1805 ,"Any","name","that","starts","with","a","capital","letter","really!"
1811 CT_VariantArg tipe row col ->
1812 toTypeReport source TC_CustomType tipe row col
1814 CT_IndentEquals row col ->
1816 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1817 region = toRegion row col
1819 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1820 Code.toSnippet source surroundings (Just region)
1823 "I am partway through parsing a custom type, but I got stuck here:"
1827 "I was expecting to see a type variable or an an equals sign next."
1832 CT_IndentBar row col ->
1834 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1835 region = toRegion row col
1837 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1838 Code.toSnippet source surroundings (Just region)
1841 "I am partway through parsing a custom type, but I got stuck here:"
1845 "I was expecting to see a vertical bar like | next."
1850 CT_IndentAfterBar row col ->
1852 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1853 region = toRegion row col
1855 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1856 Code.toSnippet source surroundings (Just region)
1859 "I am partway through parsing a custom type, but I got stuck here:"
1863 "I just saw a vertical bar, so I was expecting to see another variant defined next."
1868 CT_IndentAfterEquals row col ->
1870 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1871 region = toRegion row col
1873 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1874 Code.toSnippet source surroundings (Just region)
1877 "I am partway through parsing a custom type, but I got stuck here:"
1881 "I just saw an equals sign, so I was expecting to see the first variant defined next."
1887customTypeNote :: D.Doc
1891 "Here is an example of a valid `type` declaration for reference:"
1893 [ D.indent 0 $ D.fillSep [D.cyan "type",D.green "Status"]
1894 , D.indent 2 $ D.fillSep ["=","Failure"]
1895 , D.indent 2 $ D.fillSep ["|","Waiting"]
1896 , D.indent 2 $ D.fillSep ["|","Success","String"]
1899 "This defines a new `Status` type with three variants. This could be useful if\
1900 \ we are waiting for an HTTP request. Maybe we start with `Waiting` and then\
1901 \ switch to `Failure` or `Success \"message from server\"` depending on how\
1902 \ things go. Notice that the Success variant has some associated data, allowing\
1903 \ us to store a String if the request goes well!"
1911toDeclDefReport :: Code.Source -> Name.Name -> DeclDef -> Row -> Col -> Report.Report
1912toDeclDefReport source name declDef startRow startCol =
1914 DeclDefSpace space row col ->
1915 toSpaceReport source space row col
1917 DeclDefEquals row col ->
1918 case Code.whatIsNext source row col of
1919 Code.Keyword keyword ->
1921 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1922 region = toKeywordRegion row col keyword
1924 Report.Report "RESERVED WORD" region [] $
1925 Code.toSnippet source surroundings (Just region)
1928 "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
1931 "This is a reserved word! Try using some other name?"
1936 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1937 region = toKeywordRegion row col op
1939 Report.Report "UNEXPECTED SYMBOL" region [] $
1940 Code.toSnippet source surroundings (Just region)
1943 "I was not expecting to see this symbol here:"
1947 "I am not sure what is going wrong exactly, so here is a valid\
1948 \ definition (with an optional type annotation) for reference:"
1950 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1951 , D.fillSep [D.green "add","x","y","="]
1952 , D.fillSep [" ","x","+","y"]
1955 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
1961 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1962 region = toRegion row col
1964 Report.Report "PROBLEM IN DEFINITION" region [] $
1965 Code.toSnippet source surroundings (Just region)
1968 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
1972 "I am not sure what is going wrong exactly, so here is a valid\
1973 \ definition (with an optional type annotation) for reference:"
1975 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1976 , D.fillSep [D.green "add","x","y","="]
1977 , D.fillSep [" ","x","+","y"]
1980 "Try to use that format!"
1984 DeclDefType tipe row col ->
1985 toTypeReport source (TC_Annotation name) tipe row col
1987 DeclDefArg pattern row col ->
1988 toPatternReport source PArg pattern row col
1990 DeclDefBody expr row col ->
1991 toExprReport source (InDef name startRow startCol) expr row col
1993 DeclDefNameRepeat row col ->
1995 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1996 region = toRegion row col
1998 Report.Report "EXPECTING DEFINITION" region [] $
1999 Code.toSnippet source surroundings (Just region)
2002 "I just saw the type annotation for `" ++ Name.toChars name
2003 ++ "` so I was expecting to see its definition here:"
2007 "Type annotations always appear directly above the relevant\
2008 \ definition, without anything else in between. (Not even doc comments!)"
2013 DeclDefNameMatch defName row col ->
2015 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2016 region = toRegion row col
2018 Report.Report "NAME MISMATCH" region [] $
2019 Code.toSnippet source surroundings (Just region)
2022 "I just saw a type annotation for `" ++ Name.toChars name ++ "`, but it is followed by a definition for `" ++ Name.toChars defName ++ "`:"
2026 "These names do not match! Is there a typo?"
2027 , D.indent 4 $ D.fillSep $
2028 [D.dullyellow (D.fromName defName),"->",D.green (D.fromName name)]
2032 DeclDefIndentType row col ->
2034 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2035 region = toRegion row col
2037 Report.Report "UNFINISHED DEFINITION" region [] $
2038 Code.toSnippet source surroundings (Just region)
2041 "I got stuck while parsing the `" ++ Name.toChars name ++ "` type annotation:"
2045 "I just saw a colon, so I am expecting to see a type next."
2050 DeclDefIndentEquals row col ->
2052 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2053 region = toRegion row col
2055 Report.Report "UNFINISHED DEFINITION" region [] $
2056 Code.toSnippet source surroundings (Just region)
2059 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
2063 "I was expecting to see an argument or an equals sign next."
2068 DeclDefIndentBody row col ->
2070 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2071 region = toRegion row col
2073 Report.Report "UNFINISHED DEFINITION" region [] $
2074 Code.toSnippet source surroundings (Just region)
2077 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
2081 "I was expecting to see an expression next. What is it equal to?"
2091 "Here is a valid definition (with a type annotation) for reference:"
2093 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2094 , D.fillSep [D.green "add","x","y","="]
2095 , D.fillSep [" ","x","+","y"]
2098 "The top line (called a \"type annotation\") is optional. You can leave it off\
2099 \ if you want. As you get more comfortable with Elm and as your project grows,\
2100 \ it becomes more and more valuable to add them though! They work great as\
2101 \ compiler-verified documentation, and they often improve error messages!"
2110 = InNode Node Row Col Context
2111 | InDef Name.Name Row Col
2112 | InDestruct Row Col
2128getDefName :: Context -> Maybe Name.Name
2131 InDestruct _ _ -> Nothing
2132 InDef name _ _ -> Just name
2133 InNode _ _ _ c -> getDefName c
2136isWithin :: Node -> Context -> Bool
2137isWithin desiredNode context =
2139 InDestruct _ _ -> False
2140 InDef _ _ _ -> False
2141 InNode actualNode _ _ _ -> desiredNode == actualNode
2148toExprReport :: Code.Source -> Context -> Expr -> Row -> Col -> Report.Report
2149toExprReport source context expr startRow startCol =
2152 toLetReport source context let_ row col
2154 Case case_ row col ->
2155 toCaseReport source context case_ row col
2158 toIfReport source context if_ row col
2160 List list row col ->
2161 toListReport source context list row col
2163 Record record row col ->
2164 toRecordReport source context record row col
2166 Tuple tuple row col ->
2167 toTupleReport source context tuple row col
2169 Func func row col ->
2170 toFuncReport source context func row col
2173 let region = toRegion row col in
2174 Report.Report "EXPECTING RECORD ACCESSOR" region [] $
2175 Code.toSnippet source region Nothing
2178 "I was expecting to see a record accessor here:"
2181 ["Something","like",D.dullyellow".name","or",D.dullyellow".price"
2182 ,"that","accesses","a","value","from","a","record."
2187 let region = toRegion row col in
2188 Report.Report "EXPECTING RECORD ACCESSOR" region [] $
2189 Code.toSnippet source region Nothing
2192 "I am trying to parse a record accessor here:"
2197 ["Something","like",D.dullyellow".name","or",D.dullyellow".price"
2198 ,"that","accesses","a","value","from","a","record."
2202 "Record field names must start with a lower case letter!"
2206 OperatorRight op row col ->
2207 let region = toRegion row col in
2208 Report.Report "MISSING EXPRESSION" region [] $
2209 Code.toSnippet source region Nothing
2212 "I was expecting to see an expression after this " ++ Name.toChars op ++ " operator:"
2216 ["You","can","just","put","anything","for","now,","like"
2217 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2218 ,"Once","there","is","something","there,","I","can","probably"
2219 ,"give","a","more","specific","hint!"
2222 "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2223 \ Or if I run into operators in unexpected spots. Point is, there are a\
2224 \ couple ways I can get confused and give sort of weird advice!"
2228 OperatorReserved operator row col ->
2229 toOperatorReport source context operator row col
2233 (contextRow, contextCol, aThing) =
2235 InDestruct r c -> (r, c, "a definition")
2236 InDef name r c -> (r, c, "the `" ++ Name.toChars name ++ "` definition")
2237 InNode NRecord r c _ -> (r, c, "a record")
2238 InNode NParens r c _ -> (r, c, "some parentheses")
2239 InNode NList r c _ -> (r, c, "a list")
2240 InNode NFunc r c _ -> (r, c, "an anonymous function")
2241 InNode NCond r c _ -> (r, c, "an `if` expression")
2242 InNode NThen r c _ -> (r, c, "an `if` expression")
2243 InNode NElse r c _ -> (r, c, "an `if` expression")
2244 InNode NCase r c _ -> (r, c, "a `case` expression")
2245 InNode NBranch r c _ -> (r, c, "a `case` expression")
2246 -- TODO check if this is actually the best way to get error messages here
2248 surroundings = A.Region (A.Position contextRow contextCol) (A.Position row col)
2249 region = toRegion row col
2251 Report.Report "MISSING EXPRESSION" region [] $
2252 Code.toSnippet source surroundings (Just region)
2255 "I am partway through parsing " ++ aThing ++ ", but I got stuck here:"
2259 ["I","was","expecting","to","see","an","expression","like"
2260 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2261 ,"Once","there","is","something","there,","I","can","probably"
2262 ,"give","a","more","specific","hint!"
2265 "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2266 \ Or if I run into operators in unexpected spots. Point is, there are a\
2267 \ couple ways I can get confused and give sort of weird advice!"
2271 Char char row col ->
2272 toCharReport source char row col
2274 String string row col ->
2275 toStringReport source string row col
2277 Number number row col ->
2278 toNumberReport source number row col
2280 Space space row col ->
2281 toSpaceReport source space row col
2283 EndlessShader row col ->
2285 region = toWiderRegion row col 6
2287 Report.Report "ENDLESS SHADER" region [] $
2288 Code.toSnippet source region Nothing
2290 D.reflow "I cannot find the end of this shader:"
2292 D.reflow "Add a |] somewhere after this to end the shader."
2295 ShaderProblem problem row col ->
2297 region = toRegion row col
2299 Report.Report "SHADER PROBLEM" region [] $
2300 Code.toSnippet source region Nothing
2303 "I ran into a problem while parsing this GLSL block."
2307 "I use a 3rd party GLSL parser for now, and I did my best to extract their error message:"
2308 , D.indent 4 $ D.vcat $
2309 map D.fromChars (filter (/="") (lines problem))
2313 IndentOperatorRight op row col ->
2315 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2316 region = toRegion row col
2318 Report.Report "MISSING EXPRESSION" region [] $
2319 Code.toSnippet source surroundings (Just region)
2322 "I was expecting to see an expression after this " ++ Name.toChars op ++ " operator:"
2327 ["You","can","just","put","anything","for","now,","like"
2328 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2329 ,"Once","there","is","something","there,","I","can","probably"
2330 ,"give","a","more","specific","hint!"
2334 "I may be getting confused by your indentation? The easiest way to make sure\
2335 \ this is not an indentation problem is to put the expression on the right of\
2336 \ the " ++ Name.toChars op ++ " operator on the same line."
2340 IndentMoreExpr _ _ ->
2341 error "TODO IndentMoreExpr"
2348toCharReport :: Code.Source -> Char -> Row -> Col -> Report.Report
2349toCharReport source char row col =
2353 region = toRegion row col
2355 Report.Report "MISSING SINGLE QUOTE" region [] $
2356 Code.toSnippet source region Nothing
2359 "I thought I was parsing a character, but I got to the end of\
2360 \ the line without seeing the closing single quote:"
2363 "Add a closing single quote here!"
2366 CharEscape escape ->
2367 toEscapeReport source escape row col
2369 CharNotString width ->
2371 region = toWiderRegion row col width
2373 Report.Report "NEEDS DOUBLE QUOTES" region [] $
2374 Code.toSnippet source region Nothing
2376 "The following string uses single quotes:"
2379 [ "Please switch to double quotes instead:"
2381 D.dullyellow "'this'" <> " => " <> D.green "\"this\""
2383 "Elm uses double quotes for strings like \"hello\", whereas it uses single\
2384 \ quotes for individual characters like 'a' and 'ø'. This distinction helps with\
2385 \ code like (String.any (\\c -> c == 'X') \"90210\") where you are inspecting\
2386 \ individual characters."
2395toStringReport :: Code.Source -> String -> Row -> Col -> Report.Report
2396toStringReport source string row col =
2398 StringEndless_Single ->
2400 region = toRegion row col
2402 Report.Report "ENDLESS STRING" region [] $
2403 Code.toSnippet source region Nothing
2406 "I got to the end of the line without seeing the closing double quote:"
2410 ["Strings","look","like",D.green "\"this\"","with","double"
2411 ,"quotes","on","each","end.","Is","the","closing","double"
2412 ,"quote","missing","in","your","code?"
2414 , D.link "Note" "Read" "TODO" "if you want a string that spans multiple lines."
2418 StringEndless_Multi ->
2420 region = toWiderRegion row col 3
2422 Report.Report "ENDLESS STRING" region [] $
2423 Code.toSnippet source region Nothing
2426 "I cannot find the end of this multi-line string:"
2429 [ D.reflow "Add a \"\"\" somewhere after this to end the string."
2430 , D.link "Hint" "Read" "TODO" "for more information on strings and multi-line strings."
2434 StringEscape escape ->
2435 toEscapeReport source escape row col
2442toEscapeReport :: Code.Source -> Escape -> Row -> Col -> Report.Report
2443toEscapeReport source escape row col =
2447 region = toWiderRegion row col 2
2449 Report.Report "UNKNOWN ESCAPE" region [] $
2450 Code.toSnippet source region Nothing
2453 "Backslashes always start escaped characters, but I do not recognize this one:"
2457 "Valid escape characters include:"
2458 , D.dullyellow $ D.indent 4 $ D.vcat $
2468 "Do you want one of those instead? Maybe you need \\\\ to escape a backslash?"
2470 "The last style lets encode ANY character by its Unicode code\
2471 \ point. That means \\u{0009} and \\t are the same. You can use\
2472 \ that style for anything not covered by the other six escapes!"
2476 BadUnicodeFormat width ->
2478 region = toWiderRegion row col width
2480 Report.Report "BAD UNICODE ESCAPE" region [] $
2481 Code.toSnippet source region Nothing
2484 "I ran into an invalid Unicode escape:"
2488 "Here are some examples of valid Unicode escapes:"
2489 , D.dullyellow $ D.indent 4 $ D.vcat $
2496 "Notice that the code point is always surrounded by curly braces.\
2497 \ Maybe you are missing the opening or closing curly brace?"
2500 BadUnicodeCode width ->
2502 region = toWiderRegion row col width
2504 Report.Report "BAD UNICODE ESCAPE" region [] $
2505 Code.toSnippet source region Nothing
2508 "This is not a valid code point:"
2511 "The valid code points are between 0 and 10FFFF inclusive."
2514 BadUnicodeLength width numDigits badCode ->
2516 region = toWiderRegion row col width
2518 Report.Report "BAD UNICODE ESCAPE" region [] $
2519 Code.toSnippet source region Nothing $
2520 if numDigits < 4 then
2523 "Every code point needs at least four digits:"
2526 goodCode = replicate (4 - numDigits) '0' ++ map Char.toUpper (showHex badCode "")
2527 suggestion = "\\u{" <> D.fromChars goodCode <> "}"
2529 D.fillSep ["Try",D.green suggestion,"instead?"]
2535 "This code point has too many digits:"
2538 ["Valid","code","points","are","between"
2539 ,D.green "\\u{0000}","and",D.green "\\u{10FFFF}" <> ","
2540 ,"so","try","trimming","any","leading","zeros","until"
2541 ,"you","have","between","four","and","six","digits."
2550toNumberReport :: Code.Source -> Number -> Row -> Col -> Report.Report
2551toNumberReport source number row col =
2553 region = toRegion row col
2557 Report.Report "WEIRD NUMBER" region [] $
2558 Code.toSnippet source region Nothing
2561 "I thought I was reading a number, but I ran into some weird stuff here:"
2565 "I recognize numbers in the following formats:"
2566 , D.indent 4 $ D.vcat [ "42", "3.14", "6.022e23", "0x002B" ]
2568 "So is there a way to write it like one of those?"
2573 Report.Report "WEIRD NUMBER" region [] $
2574 Code.toSnippet source region Nothing
2577 "Numbers cannot end with a dot like this:"
2580 ["Switching","to",D.green (D.fromChars (show int))
2581 ,"or",D.green (D.fromChars (show int ++ ".0"))
2582 ,"will","work","though!"
2587 Report.Report "WEIRD HEXIDECIMAL" region [] $
2588 Code.toSnippet source region Nothing
2591 "I thought I was reading a hexidecimal number until I got here:"
2595 "Valid hexidecimal digits include 0123456789abcdefABCDEF, so I can\
2596 \ only recognize things like this:"
2597 , D.indent 4 $ D.vcat [ "0x2B", "0x002B", "0x00ffb3" ]
2601 NumberNoLeadingZero ->
2602 Report.Report "LEADING ZEROS" region [] $
2603 Code.toSnippet source region Nothing
2606 "I do not accept numbers with leading zeros:"
2610 "Just delete the leading zeros and it should work!"
2612 "Some languages let you to specify octal numbers by adding a leading zero.\
2613 \ So in C, writing 0111 is the same as writing 73. Some people are used to\
2614 \ that, but others probably want it to equal 111. Either path is going to\
2615 \ surprise people from certain backgrounds, so Elm tries to avoid this whole\
2625toOperatorReport :: Code.Source -> Context -> BadOperator -> Row -> Col -> Report.Report
2626toOperatorReport source context operator row col =
2630 region = toRegion row col
2632 Report.Report "UNEXPECTED SYMBOL" region [] $
2633 Code.toSnippet source region Nothing
2635 "I was not expecting this dot:"
2638 "Dots are for record access and decimal points, so\
2639 \ they cannot float around on their own. Maybe\
2640 \ there is some extra whitespace?"
2645 region = toRegion row col
2647 Report.Report "UNEXPECTED SYMBOL" region [] $
2648 Code.toSnippet source region Nothing
2651 "I was not expecting this vertical bar:"
2654 "Vertical bars should only appear in custom type declarations. Maybe you want || instead?"
2659 region = toWiderRegion row col 2
2661 Report.Report "UNEXPECTED ARROW" region [] $
2662 Code.toSnippet source region Nothing $
2663 if isWithin NBranch context then
2666 "I was not expecting to see an arrow here:"
2671 "I think I am parsing a `case` expression right now, so it makes sense to\
2672 \ see arrows around here. This one is confusing me though!"
2675 "I may be getting confused by the indentation. Every pattern in a `case` must be\
2676 \ exactly aligned (with exactly the same amount of indentation) so maybe this arrow\
2677 \ appears after the next `case` pattern (correctly!) but the pattern itself is\
2678 \ indented too far?"
2685 "I was not expecting an arrow here:"
2688 "Arrows should only appear in `case` expressions and anonymous functions. Maybe\
2689 \ you want > or >= instead?"
2694 region = toRegion row col
2696 Report.Report "UNEXPECTED EQUALS" region [] $
2697 Code.toSnippet source region Nothing
2700 "I was not expecting to see this equals sign:"
2704 D.reflow "Maybe you want == instead? To check if two values are equal?"
2707 if isWithin NRecord context then
2708 "Records look like { x = 3, y = 4 } with the equals sign right\
2709 \ after the field name. So maybe you forgot a comma?"
2711 case getDefName context of
2713 "I may be getting confused by your indentation. I need all definitions to be indented\
2714 \ exactly the same amount, so if this is meant to be a new definition, it may have too\
2715 \ many spaces in front of it."
2718 "I may be getting confused by your indentation. I think I am still parsing the `"
2719 ++ Name.toChars name ++ "` definition. Is this supposed to be part of a definition\
2720 \ after that? If so, the problem may be a bit before the equals sign. I need all\
2721 \ definitions to be indented exactly the same amount, so the problem may be that\
2722 \ this new definition has too many spaces in front of it."
2728 region = toRegion row col
2730 Report.Report "UNEXPECTED SYMBOL" region [] $
2731 Code.toSnippet source region Nothing $
2734 "I was not expecting to run into the \"has type\" symbol here:"
2736 case getDefName context of
2739 ["Maybe","you","want",D.green "::","instead?"
2740 ,"To","put","something","on","the","front","of","a","list?"
2747 ["Maybe","you","want",D.green "::","instead?"
2748 ,"To","put","something","on","the","front","of","a","list?"
2751 "The single colon is reserved for type annotations and record types, but I think\
2752 \ I am parsing the definition of `" ++ Name.toChars name ++ "` right now."
2755 "I may be getting confused by your indentation. Is this supposed to be part of\
2756 \ a type annotation AFTER the `" ++ Name.toChars name ++ "` definition? If so,\
2757 \ the problem may be a bit before the \"has type\" symbol. I need all definitions to\
2758 \ be exactly aligned (with exactly the same indentation) so the problem may be that\
2759 \ this new definition is indented a bit too much."
2768toLetReport :: Code.Source -> Context -> Let -> Row -> Col -> Report.Report
2769toLetReport source context let_ startRow startCol =
2771 LetSpace space row col ->
2772 toSpaceReport source space row col
2776 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2777 region = toRegion row col
2779 Report.Report "LET PROBLEM" region [] $
2780 Code.toSnippet source surroundings (Just region)
2783 "I was partway through parsing a `let` expression, but I got stuck here:"
2787 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2788 ,"keyword","next.","Is","there","a","typo?"
2791 "This can also happen if you are trying to define another value within the `let` but\
2792 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2793 \ spaces before it. They should line up exactly!"
2797 LetDefAlignment _ row col ->
2799 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2800 region = toRegion row col
2802 Report.Report "LET PROBLEM" region [] $
2803 Code.toSnippet source surroundings (Just region)
2806 "I was partway through parsing a `let` expression, but I got stuck here:"
2810 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2811 ,"keyword","next.","Is","there","a","typo?"
2814 "This can also happen if you are trying to define another value within the `let` but\
2815 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2816 \ spaces before it. The should line up exactly!"
2820 LetDefName row col ->
2821 case Code.whatIsNext source row col of
2822 Code.Keyword keyword ->
2824 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2825 region = toKeywordRegion row col keyword
2827 Report.Report "RESERVED WORD" region [] $
2828 Code.toSnippet source surroundings (Just region)
2831 "I was partway through parsing a `let` expression, but I got stuck here:"
2834 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but\
2835 \ it is a reserved word! Try using a different name instead."
2839 toUnfinishLetReport source row col startRow startCol $
2841 "I was expecting the name of a definition next."
2843 LetDef name def row col ->
2844 toLetDefReport source name def row col
2846 LetDestruct destruct row col ->
2847 toLetDestructReport source destruct row col
2849 LetBody expr row col ->
2850 toExprReport source context expr row col
2852 LetIndentDef row col ->
2853 toUnfinishLetReport source row col startRow startCol $
2855 "I was expecting a value to be defined here."
2857 LetIndentIn row col ->
2858 toUnfinishLetReport source row col startRow startCol $
2860 ["I","was","expecting","to","see","the",D.cyan "in","keyword","next."
2861 ,"Or","maybe","more","of","that","expression?"
2864 LetIndentBody row col ->
2865 toUnfinishLetReport source row col startRow startCol $
2867 "I was expecting an expression next. Tell me what should happen with the value you just defined!"
2870toUnfinishLetReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
2871toUnfinishLetReport source row col startRow startCol message =
2873 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2874 region = toRegion row col
2876 Report.Report "UNFINISHED LET" region [] $
2877 Code.toSnippet source surroundings (Just region)
2880 "I was partway through parsing a `let` expression, but I got stuck here:"
2885 "Here is an example with a valid `let` expression for reference:"
2887 [ D.indent 0 $ D.fillSep [D.green "viewPerson","person","="]
2888 , D.indent 2 $ D.fillSep [D.cyan "let"]
2889 , D.indent 4 $ D.fillSep ["fullName","="]
2890 , D.indent 6 $ D.fillSep ["person.firstName","++",D.dullyellow "\" \"","++","person.lastName"]
2891 , D.indent 2 $ D.fillSep [D.cyan "in"]
2892 , D.indent 2 $ D.fillSep ["div","[]","[","text","fullName","]"]
2895 "Here we defined a `viewPerson` function that turns a person into some HTML. We use\
2896 \ a `let` expression to define the `fullName` we want to show. Notice the indentation! The\
2897 \ `fullName` is indented more than the `let` keyword, and the actual value of `fullName` is\
2898 \ indented a bit more than that. That is important!"
2903toLetDefReport :: Code.Source -> Name.Name -> Def -> Row -> Col -> Report.Report
2904toLetDefReport source name def startRow startCol =
2906 DefSpace space row col ->
2907 toSpaceReport source space row col
2909 DefType tipe row col ->
2910 toTypeReport source (TC_Annotation name) tipe row col
2912 DefNameRepeat row col ->
2914 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2915 region = toRegion row col
2917 Report.Report "EXPECTING DEFINITION" region [] $
2918 Code.toSnippet source surroundings (Just region)
2921 "I just saw the type annotation for `" ++ Name.toChars name
2922 ++ "` so I was expecting to see its definition here:"
2926 "Type annotations always appear directly above the relevant\
2927 \ definition, without anything else in between."
2932 DefNameMatch defName row col ->
2934 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2935 region = toRegion row col
2937 Report.Report "NAME MISMATCH" region [] $
2938 Code.toSnippet source surroundings (Just region)
2941 "I just saw a type annotation for `" ++ Name.toChars name ++ "`, but it is followed by a definition for `" ++ Name.toChars defName ++ "`:"
2945 "These names do not match! Is there a typo?"
2946 , D.indent 4 $ D.fillSep $
2947 [D.dullyellow (D.fromName defName),"->",D.green (D.fromName name)]
2951 DefArg pattern row col ->
2952 toPatternReport source PArg pattern row col
2954 DefEquals row col ->
2955 case Code.whatIsNext source row col of
2956 Code.Keyword keyword ->
2958 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2959 region = toKeywordRegion row col keyword
2961 Report.Report "RESERVED WORD" region [] $
2962 Code.toSnippet source surroundings (Just region)
2965 "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
2968 "This is a reserved word! Try using some other name?"
2973 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2974 region = toKeywordRegion row col op
2976 Report.Report "UNEXPECTED SYMBOL" region [] $
2977 Code.toSnippet source surroundings (Just region)
2980 "I was not expecting to see this symbol here:"
2984 "I am not sure what is going wrong exactly, so here is a valid\
2985 \ definition (with an optional type annotation) for reference:"
2987 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2988 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
2989 , D.indent 6 $ D.fillSep ["x","+","y"]
2992 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
2998 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2999 region = toRegion row col
3001 Report.Report "PROBLEM IN DEFINITION" region [] $
3002 Code.toSnippet source surroundings (Just region)
3005 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3009 "I am not sure what is going wrong exactly, so here is a valid\
3010 \ definition (with an optional type annotation) for reference:"
3012 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3013 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3014 , D.indent 4 $ D.fillSep ["x","+","y"]
3017 "Try to use that format!"
3021 DefBody expr row col ->
3022 toExprReport source (InDef name startRow startCol) expr row col
3024 DefIndentEquals row col ->
3026 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3027 region = toRegion row col
3029 Report.Report "UNFINISHED DEFINITION" region [] $
3030 Code.toSnippet source surroundings (Just region)
3033 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3037 "I was expecting to see an argument or an equals sign next."
3042 DefIndentType row col ->
3044 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3045 region = toRegion row col
3047 Report.Report "UNFINISHED DEFINITION" region [] $
3048 Code.toSnippet source surroundings (Just region)
3051 "I got stuck while parsing the `" ++ Name.toChars name ++ "` type annotation:"
3055 "I just saw a colon, so I am expecting to see a type next."
3060 DefIndentBody row col ->
3062 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3063 region = toRegion row col
3065 Report.Report "UNFINISHED DEFINITION" region [] $
3066 Code.toSnippet source surroundings (Just region)
3069 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3073 "I was expecting to see an expression next. What is it equal to?"
3078 DefAlignment indent row col ->
3080 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3081 region = toRegion row col
3082 offset = indent - col
3084 Report.Report "PROBLEM IN DEFINITION" region [] $
3085 Code.toSnippet source surroundings (Just region)
3088 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3091 "I just saw a type annotation indented " ++ show indent ++ " spaces, so I was\
3092 \ expecting to see the corresponding definition next with the exact same amount\
3093 \ of indentation. It looks like this line needs "
3094 ++ show offset ++ " more " ++ (if offset == 1 then "space" else "spaces") ++ "?"
3103 "Here is a valid definition (with a type annotation) for reference:"
3105 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3106 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3107 , D.indent 6 $ D.fillSep ["x","+","y"]
3110 "The top line (called a \"type annotation\") is optional. You can leave it off\
3111 \ if you want. As you get more comfortable with Elm and as your project grows,\
3112 \ it becomes more and more valuable to add them though! They work great as\
3113 \ compiler-verified documentation, and they often improve error messages!"
3117toLetDestructReport :: Code.Source -> Destruct -> Row -> Col -> Report.Report
3118toLetDestructReport source destruct startRow startCol =
3120 DestructSpace space row col ->
3121 toSpaceReport source space row col
3123 DestructPattern pattern row col ->
3124 toPatternReport source PLet pattern row col
3126 DestructEquals row col ->
3128 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3129 region = toRegion row col
3131 Report.Report "PROBLEM IN DEFINITION" region [] $
3132 Code.toSnippet source surroundings (Just region)
3135 "I got stuck trying to parse this definition:"
3137 case Code.whatIsNext source row col of
3138 Code.Operator ":" ->
3141 "I was expecting to see an equals sign next, followed by an expression\
3142 \ telling me what to compute."
3144 "It looks like you may be trying to write a type annotation? It is not\
3145 \ possible to add type annotations on destructuring definitions like this.\
3146 \ You can assign a name to the overall structure, put a type annotation on\
3147 \ that, and then destructure separately though."
3152 "I was expecting to see an equals sign next, followed by an expression\
3153 \ telling me what to compute."
3156 DestructBody expr row col ->
3157 toExprReport source (InDestruct startRow startCol) expr row col
3159 DestructIndentEquals row col ->
3161 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3162 region = toRegion row col
3164 Report.Report "UNFINISHED DEFINITION" region [] $
3165 Code.toSnippet source surroundings (Just region)
3168 "I got stuck trying to parse this definition:"
3171 "I was expecting to see an equals sign next, followed by an expression\
3172 \ telling me what to compute."
3175 DestructIndentBody row col ->
3177 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3178 region = toRegion row col
3180 Report.Report "UNFINISHED DEFINITION" region [] $
3181 Code.toSnippet source surroundings (Just region)
3184 "I got stuck while parsing this definition:"
3187 "I was expecting to see an expression next. What is it equal to?"
3195toCaseReport :: Code.Source -> Context -> Case -> Row -> Col -> Report.Report
3196toCaseReport source context case_ startRow startCol =
3198 CaseSpace space row col ->
3199 toSpaceReport source space row col
3202 toUnfinishCaseReport source row col startRow startCol $
3203 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3205 CasePattern pattern row col ->
3206 toPatternReport source PCase pattern row col
3208 CaseArrow row col ->
3209 case Code.whatIsNext source row col of
3210 Code.Keyword keyword ->
3212 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3213 region = toKeywordRegion row col keyword
3215 Report.Report "RESERVED WORD" region [] $
3216 Code.toSnippet source surroundings (Just region)
3219 "I am partway through parsing a `case` expression, but I got stuck here:"
3222 "It looks like you are trying to use `" ++ keyword ++ "` in one of your\
3223 \ patterns, but it is a reserved word. Try using a different name?"
3226 Code.Operator ":" ->
3228 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3229 region = toRegion row col
3231 Report.Report "UNEXPECTED OPERATOR" region [] $
3232 Code.toSnippet source surroundings (Just region)
3235 "I am partway through parsing a `case` expression, but I got stuck here:"
3238 ["I","am","seeing",D.dullyellow ":","but","maybe","you","want",D.green "::","instead?"
3239 ,"For","pattern","matching","on","lists?"
3243 Code.Operator "=" ->
3245 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3246 region = toRegion row col
3248 Report.Report "UNEXPECTED OPERATOR" region [] $
3249 Code.toSnippet source surroundings (Just region)
3252 "I am partway through parsing a `case` expression, but I got stuck here:"
3255 ["I","am","seeing",D.dullyellow "=","but","maybe","you","want",D.green "->","instead?"
3261 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3262 region = toRegion row col
3264 Report.Report "MISSING ARROW" region [] $
3265 Code.toSnippet source surroundings (Just region)
3268 "I am partway through parsing a `case` expression, but I got stuck here:"
3270 addNoteForCaseIndentError $
3272 "I was expecting to see an arrow next."
3275 CaseExpr expr row col ->
3276 toExprReport source (InNode NCase startRow startCol context) expr row col
3278 CaseBranch expr row col ->
3279 toExprReport source (InNode NBranch startRow startCol context) expr row col
3281 CaseIndentOf row col ->
3282 toUnfinishCaseReport source row col startRow startCol $
3283 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3285 CaseIndentExpr row col ->
3286 toUnfinishCaseReport source row col startRow startCol $
3287 D.reflow "I was expecting to see a expression next."
3289 CaseIndentPattern row col ->
3290 toUnfinishCaseReport source row col startRow startCol $
3291 D.reflow "I was expecting to see a pattern next."
3293 CaseIndentArrow row col ->
3294 toUnfinishCaseReport source row col startRow startCol $
3296 ["I","just","saw","a","pattern,","so","I","was","expecting"
3297 ,"to","see","a",D.dullyellow "->","next."
3300 CaseIndentBranch row col ->
3301 toUnfinishCaseReport source row col startRow startCol $
3303 "I was expecting to see an expression next. What should I do when\
3304 \ I run into this particular pattern?"
3306 CasePatternAlignment indent row col ->
3307 toUnfinishCaseReport source row col startRow startCol $
3309 "I suspect this is a pattern that is not indented far enough? (" ++ show indent ++ " spaces)"
3312toUnfinishCaseReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
3313toUnfinishCaseReport source row col startRow startCol message =
3315 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3316 region = toRegion row col
3318 Report.Report "UNFINISHED CASE" region [] $
3319 Code.toSnippet source surroundings (Just region)
3322 "I was partway through parsing a `case` expression, but I got stuck here:"
3327 "Here is an example of a valid `case` expression for reference."
3329 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3330 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3331 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3333 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3334 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3337 "Notice the indentation. Each pattern is aligned, and each branch is indented\
3338 \ a bit more than the corresponding pattern. That is important!"
3343addNoteForCaseIndentError :: D.Doc -> D.Doc
3344addNoteForCaseIndentError message =
3349 "Sometimes I get confused by indentation, so try to make your `case` look\
3350 \ something like this:"
3352 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3353 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3354 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3356 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3357 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3360 "Notice the indentation! Each pattern is aligned, and each branch is indented\
3361 \ a bit more than the corresponding pattern. That is important!"
3369toIfReport :: Code.Source -> Context -> If -> Row -> Col -> Report.Report
3370toIfReport source context if_ startRow startCol =
3372 IfSpace space row col ->
3373 toSpaceReport source space row col
3377 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3378 region = toRegion row col
3380 Report.Report "UNFINISHED IF" region [] $
3381 Code.toSnippet source surroundings (Just region)
3384 "I was expecting to see more of this `if` expression, but I got stuck here:"
3387 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3393 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3394 region = toRegion row col
3396 Report.Report "UNFINISHED IF" region [] $
3397 Code.toSnippet source surroundings (Just region)
3400 "I was expecting to see more of this `if` expression, but I got stuck here:"
3403 ["I","was","expecting","to","see","the",D.cyan "else","keyword","next."
3407 IfElseBranchStart row col ->
3409 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3410 region = toRegion row col
3412 Report.Report "UNFINISHED IF" region [] $
3413 Code.toSnippet source surroundings (Just region)
3416 "I just saw the start of an `else` branch, but then I got stuck here:"
3419 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3422 IfCondition expr row col ->
3423 toExprReport source (InNode NCond startRow startCol context) expr row col
3425 IfThenBranch expr row col ->
3426 toExprReport source (InNode NThen startRow startCol context) expr row col
3428 IfElseBranch expr row col ->
3429 toExprReport source (InNode NElse startRow startCol context) expr row col
3431 IfIndentCondition row col ->
3433 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3434 region = toRegion row col
3436 Report.Report "UNFINISHED IF" region [] $
3437 Code.toSnippet source surroundings (Just region)
3440 "I was expecting to see more of this `if` expression, but I got stuck here:"
3444 ["I","was","expecting","to","see","an","expression","like",D.dullyellow "x < 0"
3445 ,"that","evaluates","to","True","or","False."
3448 "I can be confused by indentation. Maybe something is not indented enough?"
3452 IfIndentThen row col ->
3454 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3455 region = toRegion row col
3457 Report.Report "UNFINISHED IF" region [] $
3458 Code.toSnippet source surroundings (Just region)
3461 "I was expecting to see more of this `if` expression, but I got stuck here:"
3465 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3468 "I can be confused by indentation. Maybe something is not indented enough?"
3472 IfIndentThenBranch row col ->
3474 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3475 region = toRegion row col
3477 Report.Report "UNFINISHED IF" region [] $
3478 Code.toSnippet source surroundings (Just region)
3481 "I got stuck after the start of this `then` branch:"
3485 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3487 "I can be confused by indentation, so if the `then` branch is already\
3488 \ present, it may not be indented enough for me to recognize it."
3492 IfIndentElseBranch row col ->
3494 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3495 region = toRegion row col
3497 Report.Report "UNFINISHED IF" region [] $
3498 Code.toSnippet source surroundings (Just region)
3501 "I got stuck after the start of this `else` branch:"
3505 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3507 "I can be confused by indentation, so if the `else` branch is already\
3508 \ present, it may not be indented enough for me to recognize it."
3512 IfIndentElse row col ->
3514 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3515 region = toRegion row col
3517 Report.Report "UNFINISHED IF" region [] $
3518 Code.toSnippet source surroundings (Just region)
3521 "I was expecting to see an `else` branch after this:"
3525 "I know what to do when the condition is `True`, but not when it is `False`."
3527 ["Add","an",D.cyan "else","branch","to","handle","that","scenario!"]
3536toRecordReport :: Code.Source -> Context -> Record -> Row -> Col -> Report.Report
3537toRecordReport source context record startRow startCol =
3539 RecordOpen row col ->
3540 case Code.whatIsNext source row col of
3541 Code.Keyword keyword ->
3543 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3544 region = toKeywordRegion row col keyword
3546 Report.Report "RESERVED WORD" region [] $
3547 Code.toSnippet source surroundings (Just region)
3550 "I just started parsing a record, but I got stuck on this field name:"
3553 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3554 \ that is a reserved word. Try using a different name!"
3559 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3560 region = toRegion row col
3562 Report.Report "UNFINISHED RECORD" region [] $
3563 Code.toSnippet source surroundings (Just region)
3566 "I just started parsing a record, but I got stuck here:"
3569 ["Records","look","like",D.dullyellow "{ x = 3, y = 4 },"
3570 ,"so","I","was","expecting","to","see","a","field","name","next."
3574 RecordEnd row col ->
3576 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3577 region = toRegion row col
3579 Report.Report "UNFINISHED RECORD" region [] $
3580 Code.toSnippet source surroundings (Just region)
3583 "I am partway through parsing a record, but I got stuck here:"
3587 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
3588 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
3591 "When I get stuck like this, it usually means that there is a missing parenthesis\
3592 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
3596 RecordField row col ->
3597 case Code.whatIsNext source row col of
3598 Code.Keyword keyword ->
3600 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3601 region = toKeywordRegion row col keyword
3603 Report.Report "RESERVED WORD" region [] $
3604 Code.toSnippet source surroundings (Just region)
3607 "I am partway through parsing a record, but I got stuck on this field name:"
3610 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3611 \ that is a reserved word. Try using a different name!"
3616 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3617 region = toRegion row col
3619 Report.Report "UNFINISHED RECORD" region [] $
3620 Code.toSnippet source surroundings (Just region)
3623 "I am partway through parsing a record, but I got stuck after that last comma:"
3625 addNoteForRecordError $
3627 "Trailing commas are not allowed in records, so I was expecting to see another\
3628 \ record field defined next. If you are done defining the record, the fix may\
3629 \ be to delete that last comma?"
3632 RecordEquals row col ->
3634 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3635 region = toRegion row col
3637 Report.Report "UNFINISHED RECORD" region [] $
3638 Code.toSnippet source surroundings (Just region)
3641 "I am partway through parsing a record, but I got stuck here:"
3643 addNoteForRecordError $
3645 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
3646 ,"an","equals","sign","next.","So","try","putting","an",D.green "=","sign","here?"
3650 RecordExpr expr row col ->
3651 toExprReport source (InNode NRecord startRow startCol context) expr row col
3653 RecordSpace space row col ->
3654 toSpaceReport source space row col
3656 RecordIndentOpen row col ->
3658 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3659 region = toRegion row col
3661 Report.Report "UNFINISHED RECORD" region [] $
3662 Code.toSnippet source surroundings (Just region)
3665 "I just saw the opening curly brace of a record, but then I got stuck here:"
3667 addNoteForRecordIndentError $
3669 ["I","am","expecting","a","record","like",D.dullyellow "{ x = 3, y = 4 }","here."
3670 ,"Try","defining","some","fields","of","your","own?"
3674 RecordIndentEnd row col ->
3676 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3677 region = toRegion row col
3679 Report.Report "UNFINISHED RECORD" region [] $
3680 Code.toSnippet source surroundings (Just region)
3683 "I was expecting to see a closing curly brace next:"
3685 addNoteForRecordIndentError $
3687 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
3691 RecordIndentField row col ->
3693 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3694 region = toRegion row col
3696 Report.Report "UNFINISHED RECORD" region [] $
3697 Code.toSnippet source surroundings (Just region)
3700 "I am partway through parsing a record, but I got stuck after that last comma:"
3702 addNoteForRecordError $
3704 "Trailing commas are not allowed in records, so the fix may be to\
3705 \ delete that last comma? Or maybe you were in the middle of defining\
3706 \ an additional field?"
3709 RecordIndentEquals row col ->
3711 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3712 region = toRegion row col
3714 Report.Report "UNFINISHED RECORD" region [] $
3715 Code.toSnippet source surroundings (Just region)
3718 "I am partway through parsing a record. I just saw a record\
3719 \ field, so I was expecting to see an equals sign next:"
3721 addNoteForRecordIndentError $
3723 ["Try","putting","an",D.green "=","followed","by","an","expression?"
3727 RecordIndentExpr row col ->
3729 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3730 region = toRegion row col
3732 Report.Report "UNFINISHED RECORD" region [] $
3733 Code.toSnippet source surroundings (Just region)
3736 "I am partway through parsing a record, and I was expecting to run into an expression next:"
3738 addNoteForRecordIndentError $
3740 ["Try","putting","something","like"
3741 ,D.dullyellow "42","or",D.dullyellow"\"hello\"","for","now?"
3746addNoteForRecordError :: D.Doc -> D.Doc
3747addNoteForRecordError normalRecommendation =
3749 normalRecommendation
3752 "If you are trying to define a record across multiple lines, I recommend using this format:"
3753 , D.indent 4 $ D.vcat $
3754 [ "{ name = \"Alice\""
3760 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3761 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3762 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3766addNoteForRecordIndentError :: D.Doc -> D.Doc
3767addNoteForRecordIndentError normalRecommendation =
3769 normalRecommendation
3772 "I may be confused by indentation. For example, if you are trying to define\
3773 \ a record across multiple lines, I recommend using this format:"
3774 , D.indent 4 $ D.vcat $
3775 [ "{ name = \"Alice\""
3781 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3782 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3783 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3791toTupleReport :: Code.Source -> Context -> Tuple -> Row -> Col -> Report.Report
3792toTupleReport source context tuple startRow startCol =
3794 TupleExpr expr row col ->
3795 toExprReport source (InNode NParens startRow startCol context) expr row col
3797 TupleSpace space row col ->
3798 toSpaceReport source space row col
3802 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3803 region = toRegion row col
3805 Report.Report "UNFINISHED PARENTHESES" region [] $
3806 Code.toSnippet source surroundings (Just region)
3809 "I was expecting to see a closing parentheses next, but I got stuck here:"
3812 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
3814 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
3815 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
3816 \ or missing brackets) that is confusing me."
3820 TupleOperatorClose row col ->
3822 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3823 region = toRegion row col
3825 Report.Report "UNFINISHED OPERATOR FUNCTION" region [] $
3826 Code.toSnippet source surroundings (Just region)
3828 D.reflow "I was expecting a closing parenthesis here:"
3831 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
3833 "I think I am parsing an operator function right now, so I am expecting to see\
3834 \ something like (+) or (&&) where an operator is surrounded by parentheses with\
3839 TupleOperatorReserved operator row col ->
3841 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3842 region = toRegion row col
3844 Report.Report "UNEXPECTED SYMBOL" region [] $
3845 Code.toSnippet source surroundings (Just region)
3848 "I ran into an unexpected symbol here:"
3852 BadDot -> ["Maybe","you","wanted","a","record","accessor","like",D.dullyellow ".x","or",D.dullyellow ".name","instead?"]
3853 BadPipe -> ["Try",D.dullyellow "(||)","instead?","To","turn","boolean","OR","into","a","function?"]
3854 BadArrow -> ["Maybe","you","wanted",D.dullyellow "(>)","or",D.dullyellow "(>=)","instead?"]
3855 BadEquals -> ["Try",D.dullyellow "(==)","instead?","To","make","a","function","that","checks","equality?"]
3856 BadHasType -> ["Try",D.dullyellow "(::)","instead?","To","add","values","to","the","front","of","lists?"]
3859 TupleIndentExpr1 row col ->
3861 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3862 region = toRegion row col
3864 Report.Report "UNFINISHED PARENTHESES" region [] $
3865 Code.toSnippet source surroundings (Just region)
3868 "I just saw an open parenthesis, so I was expecting to see an expression next."
3872 ["Something","like",D.dullyellow "(4 + 5)","or"
3873 ,D.dullyellow "(String.reverse \"desserts\")" <> "."
3874 ,"Anything","where","you","are","putting","parentheses","around","normal","expressions."
3877 "I can get confused by indentation in cases like this, so\
3878 \ maybe you have an expression but it is not indented enough?"
3882 TupleIndentExprN row col ->
3884 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3885 region = toRegion row col
3887 Report.Report "UNFINISHED TUPLE" region [] $
3888 Code.toSnippet source surroundings (Just region)
3891 "I think I am in the middle of parsing a tuple. I just saw a comma, so I was expecting to see an expression next."
3895 ["A","tuple","looks","like",D.dullyellow "(3,4)","or"
3896 ,D.dullyellow "(\"Tom\",42)" <> ","
3897 ,"so","I","think","there","is","an","expression","missing","here?"
3900 "I can get confused by indentation in cases like this, so\
3901 \ maybe you have an expression but it is not indented enough?"
3905 TupleIndentEnd row col ->
3907 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3908 region = toRegion row col
3910 Report.Report "UNFINISHED PARENTHESES" region [] $
3911 Code.toSnippet source surroundings (Just region)
3914 "I was expecting to see a closing parenthesis next:"
3917 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
3919 "I can get confused by indentation in cases like this, so\
3920 \ maybe you have a closing parenthesis but it is not indented enough?"
3925toListReport :: Code.Source -> Context -> List -> Row -> Col -> Report.Report
3926toListReport source context list startRow startCol =
3928 ListSpace space row col ->
3929 toSpaceReport source space row col
3933 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3934 region = toRegion row col
3936 Report.Report "UNFINISHED LIST" region [] $
3937 Code.toSnippet source surroundings (Just region)
3940 "I am partway through parsing a list, but I got stuck here:"
3944 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
3945 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
3948 "When I get stuck like this, it usually means that there is a missing parenthesis\
3949 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
3953 ListExpr expr row col ->
3957 surroundings = A.Region (A.Position startRow startCol) (A.Position r c)
3958 region = toRegion r c
3960 Report.Report "UNFINISHED LIST" region [] $
3961 Code.toSnippet source surroundings (Just region)
3964 "I was expecting to see another list entry after that last comma:"
3968 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
3970 "I recommend using the following format for lists that span multiple lines:"
3971 , D.indent 4 $ D.vcat $
3978 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
3979 \ This style can be jarring for people coming from C-like syntax, but folks generally\
3980 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3985 toExprReport source (InNode NList startRow startCol context) expr row col
3989 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3990 region = toRegion row col
3992 Report.Report "UNFINISHED LIST" region [] $
3993 Code.toSnippet source surroundings (Just region)
3996 "I am partway through parsing a list, but I got stuck here:"
4000 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
4001 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
4004 "When I get stuck like this, it usually means that there is a missing parenthesis\
4005 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4009 ListIndentOpen row col ->
4011 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4012 region = toRegion row col
4014 Report.Report "UNFINISHED LIST" region [] $
4015 Code.toSnippet source surroundings (Just region)
4018 "I cannot find the end of this list:"
4022 ["You","could","change","it","to","something","like"
4023 ,D.dullyellow "[3,4,5]"
4025 ,D.dullyellow "[]" <> "."
4026 ,"Anything","where","there","is","an","open","and","close","square","brace,"
4027 ,"and","where","the","elements","of","the","list","are","separated","by","commas."
4030 "I may be confused by indentation. For example, if you are trying to define\
4031 \ a list across multiple lines, I recommend using this format:"
4032 , D.indent 4 $ D.vcat $
4039 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4040 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4041 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4045 ListIndentEnd row col ->
4047 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4048 region = toRegion row col
4050 Report.Report "UNFINISHED LIST" region [] $
4051 Code.toSnippet source surroundings (Just region)
4054 "I cannot find the end of this list:"
4058 ["You","can","just","add","a","closing",D.dullyellow "]"
4059 ,"right","here,","and","I","will","be","all","set!"
4062 "I may be confused by indentation. For example, if you are trying to define\
4063 \ a list across multiple lines, I recommend using this format:"
4064 , D.indent 4 $ D.vcat $
4071 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4072 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4073 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4077 ListIndentExpr row col ->
4079 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4080 region = toRegion row col
4082 Report.Report "UNFINISHED LIST" region [] $
4083 Code.toSnippet source surroundings (Just region)
4086 "I was expecting to see another list entry after this comma:"
4090 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
4092 "I recommend using the following format for lists that span multiple lines:"
4093 , D.indent 4 $ D.vcat $
4100 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4101 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4102 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4107toFuncReport :: Code.Source -> Context -> Func -> Row -> Col -> Report.Report
4108toFuncReport source context func startRow startCol =
4110 FuncSpace space row col ->
4111 toSpaceReport source space row col
4113 FuncArg pattern row col ->
4114 toPatternReport source PArg pattern row col
4116 FuncBody expr row col ->
4117 toExprReport source (InNode NFunc startRow startCol context) expr row col
4119 FuncArrow row col ->
4120 case Code.whatIsNext source row col of
4121 Code.Keyword keyword ->
4123 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4124 region = toKeywordRegion row col keyword
4126 Report.Report "RESERVED WORD" region [] $
4127 Code.toSnippet source surroundings (Just region)
4130 "I was parsing an anonymous function, but I got stuck here:"
4133 "It looks like you are trying to use `" ++ keyword ++ "` as an argument, but\
4134 \ it is a reserved word in this language. Try using a different argument name!"
4139 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4140 region = toRegion row col
4142 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4143 Code.toSnippet source surroundings (Just region)
4146 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4149 ["The","syntax","for","anonymous","functions","is"
4150 ,D.dullyellow "(\\x -> x + 1)"
4151 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4155 FuncIndentArg row col ->
4157 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4158 region = toRegion row col
4160 Report.Report "MISSING ARGUMENT" region [] $
4161 Code.toSnippet source surroundings (Just region)
4164 "I just saw the beginning of an anonymous function, so I was expecting to see an argument next:"
4168 ["Something","like",D.dullyellow"x","or",D.dullyellow "name" <> "."
4169 ,"Anything","that","starts","with","a","lower","case","letter!"
4172 "The syntax for anonymous functions is (\\x -> x + 1) where the backslash\
4173 \ is meant to look a bit like a lambda if you squint. This visual pun seemed\
4174 \ like a better idea at the time!"
4178 FuncIndentArrow row col ->
4180 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4181 region = toRegion row col
4183 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4184 Code.toSnippet source surroundings (Just region)
4187 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4191 ["The","syntax","for","anonymous","functions","is"
4192 ,D.dullyellow "(\\x -> x + 1)"
4193 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4196 "It is possible that I am confused about indetation! I generally recommend\
4197 \ switching to named functions if the definition cannot fit inline nicely, so\
4198 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4199 \ the whole thing out into a named function. Things tend to be clearer that way!"
4203 FuncIndentBody row col ->
4205 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4206 region = toRegion row col
4208 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4209 Code.toSnippet source surroundings (Just region)
4212 "I was expecting to see the body of your anonymous function next:"
4216 ["The","syntax","for","anonymous","functions","is"
4217 ,D.dullyellow "(\\x -> x + 1)"
4218 ,"so","I","am","missing","all","the","stuff","after","the","arrow!"
4221 "It is possible that I am confused about indetation! I generally recommend\
4222 \ switching to named functions if the definition cannot fit inline nicely, so\
4223 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4224 \ the whole thing out into a named function. Things tend to be clearer that way!"
4239toPatternReport :: Code.Source -> PContext -> Pattern -> Row -> Col -> Report.Report
4240toPatternReport source context pattern startRow startCol =
4242 PRecord record row col ->
4243 toPRecordReport source record row col
4245 PTuple tuple row col ->
4246 toPTupleReport source context tuple row col
4248 PList list row col ->
4249 toPListReport source context list row col
4252 case Code.whatIsNext source row col of
4253 Code.Keyword keyword ->
4255 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4256 region = toKeywordRegion row col keyword
4259 PArg -> "as an argument"
4260 PCase -> "in this pattern"
4261 PLet -> "in this pattern"
4263 Report.Report "RESERVED WORD" region [] $
4264 Code.toSnippet source surroundings (Just region)
4267 "It looks like you are trying to use `" ++ keyword ++ "` " ++ inThisThing ++ ":"
4270 "This is a reserved word! Try using some other name?"
4276 PChar char row col ->
4277 toCharReport source char row col
4279 PString string row col ->
4280 toStringReport source string row col
4282 PNumber number row col ->
4283 toNumberReport source number row col
4285 PFloat width row col ->
4287 region = toWiderRegion row col width
4289 Report.Report "UNEXPECTED PATTERN" region [] $
4290 Code.toSnippet source region Nothing
4293 "I cannot pattern match with floating point numbers:"
4296 ["Equality","on","floats","can","be","unreliable,","so","you","usually","want"
4297 ,"to","check","that","they","are","nearby","with","some","sort","of"
4298 ,D.dullyellow "(abs (actual - expected) < 0.001)","check."
4304 region = toRegion row col
4306 Report.Report "UNFINISHED PATTERN" region [] $
4307 Code.toSnippet source region Nothing $
4310 "I was expecting to see a variable name after the `as` keyword:"
4314 ["The","`as`","keyword","lets","you","write","patterns","like"
4315 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4316 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4317 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4318 ,"thing","with",D.dullyellow "point."
4321 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4322 \ people just want to use `as` as a variable name though. Try using a different name\
4327 PWildcardNotVar name width row col ->
4329 region = toWiderRegion row col (fromIntegral width)
4331 case dropWhile (=='_') (Name.toChars name) of
4332 [] -> [D.dullyellow "x","or",D.dullyellow "age"]
4333 c:cs -> [D.dullyellow (D.fromChars (Char.toLower c : cs))]
4335 Report.Report "UNEXPECTED NAME" region [] $
4336 Code.toSnippet source region Nothing $
4339 "Variable names cannot start with underscores like this:"
4342 ["You","can","either","have","an","underscore","like",D.dullyellow "_","to"
4343 ,"ignore","the","value,","or","you","can","have","a","name","like"
4344 ] ++ examples ++ ["to","use","the","matched","value." ]
4347 PSpace space row col ->
4348 toSpaceReport source space row col
4350 PIndentStart row col ->
4351 error "TODO PIndentStart" row col
4353 PIndentAlias row col ->
4355 region = toRegion row col
4357 Report.Report "UNFINISHED PATTERN" region [] $
4358 Code.toSnippet source region Nothing $
4361 "I was expecting to see a variable name after the `as` keyword:"
4365 ["The","`as`","keyword","lets","you","write","patterns","like"
4366 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4367 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4368 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4369 ,"thing","with",D.dullyellow "point."
4372 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4373 \ people just want to use `as` as a variable name though. Try using a different name\
4379toPRecordReport :: Code.Source -> PRecord -> Row -> Col -> Report.Report
4380toPRecordReport source record startRow startCol =
4382 PRecordOpen row col ->
4383 toUnfinishRecordPatternReport source row col startRow startCol $
4384 D.reflow "I was expecting to see a field name next."
4386 PRecordEnd row col ->
4387 toUnfinishRecordPatternReport source row col startRow startCol $
4389 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4390 ,"Try","adding","a",D.dullyellow "}","here?"
4393 PRecordField row col ->
4394 case Code.whatIsNext source row col of
4395 Code.Keyword keyword ->
4397 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4398 region = toKeywordRegion row col keyword
4400 Report.Report "RESERVED WORD" region [] $
4401 Code.toSnippet source surroundings (Just region)
4404 "I was not expecting to see `" ++ keyword ++ "` as a record field name:"
4407 "This is a reserved word, not available for variable names. Try another name!"
4411 toUnfinishRecordPatternReport source row col startRow startCol $
4412 D.reflow "I was expecting to see a field name next."
4414 PRecordSpace space row col ->
4415 toSpaceReport source space row col
4417 PRecordIndentOpen row col ->
4418 toUnfinishRecordPatternReport source row col startRow startCol $
4419 D.reflow "I was expecting to see a field name next."
4421 PRecordIndentEnd row col ->
4422 toUnfinishRecordPatternReport source row col startRow startCol $
4424 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4425 ,"Try","adding","a",D.dullyellow "}","here?"
4428 PRecordIndentField row col ->
4429 toUnfinishRecordPatternReport source row col startRow startCol $
4430 D.reflow "I was expecting to see a field name next."
4433toUnfinishRecordPatternReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
4434toUnfinishRecordPatternReport source row col startRow startCol message =
4436 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4437 region = toRegion row col
4439 Report.Report "UNFINISHED RECORD PATTERN" region [] $
4440 Code.toSnippet source surroundings (Just region)
4443 "I was partway through parsing a record pattern, but I got stuck here:"
4448 ["A","record","pattern","looks","like",D.dullyellow "{x,y}","or",D.dullyellow "{name,age}"
4449 ,"where","you","list","the","field","names","you","want","to","access."
4456toPTupleReport :: Code.Source -> PContext -> PTuple -> Row -> Col -> Report.Report
4457toPTupleReport source context tuple startRow startCol =
4459 PTupleOpen row col ->
4460 case Code.whatIsNext source row col of
4461 Code.Keyword keyword ->
4463 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4464 region = toKeywordRegion row col keyword
4466 Report.Report "RESERVED WORD" region [] $
4467 Code.toSnippet source surroundings (Just region)
4470 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name:"
4473 "This is a reserved word! Try using some other name?"
4478 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4479 region = toRegion row col
4481 Report.Report "UNFINISHED PARENTHESES" region [] $
4482 Code.toSnippet source surroundings (Just region)
4485 "I just saw an open parenthesis, but I got stuck here:"
4488 ["I","was","expecting","so","see","a","pattern","next."
4489 ,"Maybe","it","will","end","up","being","something"
4490 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4494 PTupleEnd row col ->
4495 case Code.whatIsNext source row col of
4496 Code.Keyword keyword ->
4498 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4499 region = toKeywordRegion row col keyword
4501 Report.Report "RESERVED WORD" region [] $
4502 Code.toSnippet source surroundings (Just region) $
4505 "I ran into a reserved word in this pattern:"
4508 "The `" ++ keyword ++ "` keyword is reserved. Try using a different name instead!"
4513 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4514 region = toKeywordRegion row col op
4516 Report.Report "UNEXPECTED SYMBOL" region [] $
4517 Code.toSnippet source surroundings (Just region) $
4520 "I ran into the " ++ op ++ " symbol unexpectedly in this pattern:"
4523 "Only the :: symbol that works in patterns. It is useful if you\
4524 \ are pattern matching on lists, trying to get the first element\
4525 \ off the front. Did you want that instead?"
4528 Code.Close term bracket ->
4530 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4531 region = toRegion row col
4533 Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
4534 Code.toSnippet source surroundings (Just region) $
4537 "I ran into a an unexpected " ++ term ++ " in this pattern:"
4540 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
4545 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4546 region = toRegion row col
4548 Report.Report "UNFINISHED PARENTHESES" region [] $
4549 Code.toSnippet source surroundings (Just region) $
4552 "I was partway through parsing a pattern, but I got stuck here:"
4555 ["I","was","expecting","a","closing","parenthesis","next,","so"
4556 ,"try","adding","a",D.dullyellow ")","to","see","if","that","helps?"
4560 PTupleExpr pattern row col ->
4561 toPatternReport source context pattern row col
4563 PTupleSpace space row col ->
4564 toSpaceReport source space row col
4566 PTupleIndentEnd row col ->
4568 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4569 region = toRegion row col
4571 Report.Report "UNFINISHED PARENTHESES" region [] $
4572 Code.toSnippet source surroundings (Just region) $
4575 "I was expecting a closing parenthesis next:"
4578 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
4580 "I can get confused by indentation in cases like this, so\
4581 \ maybe you have a closing parenthesis but it is not indented enough?"
4585 PTupleIndentExpr1 row col ->
4587 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4588 region = toRegion row col
4590 Report.Report "UNFINISHED PARENTHESES" region [] $
4591 Code.toSnippet source surroundings (Just region) $
4594 "I just saw an open parenthesis, but then I got stuck here:"
4597 ["I","was","expecting","so","see","a","pattern","next."
4598 ,"Maybe","it","will","end","up","being","something"
4599 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4603 PTupleIndentExprN row col ->
4605 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4606 region = toRegion row col
4608 Report.Report "UNFINISHED TUPLE PATTERN" region [] $
4609 Code.toSnippet source surroundings (Just region) $
4612 "I am partway through parsing a tuple pattern, but I got stuck here:"
4616 ["I","was","expecting","so","see","a","pattern","next."
4617 ,"I","am","expecting","the","final","result","to","be","something"
4618 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "."
4621 "I can get confused by indentation in cases like this, so the problem\
4622 \ may be that the next part is not indented enough?"
4627toPListReport :: Code.Source -> PContext -> PList -> Row -> Col -> Report.Report
4628toPListReport source context list startRow startCol =
4630 PListOpen row col ->
4631 case Code.whatIsNext source row col of
4632 Code.Keyword keyword ->
4634 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4635 region = toKeywordRegion row col keyword
4637 Report.Report "RESERVED WORD" region [] $
4638 Code.toSnippet source surroundings (Just region)
4641 "It looks like you are trying to use `" ++ keyword ++ "` to name an element of a list:"
4644 "This is a reserved word though! Try using some other name?"
4649 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4650 region = toRegion row col
4652 Report.Report "UNFINISHED LIST PATTERN" region [] $
4653 Code.toSnippet source surroundings (Just region) $
4656 "I just saw an open square bracket, but then I got stuck here:"
4658 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4663 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4664 region = toRegion row col
4666 Report.Report "UNFINISHED LIST PATTERN" region [] $
4667 Code.toSnippet source surroundings (Just region) $
4670 "I was expecting a closing square bracket to end this list pattern:"
4672 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4675 PListExpr pattern row col ->
4676 toPatternReport source context pattern row col
4678 PListSpace space row col ->
4679 toSpaceReport source space row col
4681 PListIndentOpen row col ->
4683 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4684 region = toRegion row col
4686 Report.Report "UNFINISHED LIST PATTERN" region [] $
4687 Code.toSnippet source surroundings (Just region) $
4690 "I just saw an open square bracket, but then I got stuck here:"
4693 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4695 "I can get confused by indentation in cases like this, so\
4696 \ maybe there is something next, but it is not indented enough?"
4700 PListIndentEnd row col ->
4702 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4703 region = toRegion row col
4705 Report.Report "UNFINISHED LIST PATTERN" region [] $
4706 Code.toSnippet source surroundings (Just region) $
4709 "I was expecting a closing square bracket to end this list pattern:"
4712 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4714 "I can get confused by indentation in cases like this, so\
4715 \ maybe you have a closing square bracket but it is not indented enough?"
4719 PListIndentExpr row col ->
4721 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4722 region = toRegion row col
4724 Report.Report "UNFINISHED LIST PATTERN" region [] $
4725 Code.toSnippet source surroundings (Just region) $
4728 "I am partway through parsing a list pattern, but I got stuck here:"
4732 "I was expecting to see another pattern next. Maybe a variable name."
4734 "I can get confused by indentation in cases like this, so\
4735 \ maybe there is more to this pattern but it is not indented enough?"
4745 = TC_Annotation Name.Name
4751toTypeReport :: Code.Source -> TContext -> Type -> Row -> Col -> Report.Report
4752toTypeReport source context tipe startRow startCol =
4754 TRecord record row col ->
4755 toTRecordReport source context record row col
4757 TTuple tuple row col ->
4758 toTTupleReport source context tuple row col
4761 case Code.whatIsNext source row col of
4762 Code.Keyword keyword ->
4764 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4765 region = toKeywordRegion row col keyword
4767 Report.Report "RESERVED WORD" region [] $
4768 Code.toSnippet source surroundings (Just region)
4771 "I was expecting to see a type next, but I got stuck on this reserved word:"
4774 "It looks like you are trying to use `" ++ keyword ++ "` as a type variable, but \
4775 \ it is a reserved word. Try using a different name!"
4780 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4781 region = toRegion row col
4785 TC_Annotation _ -> "type annotation"
4786 TC_CustomType -> "custom type"
4787 TC_TypeAlias -> "type alias"
4792 TC_Annotation name -> "the `" ++ Name.toChars name ++ "` type annotation"
4793 TC_CustomType -> "a custom type"
4794 TC_TypeAlias -> "a type alias"
4797 Report.Report ("PROBLEM IN " ++ map Char.toUpper thing) region [] $
4798 Code.toSnippet source surroundings (Just region)
4801 "I was partway through parsing " ++ something ++ ", but I got stuck here:"
4804 ["I","was","expecting","to","see","a","type","next."
4805 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
4809 TSpace space row col ->
4810 toSpaceReport source space row col
4812 TIndentStart row col ->
4814 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4815 region = toRegion row col
4819 TC_Annotation _ -> "type annotation"
4820 TC_CustomType -> "custom type"
4821 TC_TypeAlias -> "type alias"
4824 Report.Report ("UNFINISHED " ++ map Char.toUpper thing) region [] $
4825 Code.toSnippet source surroundings (Just region)
4828 "I was partway through parsing a " ++ thing ++ ", but I got stuck here:"
4832 ["I","was","expecting","to","see","a","type","next."
4833 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
4836 "I can get confused by indentation. If you think there is already a type\
4837 \ next, maybe it is not indented enough?"
4842toTRecordReport :: Code.Source -> TContext -> TRecord -> Row -> Col -> Report.Report
4843toTRecordReport source context record startRow startCol =
4845 TRecordOpen row col ->
4846 case Code.whatIsNext source row col of
4847 Code.Keyword keyword ->
4849 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4850 region = toKeywordRegion row col keyword
4852 Report.Report "RESERVED WORD" region [] $
4853 Code.toSnippet source surroundings (Just region)
4856 "I just started parsing a record type, but I got stuck on this field name:"
4859 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
4860 \ that is a reserved word. Try using a different name!"
4865 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4866 region = toRegion row col
4868 Report.Report "UNFINISHED RECORD TYPE" region [] $
4869 Code.toSnippet source surroundings (Just region)
4872 "I just started parsing a record type, but I got stuck here:"
4875 ["Record","types","look","like",D.dullyellow "{ name : String, age : Int },"
4876 ,"so","I","was","expecting","to","see","a","field","name","next."
4880 TRecordEnd row col ->
4882 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4883 region = toRegion row col
4885 Report.Report "UNFINISHED RECORD TYPE" region [] $
4886 Code.toSnippet source surroundings (Just region)
4889 "I am partway through parsing a record type, but I got stuck here:"
4893 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
4894 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
4897 "When I get stuck like this, it usually means that there is a missing parenthesis\
4898 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4902 TRecordField row col ->
4903 case Code.whatIsNext source row col of
4904 Code.Keyword keyword ->
4906 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4907 region = toKeywordRegion row col keyword
4909 Report.Report "RESERVED WORD" region [] $
4910 Code.toSnippet source surroundings (Just region)
4913 "I am partway through parsing a record type, but I got stuck on this field name:"
4916 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
4917 \ that is a reserved word. Try using a different name!"
4922 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4923 region = toRegion row col
4925 Report.Report "UNFINISHED RECORD TYPE" region [] $
4926 Code.toSnippet source surroundings (Just region)
4929 "I am partway through parsing a record type, but I got stuck after that last comma:"
4931 addNoteForRecordTypeError $
4933 "Trailing commas are not allowed in records, so I was expecting to see another\
4934 \ record field defined next. If you are done defining the record, the fix may\
4935 \ be to delete that last comma?"
4938 TRecordColon row col ->
4940 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4941 region = toRegion row col
4943 Report.Report "UNFINISHED RECORD TYPE" region [] $
4944 Code.toSnippet source surroundings (Just region)
4947 "I am partway through parsing a record type, but I got stuck here:"
4949 addNoteForRecordTypeError $
4951 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
4952 ,"a","colon","next.","So","try","putting","an",D.green ":","sign","here?"
4956 TRecordType tipe row col ->
4957 toTypeReport source context tipe row col
4959 TRecordSpace space row col ->
4960 toSpaceReport source space row col
4962 TRecordIndentOpen row col ->
4964 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4965 region = toRegion row col
4967 Report.Report "UNFINISHED RECORD TYPE" region [] $
4968 Code.toSnippet source surroundings (Just region)
4971 "I just saw the opening curly brace of a record type, but then I got stuck here:"
4973 addNoteForRecordTypeIndentError $
4975 ["I","am","expecting","a","record","like",D.dullyellow "{ name : String, age : Int }","here."
4976 ,"Try","defining","some","fields","of","your","own?"
4980 TRecordIndentEnd row col ->
4982 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4983 region = toRegion row col
4985 Report.Report "UNFINISHED RECORD TYPE" region [] $
4986 Code.toSnippet source surroundings (Just region)
4989 "I was expecting to see a closing curly brace next:"
4991 addNoteForRecordTypeIndentError $
4993 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
4997 TRecordIndentField row col ->
4999 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5000 region = toRegion row col
5002 Report.Report "UNFINISHED RECORD TYPE" region [] $
5003 Code.toSnippet source surroundings (Just region)
5006 "I am partway through parsing a record type, but I got stuck after that last comma:"
5008 addNoteForRecordTypeIndentError $
5010 "Trailing commas are not allowed in record types, so the fix may be to\
5011 \ delete that last comma? Or maybe you were in the middle of defining\
5012 \ an additional field?"
5015 TRecordIndentColon row col ->
5017 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5018 region = toRegion row col
5020 Report.Report "UNFINISHED RECORD TYPE" region [] $
5021 Code.toSnippet source surroundings (Just region)
5024 "I am partway through parsing a record type. I just saw a record\
5025 \ field, so I was expecting to see a colon next:"
5027 addNoteForRecordTypeIndentError $
5029 ["Try","putting","an",D.green ":","followed","by","a","type?"
5033 TRecordIndentType row col ->
5035 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5036 region = toRegion row col
5038 Report.Report "UNFINISHED RECORD TYPE" region [] $
5039 Code.toSnippet source surroundings (Just region)
5042 "I am partway through parsing a record type, and I was expecting to run into a type next:"
5044 addNoteForRecordTypeIndentError $
5046 ["Try","putting","something","like"
5047 ,D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5052addNoteForRecordTypeError :: D.Doc -> D.Doc
5053addNoteForRecordTypeError normalRecommendation =
5055 normalRecommendation
5058 "If you are trying to define a record type across multiple lines, I recommend using this format:"
5059 , D.indent 4 $ D.vcat $
5062 , ", height : Float"
5066 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5067 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5068 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5072addNoteForRecordTypeIndentError :: D.Doc -> D.Doc
5073addNoteForRecordTypeIndentError normalRecommendation =
5075 normalRecommendation
5078 "I may be confused by indentation. For example, if you are trying to define\
5079 \ a record type across multiple lines, I recommend using this format:"
5080 , D.indent 4 $ D.vcat $
5083 , ", height : Float"
5087 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5088 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5089 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5093toTTupleReport :: Code.Source -> TContext -> TTuple -> Row -> Col -> Report.Report
5094toTTupleReport source context tuple startRow startCol =
5096 TTupleOpen row col ->
5097 case Code.whatIsNext source row col of
5098 Code.Keyword keyword ->
5100 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5101 region = toKeywordRegion row col keyword
5103 Report.Report "RESERVED WORD" region [] $
5104 Code.toSnippet source surroundings (Just region)
5107 "I ran into a reserved word unexpectedly:"
5110 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but \
5111 \ it is a reserved word. Try using a different name!"
5116 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5117 region = toRegion row col
5119 Report.Report "UNFINISHED PARENTHESES" region [] $
5120 Code.toSnippet source surroundings (Just region)
5123 "I just saw an open parenthesis, so I was expecting to see a type next."
5126 ["Something","like",D.dullyellow "(Maybe Int)","or"
5127 ,D.dullyellow "(List Person)" <> "."
5128 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5132 TTupleEnd row col ->
5134 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5135 region = toRegion row col
5137 Report.Report "UNFINISHED PARENTHESES" region [] $
5138 Code.toSnippet source surroundings (Just region)
5141 "I was expecting to see a closing parentheses next, but I got stuck here:"
5144 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
5146 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
5147 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
5148 \ or missing brackets) that is confusing me."
5152 TTupleType tipe row col ->
5153 toTypeReport source context tipe row col
5155 TTupleSpace space row col ->
5156 toSpaceReport source space row col
5158 TTupleIndentType1 row col ->
5160 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5161 region = toRegion row col
5163 Report.Report "UNFINISHED PARENTHESES" region [] $
5164 Code.toSnippet source surroundings (Just region)
5167 "I just saw an open parenthesis, so I was expecting to see a type next."
5171 ["Something","like",D.dullyellow "(Maybe Int)","or"
5172 ,D.dullyellow "(List Person)" <> "."
5173 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5176 "I can get confused by indentation in cases like this, so\
5177 \ maybe you have a type but it is not indented enough?"
5181 TTupleIndentTypeN row col ->
5183 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5184 region = toRegion row col
5186 Report.Report "UNFINISHED TUPLE TYPE" region [] $
5187 Code.toSnippet source surroundings (Just region)
5190 "I think I am in the middle of parsing a tuple type. I just saw a comma, so I was expecting to see a type next."
5194 ["A","tuple","type","looks","like",D.dullyellow "(Float,Float)","or"
5195 ,D.dullyellow "(String,Int)" <> ","
5196 ,"so","I","think","there","is","a","type","missing","here?"
5199 "I can get confused by indentation in cases like this, so\
5200 \ maybe you have an expression but it is not indented enough?"
5204 TTupleIndentEnd row col ->
5206 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5207 region = toRegion row col
5209 Report.Report "UNFINISHED PARENTHESES" region [] $
5210 Code.toSnippet source surroundings (Just region)
5213 "I was expecting to see a closing parenthesis next:"
5216 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
5218 "I can get confused by indentation in cases like this, so\
5219 \ maybe you have a closing parenthesis but it is not indented enough?"
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list