1{-# OPTIONS_GHC -Wall #-}
2{-# LANGUAGE OverloadedStrings #-}
3module Reporting.Error.Syntax
48import Prelude hiding (Char, String)
49import qualified Data.Char as Char
50import qualified Data.Name as Name
51import Data.Word (Word16)
52import Numeric (showHex)
54import qualified Elm.ModuleName as ModuleName
55import Parse.Primitives (Row, Col)
56import Parse.Symbol (BadOperator(..))
57import qualified Reporting.Annotation as A
58import qualified Reporting.Doc as D
59import qualified Reporting.Report as Report
60import qualified Reporting.Render.Code as Code
68 = ModuleNameUnspecified ModuleName.Raw
69 | ModuleNameMismatch ModuleName.Raw (A.Located ModuleName.Raw)
70 | UnexpectedPort A.Region
80 = ModuleSpace Space Row Col
81 | ModuleBadEnd Row Col
83 | ModuleProblem Row Col
85 | ModuleExposing Exposing Row Col
87 | PortModuleProblem Row Col
88 | PortModuleName Row Col
89 | PortModuleExposing Exposing Row Col
99 | ImportExposing Row Col
100 | ImportExposingList Exposing Row Col
101 | ImportEnd Row Col -- different based on col=1 or if greater
103 | ImportIndentName Row Col
104 | ImportIndentAlias Row Col
105 | ImportIndentExposingList Row Col
109 | Declarations Decl Row Col
113 = ExposingSpace Space Row Col
114 | ExposingStart Row Col
115 | ExposingValue Row Col
116 | ExposingOperator Row Col
117 | ExposingOperatorReserved BadOperator Row Col
118 | ExposingOperatorRightParen Row Col
119 | ExposingTypePrivacy Row Col
120 | ExposingEnd Row Col
122 | ExposingIndentEnd Row Col
123 | ExposingIndentValue Row Col
132 | DeclSpace Space Row Col
135 | DeclType DeclType Row Col
136 | DeclDef Name.Name DeclDef Row Col
138 | DeclFreshLineAfterDocComment Row Col
142 = DeclDefSpace Space Row Col
143 | DeclDefEquals Row Col
144 | DeclDefType Type Row Col
145 | DeclDefArg Pattern Row Col
146 | DeclDefBody Expr Row Col
147 | DeclDefNameRepeat Row Col
148 | DeclDefNameMatch Name.Name Row Col
150 | DeclDefIndentType Row Col
151 | DeclDefIndentEquals Row Col
152 | DeclDefIndentBody Row Col
156 = PortSpace Space Row Col
159 | PortType Type Row Col
160 | PortIndentName Row Col
161 | PortIndentColon Row Col
162 | PortIndentType Row Col
170 = DT_Space Space Row Col
172 | DT_Alias TypeAlias Row Col
173 | DT_Union CustomType Row Col
175 | DT_IndentName Row Col
179 = AliasSpace Space Row Col
181 | AliasEquals Row Col
182 | AliasBody Type Row Col
184 | AliasIndentEquals Row Col
185 | AliasIndentBody Row Col
189 = CT_Space Space Row Col
194 | CT_VariantArg Type Row Col
196 | CT_IndentEquals Row Col
197 | CT_IndentBar Row Col
198 | CT_IndentAfterBar Row Col
199 | CT_IndentAfterEquals Row Col
211 | Record Record Row Col
212 | Tuple Tuple Row Col
217 | OperatorRight Name.Name Row Col
218 | OperatorReserved BadOperator Row Col
222 | String String Row Col
223 | Number Number Row Col
224 | Space Space Row Col
225 | EndlessShader Row Col
226 | ShaderProblem [Char.Char] Row Col
227 | IndentOperatorRight Name.Name 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 ModuleBadEnd 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."
2345toCharReport :: Code.Source -> Char -> Row -> Col -> Report.Report
2346toCharReport source char row col =
2350 region = toRegion row col
2352 Report.Report "MISSING SINGLE QUOTE" region [] $
2353 Code.toSnippet source region Nothing
2356 "I thought I was parsing a character, but I got to the end of\
2357 \ the line without seeing the closing single quote:"
2360 "Add a closing single quote here!"
2363 CharEscape escape ->
2364 toEscapeReport source escape row col
2366 CharNotString width ->
2368 region = toWiderRegion row col width
2370 Report.Report "NEEDS DOUBLE QUOTES" region [] $
2371 Code.toSnippet source region Nothing
2373 "The following string uses single quotes:"
2376 [ "Please switch to double quotes instead:"
2378 D.dullyellow "'this'" <> " => " <> D.green "\"this\""
2380 "Elm uses double quotes for strings like \"hello\", whereas it uses single\
2381 \ quotes for individual characters like 'a' and 'ø'. This distinction helps with\
2382 \ code like (String.any (\\c -> c == 'X') \"90210\") where you are inspecting\
2383 \ individual characters."
2392toStringReport :: Code.Source -> String -> Row -> Col -> Report.Report
2393toStringReport source string row col =
2395 StringEndless_Single ->
2397 region = toRegion row col
2399 Report.Report "ENDLESS STRING" region [] $
2400 Code.toSnippet source region Nothing
2403 "I got to the end of the line without seeing the closing double quote:"
2407 ["Strings","look","like",D.green "\"this\"","with","double"
2408 ,"quotes","on","each","end.","Is","the","closing","double"
2409 ,"quote","missing","in","your","code?"
2412 "For a string that spans multiple lines, you can use the multi-line string\
2413 \ syntax like this:"
2415 [ D.fillSep [D.green "markdown","=",D.dullyellow "\"\"\""]
2417 , D.dullyellow "# Multi-line Strings"
2419 , D.dullyellow "- start with triple double quotes"
2420 , D.dullyellow "- write whatever you want"
2421 , D.dullyellow "- no need to escape newlines or double quotes"
2422 , D.dullyellow "- end with triple double quotes"
2424 , D.dullyellow "\"\"\""
2429 StringEndless_Multi ->
2431 region = toWiderRegion row col 3
2433 Report.Report "ENDLESS STRING" region [] $
2434 Code.toSnippet source region Nothing
2437 "I cannot find the end of this multi-line string:"
2440 [ D.reflow "Add a \"\"\" somewhere after this to end the string."
2442 "Here is a valid multi-line string for reference:"
2444 [ D.fillSep [D.green "markdown","=",D.dullyellow "\"\"\""]
2446 , D.dullyellow "# Multi-line Strings"
2448 , D.dullyellow "- start with triple double quotes"
2449 , D.dullyellow "- write whatever you want"
2450 , D.dullyellow "- no need to escape newlines or double quotes"
2451 , D.dullyellow "- end with triple double quotes"
2453 , D.dullyellow "\"\"\""
2458 StringEscape escape ->
2459 toEscapeReport source escape row col
2466toEscapeReport :: Code.Source -> Escape -> Row -> Col -> Report.Report
2467toEscapeReport source escape row col =
2471 region = toWiderRegion row col 2
2473 Report.Report "UNKNOWN ESCAPE" region [] $
2474 Code.toSnippet source region Nothing
2477 "Backslashes always start escaped characters, but I do not recognize this one:"
2481 "Valid escape characters include:"
2482 , D.dullyellow $ D.indent 4 $ D.vcat $
2492 "Do you want one of those instead? Maybe you need \\\\ to escape a backslash?"
2494 "The last style lets encode ANY character by its Unicode code\
2495 \ point. That means \\u{0009} and \\t are the same. You can use\
2496 \ that style for anything not covered by the other six escapes!"
2500 BadUnicodeFormat width ->
2502 region = toWiderRegion row col width
2504 Report.Report "BAD UNICODE ESCAPE" region [] $
2505 Code.toSnippet source region Nothing
2508 "I ran into an invalid Unicode escape:"
2512 "Here are some examples of valid Unicode escapes:"
2513 , D.dullyellow $ D.indent 4 $ D.vcat $
2520 "Notice that the code point is always surrounded by curly braces.\
2521 \ Maybe you are missing the opening or closing curly brace?"
2524 BadUnicodeCode width ->
2526 region = toWiderRegion row col width
2528 Report.Report "BAD UNICODE ESCAPE" region [] $
2529 Code.toSnippet source region Nothing
2532 "This is not a valid code point:"
2535 "The valid code points are between 0 and 10FFFF inclusive."
2538 BadUnicodeLength width numDigits badCode ->
2540 region = toWiderRegion row col width
2542 Report.Report "BAD UNICODE ESCAPE" region [] $
2543 Code.toSnippet source region Nothing $
2544 if numDigits < 4 then
2547 "Every code point needs at least four digits:"
2550 goodCode = replicate (4 - numDigits) '0' ++ map Char.toUpper (showHex badCode "")
2551 suggestion = "\\u{" <> D.fromChars goodCode <> "}"
2553 D.fillSep ["Try",D.green suggestion,"instead?"]
2559 "This code point has too many digits:"
2562 ["Valid","code","points","are","between"
2563 ,D.green "\\u{0000}","and",D.green "\\u{10FFFF}" <> ","
2564 ,"so","try","trimming","any","leading","zeros","until"
2565 ,"you","have","between","four","and","six","digits."
2574toNumberReport :: Code.Source -> Number -> Row -> Col -> Report.Report
2575toNumberReport source number row col =
2577 region = toRegion row col
2581 Report.Report "WEIRD NUMBER" region [] $
2582 Code.toSnippet source region Nothing
2585 "I thought I was reading a number, but I ran into some weird stuff here:"
2589 "I recognize numbers in the following formats:"
2590 , D.indent 4 $ D.vcat [ "42", "3.14", "6.022e23", "0x002B" ]
2592 "So is there a way to write it like one of those?"
2597 Report.Report "WEIRD NUMBER" region [] $
2598 Code.toSnippet source region Nothing
2601 "Numbers cannot end with a dot like this:"
2604 ["Switching","to",D.green (D.fromChars (show int))
2605 ,"or",D.green (D.fromChars (show int ++ ".0"))
2606 ,"will","work","though!"
2611 Report.Report "WEIRD HEXIDECIMAL" region [] $
2612 Code.toSnippet source region Nothing
2615 "I thought I was reading a hexidecimal number until I got here:"
2619 "Valid hexidecimal digits include 0123456789abcdefABCDEF, so I can\
2620 \ only recognize things like this:"
2621 , D.indent 4 $ D.vcat [ "0x2B", "0x002B", "0x00ffb3" ]
2625 NumberNoLeadingZero ->
2626 Report.Report "LEADING ZEROS" region [] $
2627 Code.toSnippet source region Nothing
2630 "I do not accept numbers with leading zeros:"
2634 "Just delete the leading zeros and it should work!"
2636 "Some languages let you to specify octal numbers by adding a leading zero.\
2637 \ So in C, writing 0111 is the same as writing 73. Some people are used to\
2638 \ that, but others probably want it to equal 111. Either path is going to\
2639 \ surprise people from certain backgrounds, so Elm tries to avoid this whole\
2649toOperatorReport :: Code.Source -> Context -> BadOperator -> Row -> Col -> Report.Report
2650toOperatorReport source context operator row col =
2654 region = toRegion row col
2656 Report.Report "UNEXPECTED SYMBOL" region [] $
2657 Code.toSnippet source region Nothing
2659 "I was not expecting this dot:"
2662 "Dots are for record access and decimal points, so\
2663 \ they cannot float around on their own. Maybe\
2664 \ there is some extra whitespace?"
2669 region = toRegion row col
2671 Report.Report "UNEXPECTED SYMBOL" region [] $
2672 Code.toSnippet source region Nothing
2675 "I was not expecting this vertical bar:"
2678 "Vertical bars should only appear in custom type declarations. Maybe you want || instead?"
2683 region = toWiderRegion row col 2
2685 Report.Report "UNEXPECTED ARROW" region [] $
2686 Code.toSnippet source region Nothing $
2687 if isWithin NBranch context then
2690 "I was not expecting to see an arrow here:"
2695 "I think I am parsing a `case` expression right now, so it makes sense to\
2696 \ see arrows around here. This one is confusing me though!"
2699 "I may be getting confused by the indentation. Every pattern in a `case` must be\
2700 \ exactly aligned (with exactly the same amount of indentation) so maybe this arrow\
2701 \ appears after the next `case` pattern (correctly!) but the pattern itself is\
2702 \ indented too far?"
2709 "I was not expecting an arrow here:"
2712 "Arrows should only appear in `case` expressions and anonymous functions. Maybe\
2713 \ you want > or >= instead?"
2718 region = toRegion row col
2720 Report.Report "UNEXPECTED EQUALS" region [] $
2721 Code.toSnippet source region Nothing
2724 "I was not expecting to see this equals sign:"
2728 D.reflow "Maybe you want == instead? To check if two values are equal?"
2731 if isWithin NRecord context then
2732 "Records look like { x = 3, y = 4 } with the equals sign right\
2733 \ after the field name. So maybe you forgot a comma?"
2735 case getDefName context of
2737 "I may be getting confused by your indentation. I need all definitions to be indented\
2738 \ exactly the same amount, so if this is meant to be a new definition, it may have too\
2739 \ many spaces in front of it."
2742 "I may be getting confused by your indentation. I think I am still parsing the `"
2743 ++ Name.toChars name ++ "` definition. Is this supposed to be part of a definition\
2744 \ after that? If so, the problem may be a bit before the equals sign. I need all\
2745 \ definitions to be indented exactly the same amount, so the problem may be that\
2746 \ this new definition has too many spaces in front of it."
2752 region = toRegion row col
2754 Report.Report "UNEXPECTED SYMBOL" region [] $
2755 Code.toSnippet source region Nothing $
2758 "I was not expecting to run into the \"has type\" symbol here:"
2760 case getDefName context of
2763 ["Maybe","you","want",D.green "::","instead?"
2764 ,"To","put","something","on","the","front","of","a","list?"
2771 ["Maybe","you","want",D.green "::","instead?"
2772 ,"To","put","something","on","the","front","of","a","list?"
2775 "The single colon is reserved for type annotations and record types, but I think\
2776 \ I am parsing the definition of `" ++ Name.toChars name ++ "` right now."
2779 "I may be getting confused by your indentation. Is this supposed to be part of\
2780 \ a type annotation AFTER the `" ++ Name.toChars name ++ "` definition? If so,\
2781 \ the problem may be a bit before the \"has type\" symbol. I need all definitions to\
2782 \ be exactly aligned (with exactly the same indentation) so the problem may be that\
2783 \ this new definition is indented a bit too much."
2792toLetReport :: Code.Source -> Context -> Let -> Row -> Col -> Report.Report
2793toLetReport source context let_ startRow startCol =
2795 LetSpace space row col ->
2796 toSpaceReport source space row col
2800 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2801 region = toRegion row col
2803 Report.Report "LET PROBLEM" region [] $
2804 Code.toSnippet source surroundings (Just region)
2807 "I was partway through parsing a `let` expression, but I got stuck here:"
2811 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2812 ,"keyword","next.","Is","there","a","typo?"
2815 "This can also happen if you are trying to define another value within the `let` but\
2816 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2817 \ spaces before it. They should line up exactly!"
2821 LetDefAlignment _ row col ->
2823 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2824 region = toRegion row col
2826 Report.Report "LET PROBLEM" region [] $
2827 Code.toSnippet source surroundings (Just region)
2830 "I was partway through parsing a `let` expression, but I got stuck here:"
2834 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2835 ,"keyword","next.","Is","there","a","typo?"
2838 "This can also happen if you are trying to define another value within the `let` but\
2839 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2840 \ spaces before it. The should line up exactly!"
2844 LetDefName row col ->
2845 case Code.whatIsNext source row col of
2846 Code.Keyword keyword ->
2848 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2849 region = toKeywordRegion row col keyword
2851 Report.Report "RESERVED WORD" region [] $
2852 Code.toSnippet source surroundings (Just region)
2855 "I was partway through parsing a `let` expression, but I got stuck here:"
2858 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but\
2859 \ it is a reserved word! Try using a different name instead."
2863 toUnfinishLetReport source row col startRow startCol $
2865 "I was expecting the name of a definition next."
2867 LetDef name def row col ->
2868 toLetDefReport source name def row col
2870 LetDestruct destruct row col ->
2871 toLetDestructReport source destruct row col
2873 LetBody expr row col ->
2874 toExprReport source context expr row col
2876 LetIndentDef row col ->
2877 toUnfinishLetReport source row col startRow startCol $
2879 "I was expecting a value to be defined here."
2881 LetIndentIn row col ->
2882 toUnfinishLetReport source row col startRow startCol $
2884 ["I","was","expecting","to","see","the",D.cyan "in","keyword","next."
2885 ,"Or","maybe","more","of","that","expression?"
2888 LetIndentBody row col ->
2889 toUnfinishLetReport source row col startRow startCol $
2891 "I was expecting an expression next. Tell me what should happen with the value you just defined!"
2894toUnfinishLetReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
2895toUnfinishLetReport source row col startRow startCol message =
2897 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2898 region = toRegion row col
2900 Report.Report "UNFINISHED LET" region [] $
2901 Code.toSnippet source surroundings (Just region)
2904 "I was partway through parsing a `let` expression, but I got stuck here:"
2909 "Here is an example with a valid `let` expression for reference:"
2911 [ D.indent 0 $ D.fillSep [D.green "viewPerson","person","="]
2912 , D.indent 2 $ D.fillSep [D.cyan "let"]
2913 , D.indent 4 $ D.fillSep ["fullName","="]
2914 , D.indent 6 $ D.fillSep ["person.firstName","++",D.dullyellow "\" \"","++","person.lastName"]
2915 , D.indent 2 $ D.fillSep [D.cyan "in"]
2916 , D.indent 2 $ D.fillSep ["div","[]","[","text","fullName","]"]
2919 "Here we defined a `viewPerson` function that turns a person into some HTML. We use\
2920 \ a `let` expression to define the `fullName` we want to show. Notice the indentation! The\
2921 \ `fullName` is indented more than the `let` keyword, and the actual value of `fullName` is\
2922 \ indented a bit more than that. That is important!"
2927toLetDefReport :: Code.Source -> Name.Name -> Def -> Row -> Col -> Report.Report
2928toLetDefReport source name def startRow startCol =
2930 DefSpace space row col ->
2931 toSpaceReport source space row col
2933 DefType tipe row col ->
2934 toTypeReport source (TC_Annotation name) tipe row col
2936 DefNameRepeat row col ->
2938 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2939 region = toRegion row col
2941 Report.Report "EXPECTING DEFINITION" region [] $
2942 Code.toSnippet source surroundings (Just region)
2945 "I just saw the type annotation for `" ++ Name.toChars name
2946 ++ "` so I was expecting to see its definition here:"
2950 "Type annotations always appear directly above the relevant\
2951 \ definition, without anything else in between."
2956 DefNameMatch defName row col ->
2958 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2959 region = toRegion row col
2961 Report.Report "NAME MISMATCH" region [] $
2962 Code.toSnippet source surroundings (Just region)
2965 "I just saw a type annotation for `" ++ Name.toChars name ++ "`, but it is followed by a definition for `" ++ Name.toChars defName ++ "`:"
2969 "These names do not match! Is there a typo?"
2970 , D.indent 4 $ D.fillSep $
2971 [D.dullyellow (D.fromName defName),"->",D.green (D.fromName name)]
2975 DefArg pattern row col ->
2976 toPatternReport source PArg pattern row col
2978 DefEquals row col ->
2979 case Code.whatIsNext source row col of
2980 Code.Keyword keyword ->
2982 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2983 region = toKeywordRegion row col keyword
2985 Report.Report "RESERVED WORD" region [] $
2986 Code.toSnippet source surroundings (Just region)
2989 "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
2992 "This is a reserved word! Try using some other name?"
2997 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2998 region = toKeywordRegion row col op
3000 Report.Report "UNEXPECTED SYMBOL" region [] $
3001 Code.toSnippet source surroundings (Just region)
3004 "I was not expecting to see this symbol here:"
3008 "I am not sure what is going wrong exactly, so here is a valid\
3009 \ definition (with an optional type annotation) for reference:"
3011 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3012 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3013 , D.indent 6 $ D.fillSep ["x","+","y"]
3016 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
3022 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3023 region = toRegion row col
3025 Report.Report "PROBLEM IN DEFINITION" region [] $
3026 Code.toSnippet source surroundings (Just region)
3029 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3033 "I am not sure what is going wrong exactly, so here is a valid\
3034 \ definition (with an optional type annotation) for reference:"
3036 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3037 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3038 , D.indent 4 $ D.fillSep ["x","+","y"]
3041 "Try to use that format!"
3045 DefBody expr row col ->
3046 toExprReport source (InDef name startRow startCol) expr row col
3048 DefIndentEquals row col ->
3050 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3051 region = toRegion row col
3053 Report.Report "UNFINISHED DEFINITION" region [] $
3054 Code.toSnippet source surroundings (Just region)
3057 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3061 "I was expecting to see an argument or an equals sign next."
3066 DefIndentType row col ->
3068 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3069 region = toRegion row col
3071 Report.Report "UNFINISHED DEFINITION" region [] $
3072 Code.toSnippet source surroundings (Just region)
3075 "I got stuck while parsing the `" ++ Name.toChars name ++ "` type annotation:"
3079 "I just saw a colon, so I am expecting to see a type next."
3084 DefIndentBody row col ->
3086 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3087 region = toRegion row col
3089 Report.Report "UNFINISHED DEFINITION" region [] $
3090 Code.toSnippet source surroundings (Just region)
3093 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3097 "I was expecting to see an expression next. What is it equal to?"
3102 DefAlignment indent row col ->
3104 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3105 region = toRegion row col
3106 offset = indent - col
3108 Report.Report "PROBLEM IN DEFINITION" region [] $
3109 Code.toSnippet source surroundings (Just region)
3112 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3115 "I just saw a type annotation indented " ++ show indent ++ " spaces, so I was\
3116 \ expecting to see the corresponding definition next with the exact same amount\
3117 \ of indentation. It looks like this line needs "
3118 ++ show offset ++ " more " ++ (if offset == 1 then "space" else "spaces") ++ "?"
3127 "Here is a valid definition (with a type annotation) for reference:"
3129 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3130 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3131 , D.indent 6 $ D.fillSep ["x","+","y"]
3134 "The top line (called a \"type annotation\") is optional. You can leave it off\
3135 \ if you want. As you get more comfortable with Elm and as your project grows,\
3136 \ it becomes more and more valuable to add them though! They work great as\
3137 \ compiler-verified documentation, and they often improve error messages!"
3141toLetDestructReport :: Code.Source -> Destruct -> Row -> Col -> Report.Report
3142toLetDestructReport source destruct startRow startCol =
3144 DestructSpace space row col ->
3145 toSpaceReport source space row col
3147 DestructPattern pattern row col ->
3148 toPatternReport source PLet pattern row col
3150 DestructEquals row col ->
3152 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3153 region = toRegion row col
3155 Report.Report "PROBLEM IN DEFINITION" region [] $
3156 Code.toSnippet source surroundings (Just region)
3159 "I got stuck trying to parse this definition:"
3161 case Code.whatIsNext source row col of
3162 Code.Operator ":" ->
3165 "I was expecting to see an equals sign next, followed by an expression\
3166 \ telling me what to compute."
3168 "It looks like you may be trying to write a type annotation? It is not\
3169 \ possible to add type annotations on destructuring definitions like this.\
3170 \ You can assign a name to the overall structure, put a type annotation on\
3171 \ that, and then destructure separately though."
3176 "I was expecting to see an equals sign next, followed by an expression\
3177 \ telling me what to compute."
3180 DestructBody expr row col ->
3181 toExprReport source (InDestruct startRow startCol) expr row col
3183 DestructIndentEquals row col ->
3185 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3186 region = toRegion row col
3188 Report.Report "UNFINISHED DEFINITION" region [] $
3189 Code.toSnippet source surroundings (Just region)
3192 "I got stuck trying to parse this definition:"
3195 "I was expecting to see an equals sign next, followed by an expression\
3196 \ telling me what to compute."
3199 DestructIndentBody row col ->
3201 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3202 region = toRegion row col
3204 Report.Report "UNFINISHED DEFINITION" region [] $
3205 Code.toSnippet source surroundings (Just region)
3208 "I got stuck while parsing this definition:"
3211 "I was expecting to see an expression next. What is it equal to?"
3219toCaseReport :: Code.Source -> Context -> Case -> Row -> Col -> Report.Report
3220toCaseReport source context case_ startRow startCol =
3222 CaseSpace space row col ->
3223 toSpaceReport source space row col
3226 toUnfinishCaseReport source row col startRow startCol $
3227 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3229 CasePattern pattern row col ->
3230 toPatternReport source PCase pattern row col
3232 CaseArrow row col ->
3233 case Code.whatIsNext source row col of
3234 Code.Keyword keyword ->
3236 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3237 region = toKeywordRegion row col keyword
3239 Report.Report "RESERVED WORD" region [] $
3240 Code.toSnippet source surroundings (Just region)
3243 "I am partway through parsing a `case` expression, but I got stuck here:"
3246 "It looks like you are trying to use `" ++ keyword ++ "` in one of your\
3247 \ patterns, but it is a reserved word. Try using a different name?"
3250 Code.Operator ":" ->
3252 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3253 region = toRegion row col
3255 Report.Report "UNEXPECTED OPERATOR" region [] $
3256 Code.toSnippet source surroundings (Just region)
3259 "I am partway through parsing a `case` expression, but I got stuck here:"
3262 ["I","am","seeing",D.dullyellow ":","but","maybe","you","want",D.green "::","instead?"
3263 ,"For","pattern","matching","on","lists?"
3267 Code.Operator "=" ->
3269 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3270 region = toRegion row col
3272 Report.Report "UNEXPECTED OPERATOR" region [] $
3273 Code.toSnippet source surroundings (Just region)
3276 "I am partway through parsing a `case` expression, but I got stuck here:"
3279 ["I","am","seeing",D.dullyellow "=","but","maybe","you","want",D.green "->","instead?"
3285 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3286 region = toRegion row col
3288 Report.Report "MISSING ARROW" region [] $
3289 Code.toSnippet source surroundings (Just region)
3292 "I am partway through parsing a `case` expression, but I got stuck here:"
3294 addNoteForCaseIndentError $
3296 "I was expecting to see an arrow next."
3299 CaseExpr expr row col ->
3300 toExprReport source (InNode NCase startRow startCol context) expr row col
3302 CaseBranch expr row col ->
3303 toExprReport source (InNode NBranch startRow startCol context) expr row col
3305 CaseIndentOf row col ->
3306 toUnfinishCaseReport source row col startRow startCol $
3307 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3309 CaseIndentExpr row col ->
3310 toUnfinishCaseReport source row col startRow startCol $
3311 D.reflow "I was expecting to see a expression next."
3313 CaseIndentPattern row col ->
3314 toUnfinishCaseReport source row col startRow startCol $
3315 D.reflow "I was expecting to see a pattern next."
3317 CaseIndentArrow row col ->
3318 toUnfinishCaseReport source row col startRow startCol $
3320 ["I","just","saw","a","pattern,","so","I","was","expecting"
3321 ,"to","see","a",D.dullyellow "->","next."
3324 CaseIndentBranch row col ->
3325 toUnfinishCaseReport source row col startRow startCol $
3327 "I was expecting to see an expression next. What should I do when\
3328 \ I run into this particular pattern?"
3330 CasePatternAlignment indent row col ->
3331 toUnfinishCaseReport source row col startRow startCol $
3333 "I suspect this is a pattern that is not indented far enough? (" ++ show indent ++ " spaces)"
3336toUnfinishCaseReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
3337toUnfinishCaseReport source row col startRow startCol message =
3339 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3340 region = toRegion row col
3342 Report.Report "UNFINISHED CASE" region [] $
3343 Code.toSnippet source surroundings (Just region)
3346 "I was partway through parsing a `case` expression, but I got stuck here:"
3351 "Here is an example of a valid `case` expression for reference."
3353 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3354 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3355 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3357 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3358 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3361 "Notice the indentation. Each pattern is aligned, and each branch is indented\
3362 \ a bit more than the corresponding pattern. That is important!"
3367addNoteForCaseIndentError :: D.Doc -> D.Doc
3368addNoteForCaseIndentError message =
3373 "Sometimes I get confused by indentation, so try to make your `case` look\
3374 \ something like this:"
3376 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3377 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3378 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3380 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3381 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3384 "Notice the indentation! Each pattern is aligned, and each branch is indented\
3385 \ a bit more than the corresponding pattern. That is important!"
3393toIfReport :: Code.Source -> Context -> If -> Row -> Col -> Report.Report
3394toIfReport source context if_ startRow startCol =
3396 IfSpace space row col ->
3397 toSpaceReport source space row col
3401 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3402 region = toRegion row col
3404 Report.Report "UNFINISHED IF" region [] $
3405 Code.toSnippet source surroundings (Just region)
3408 "I was expecting to see more of this `if` expression, but I got stuck here:"
3411 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3417 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3418 region = toRegion row col
3420 Report.Report "UNFINISHED IF" region [] $
3421 Code.toSnippet source surroundings (Just region)
3424 "I was expecting to see more of this `if` expression, but I got stuck here:"
3427 ["I","was","expecting","to","see","the",D.cyan "else","keyword","next."
3431 IfElseBranchStart 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 just saw the start of an `else` branch, but then I got stuck here:"
3443 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3446 IfCondition expr row col ->
3447 toExprReport source (InNode NCond startRow startCol context) expr row col
3449 IfThenBranch expr row col ->
3450 toExprReport source (InNode NThen startRow startCol context) expr row col
3452 IfElseBranch expr row col ->
3453 toExprReport source (InNode NElse startRow startCol context) expr row col
3455 IfIndentCondition row col ->
3457 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3458 region = toRegion row col
3460 Report.Report "UNFINISHED IF" region [] $
3461 Code.toSnippet source surroundings (Just region)
3464 "I was expecting to see more of this `if` expression, but I got stuck here:"
3468 ["I","was","expecting","to","see","an","expression","like",D.dullyellow "x < 0"
3469 ,"that","evaluates","to","True","or","False."
3472 "I can be confused by indentation. Maybe something is not indented enough?"
3476 IfIndentThen row col ->
3478 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3479 region = toRegion row col
3481 Report.Report "UNFINISHED IF" region [] $
3482 Code.toSnippet source surroundings (Just region)
3485 "I was expecting to see more of this `if` expression, but I got stuck here:"
3489 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3492 "I can be confused by indentation. Maybe something is not indented enough?"
3496 IfIndentThenBranch row col ->
3498 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3499 region = toRegion row col
3501 Report.Report "UNFINISHED IF" region [] $
3502 Code.toSnippet source surroundings (Just region)
3505 "I got stuck after the start of this `then` branch:"
3509 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3511 "I can be confused by indentation, so if the `then` branch is already\
3512 \ present, it may not be indented enough for me to recognize it."
3516 IfIndentElseBranch row col ->
3518 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3519 region = toRegion row col
3521 Report.Report "UNFINISHED IF" region [] $
3522 Code.toSnippet source surroundings (Just region)
3525 "I got stuck after the start of this `else` branch:"
3529 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3531 "I can be confused by indentation, so if the `else` branch is already\
3532 \ present, it may not be indented enough for me to recognize it."
3536 IfIndentElse row col ->
3538 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3539 region = toRegion row col
3541 Report.Report "UNFINISHED IF" region [] $
3542 Code.toSnippet source surroundings (Just region)
3545 "I was expecting to see an `else` branch after this:"
3549 "I know what to do when the condition is `True`, but not when it is `False`."
3551 ["Add","an",D.cyan "else","branch","to","handle","that","scenario!"]
3560toRecordReport :: Code.Source -> Context -> Record -> Row -> Col -> Report.Report
3561toRecordReport source context record startRow startCol =
3563 RecordOpen row col ->
3564 case Code.whatIsNext source row col of
3565 Code.Keyword keyword ->
3567 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3568 region = toKeywordRegion row col keyword
3570 Report.Report "RESERVED WORD" region [] $
3571 Code.toSnippet source surroundings (Just region)
3574 "I just started parsing a record, but I got stuck on this field name:"
3577 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3578 \ that is a reserved word. Try using a different name!"
3583 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3584 region = toRegion row col
3586 Report.Report "UNFINISHED RECORD" region [] $
3587 Code.toSnippet source surroundings (Just region)
3590 "I just started parsing a record, but I got stuck here:"
3593 ["Records","look","like",D.dullyellow "{ x = 3, y = 4 },"
3594 ,"so","I","was","expecting","to","see","a","field","name","next."
3598 RecordEnd row col ->
3600 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3601 region = toRegion row col
3603 Report.Report "UNFINISHED RECORD" region [] $
3604 Code.toSnippet source surroundings (Just region)
3607 "I am partway through parsing a record, but I got stuck here:"
3611 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
3612 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
3615 "When I get stuck like this, it usually means that there is a missing parenthesis\
3616 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
3620 RecordField row col ->
3621 case Code.whatIsNext source row col of
3622 Code.Keyword keyword ->
3624 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3625 region = toKeywordRegion row col keyword
3627 Report.Report "RESERVED WORD" region [] $
3628 Code.toSnippet source surroundings (Just region)
3631 "I am partway through parsing a record, but I got stuck on this field name:"
3634 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3635 \ that is a reserved word. Try using a different name!"
3640 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3641 region = toRegion row col
3643 Report.Report "UNFINISHED RECORD" region [] $
3644 Code.toSnippet source surroundings (Just region)
3647 "I am partway through parsing a record, but I got stuck after that last comma:"
3649 addNoteForRecordError $
3651 "Trailing commas are not allowed in records, so I was expecting to see another\
3652 \ record field defined next. If you are done defining the record, the fix may\
3653 \ be to delete that last comma?"
3656 RecordEquals 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 am partway through parsing a record, but I got stuck here:"
3667 addNoteForRecordError $
3669 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
3670 ,"an","equals","sign","next.","So","try","putting","an",D.green "=","sign","here?"
3674 RecordExpr expr row col ->
3675 toExprReport source (InNode NRecord startRow startCol context) expr row col
3677 RecordSpace space row col ->
3678 toSpaceReport source space row col
3680 RecordIndentOpen row col ->
3682 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3683 region = toRegion row col
3685 Report.Report "UNFINISHED RECORD" region [] $
3686 Code.toSnippet source surroundings (Just region)
3689 "I just saw the opening curly brace of a record, but then I got stuck here:"
3691 addNoteForRecordIndentError $
3693 ["I","am","expecting","a","record","like",D.dullyellow "{ x = 3, y = 4 }","here."
3694 ,"Try","defining","some","fields","of","your","own?"
3698 RecordIndentEnd row col ->
3700 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3701 region = toRegion row col
3703 Report.Report "UNFINISHED RECORD" region [] $
3704 Code.toSnippet source surroundings (Just region)
3707 "I was expecting to see a closing curly brace next:"
3709 addNoteForRecordIndentError $
3711 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
3715 RecordIndentField row col ->
3717 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3718 region = toRegion row col
3720 Report.Report "UNFINISHED RECORD" region [] $
3721 Code.toSnippet source surroundings (Just region)
3724 "I am partway through parsing a record, but I got stuck after that last comma:"
3726 addNoteForRecordError $
3728 "Trailing commas are not allowed in records, so the fix may be to\
3729 \ delete that last comma? Or maybe you were in the middle of defining\
3730 \ an additional field?"
3733 RecordIndentEquals row col ->
3735 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3736 region = toRegion row col
3738 Report.Report "UNFINISHED RECORD" region [] $
3739 Code.toSnippet source surroundings (Just region)
3742 "I am partway through parsing a record. I just saw a record\
3743 \ field, so I was expecting to see an equals sign next:"
3745 addNoteForRecordIndentError $
3747 ["Try","putting","an",D.green "=","followed","by","an","expression?"
3751 RecordIndentExpr row col ->
3753 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3754 region = toRegion row col
3756 Report.Report "UNFINISHED RECORD" region [] $
3757 Code.toSnippet source surroundings (Just region)
3760 "I am partway through parsing a record, and I was expecting to run into an expression next:"
3762 addNoteForRecordIndentError $
3764 ["Try","putting","something","like"
3765 ,D.dullyellow "42","or",D.dullyellow"\"hello\"","for","now?"
3770addNoteForRecordError :: D.Doc -> D.Doc
3771addNoteForRecordError normalRecommendation =
3773 normalRecommendation
3776 "If you are trying to define a record across multiple lines, I recommend using this format:"
3777 , D.indent 4 $ D.vcat $
3778 [ "{ name = \"Alice\""
3784 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3785 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3786 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3790addNoteForRecordIndentError :: D.Doc -> D.Doc
3791addNoteForRecordIndentError normalRecommendation =
3793 normalRecommendation
3796 "I may be confused by indentation. For example, if you are trying to define\
3797 \ a record across multiple lines, I recommend using this format:"
3798 , D.indent 4 $ D.vcat $
3799 [ "{ name = \"Alice\""
3805 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3806 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3807 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3815toTupleReport :: Code.Source -> Context -> Tuple -> Row -> Col -> Report.Report
3816toTupleReport source context tuple startRow startCol =
3818 TupleExpr expr row col ->
3819 toExprReport source (InNode NParens startRow startCol context) expr row col
3821 TupleSpace space row col ->
3822 toSpaceReport source space row col
3826 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3827 region = toRegion row col
3829 Report.Report "UNFINISHED PARENTHESES" region [] $
3830 Code.toSnippet source surroundings (Just region)
3833 "I was expecting to see a closing parentheses next, but I got stuck here:"
3836 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
3838 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
3839 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
3840 \ or missing brackets) that is confusing me."
3844 TupleOperatorClose row col ->
3846 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3847 region = toRegion row col
3849 Report.Report "UNFINISHED OPERATOR FUNCTION" region [] $
3850 Code.toSnippet source surroundings (Just region)
3852 D.reflow "I was expecting a closing parenthesis here:"
3855 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
3857 "I think I am parsing an operator function right now, so I am expecting to see\
3858 \ something like (+) or (&&) where an operator is surrounded by parentheses with\
3863 TupleOperatorReserved operator row col ->
3865 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3866 region = toRegion row col
3868 Report.Report "UNEXPECTED SYMBOL" region [] $
3869 Code.toSnippet source surroundings (Just region)
3872 "I ran into an unexpected symbol here:"
3876 BadDot -> ["Maybe","you","wanted","a","record","accessor","like",D.dullyellow ".x","or",D.dullyellow ".name","instead?"]
3877 BadPipe -> ["Try",D.dullyellow "(||)","instead?","To","turn","boolean","OR","into","a","function?"]
3878 BadArrow -> ["Maybe","you","wanted",D.dullyellow "(>)","or",D.dullyellow "(>=)","instead?"]
3879 BadEquals -> ["Try",D.dullyellow "(==)","instead?","To","make","a","function","that","checks","equality?"]
3880 BadHasType -> ["Try",D.dullyellow "(::)","instead?","To","add","values","to","the","front","of","lists?"]
3883 TupleIndentExpr1 row col ->
3885 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3886 region = toRegion row col
3888 Report.Report "UNFINISHED PARENTHESES" region [] $
3889 Code.toSnippet source surroundings (Just region)
3892 "I just saw an open parenthesis, so I was expecting to see an expression next."
3896 ["Something","like",D.dullyellow "(4 + 5)","or"
3897 ,D.dullyellow "(String.reverse \"desserts\")" <> "."
3898 ,"Anything","where","you","are","putting","parentheses","around","normal","expressions."
3901 "I can get confused by indentation in cases like this, so\
3902 \ maybe you have an expression but it is not indented enough?"
3906 TupleIndentExprN row col ->
3908 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3909 region = toRegion row col
3911 Report.Report "UNFINISHED TUPLE" region [] $
3912 Code.toSnippet source surroundings (Just region)
3915 "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."
3919 ["A","tuple","looks","like",D.dullyellow "(3,4)","or"
3920 ,D.dullyellow "(\"Tom\",42)" <> ","
3921 ,"so","I","think","there","is","an","expression","missing","here?"
3924 "I can get confused by indentation in cases like this, so\
3925 \ maybe you have an expression but it is not indented enough?"
3929 TupleIndentEnd row col ->
3931 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3932 region = toRegion row col
3934 Report.Report "UNFINISHED PARENTHESES" region [] $
3935 Code.toSnippet source surroundings (Just region)
3938 "I was expecting to see a closing parenthesis next:"
3941 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
3943 "I can get confused by indentation in cases like this, so\
3944 \ maybe you have a closing parenthesis but it is not indented enough?"
3949toListReport :: Code.Source -> Context -> List -> Row -> Col -> Report.Report
3950toListReport source context list startRow startCol =
3952 ListSpace space row col ->
3953 toSpaceReport source space row col
3957 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3958 region = toRegion row col
3960 Report.Report "UNFINISHED LIST" region [] $
3961 Code.toSnippet source surroundings (Just region)
3964 "I am partway through parsing a list, but I got stuck here:"
3968 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
3969 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
3972 "When I get stuck like this, it usually means that there is a missing parenthesis\
3973 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
3977 ListExpr expr row col ->
3981 surroundings = A.Region (A.Position startRow startCol) (A.Position r c)
3982 region = toRegion r c
3984 Report.Report "UNFINISHED LIST" region [] $
3985 Code.toSnippet source surroundings (Just region)
3988 "I was expecting to see another list entry after that last comma:"
3992 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
3994 "I recommend using the following format for lists that span multiple lines:"
3995 , D.indent 4 $ D.vcat $
4002 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4003 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4004 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4009 toExprReport source (InNode NList startRow startCol context) expr row col
4013 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4014 region = toRegion row col
4016 Report.Report "UNFINISHED LIST" region [] $
4017 Code.toSnippet source surroundings (Just region)
4020 "I am partway through parsing a list, but I got stuck here:"
4024 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
4025 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
4028 "When I get stuck like this, it usually means that there is a missing parenthesis\
4029 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4033 ListIndentOpen row col ->
4035 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4036 region = toRegion row col
4038 Report.Report "UNFINISHED LIST" region [] $
4039 Code.toSnippet source surroundings (Just region)
4042 "I cannot find the end of this list:"
4046 ["You","could","change","it","to","something","like"
4047 ,D.dullyellow "[3,4,5]"
4049 ,D.dullyellow "[]" <> "."
4050 ,"Anything","where","there","is","an","open","and","close","square","brace,"
4051 ,"and","where","the","elements","of","the","list","are","separated","by","commas."
4054 "I may be confused by indentation. For example, if you are trying to define\
4055 \ a list across multiple lines, I recommend using this format:"
4056 , D.indent 4 $ D.vcat $
4063 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4064 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4065 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4069 ListIndentEnd row col ->
4071 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4072 region = toRegion row col
4074 Report.Report "UNFINISHED LIST" region [] $
4075 Code.toSnippet source surroundings (Just region)
4078 "I cannot find the end of this list:"
4082 ["You","can","just","add","a","closing",D.dullyellow "]"
4083 ,"right","here,","and","I","will","be","all","set!"
4086 "I may be confused by indentation. For example, if you are trying to define\
4087 \ a list across multiple lines, I recommend using this format:"
4088 , D.indent 4 $ D.vcat $
4095 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4096 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4097 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4101 ListIndentExpr row col ->
4103 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4104 region = toRegion row col
4106 Report.Report "UNFINISHED LIST" region [] $
4107 Code.toSnippet source surroundings (Just region)
4110 "I was expecting to see another list entry after this comma:"
4114 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
4116 "I recommend using the following format for lists that span multiple lines:"
4117 , D.indent 4 $ D.vcat $
4124 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4125 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4126 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4131toFuncReport :: Code.Source -> Context -> Func -> Row -> Col -> Report.Report
4132toFuncReport source context func startRow startCol =
4134 FuncSpace space row col ->
4135 toSpaceReport source space row col
4137 FuncArg pattern row col ->
4138 toPatternReport source PArg pattern row col
4140 FuncBody expr row col ->
4141 toExprReport source (InNode NFunc startRow startCol context) expr row col
4143 FuncArrow row col ->
4144 case Code.whatIsNext source row col of
4145 Code.Keyword keyword ->
4147 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4148 region = toKeywordRegion row col keyword
4150 Report.Report "RESERVED WORD" region [] $
4151 Code.toSnippet source surroundings (Just region)
4154 "I was parsing an anonymous function, but I got stuck here:"
4157 "It looks like you are trying to use `" ++ keyword ++ "` as an argument, but\
4158 \ it is a reserved word in this language. Try using a different argument name!"
4163 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4164 region = toRegion row col
4166 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4167 Code.toSnippet source surroundings (Just region)
4170 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4173 ["The","syntax","for","anonymous","functions","is"
4174 ,D.dullyellow "(\\x -> x + 1)"
4175 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4179 FuncIndentArg row col ->
4181 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4182 region = toRegion row col
4184 Report.Report "MISSING ARGUMENT" region [] $
4185 Code.toSnippet source surroundings (Just region)
4188 "I just saw the beginning of an anonymous function, so I was expecting to see an argument next:"
4192 ["Something","like",D.dullyellow"x","or",D.dullyellow "name" <> "."
4193 ,"Anything","that","starts","with","a","lower","case","letter!"
4196 "The syntax for anonymous functions is (\\x -> x + 1) where the backslash\
4197 \ is meant to look a bit like a lambda if you squint. This visual pun seemed\
4198 \ like a better idea at the time!"
4202 FuncIndentArrow row col ->
4204 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4205 region = toRegion row col
4207 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4208 Code.toSnippet source surroundings (Just region)
4211 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4215 ["The","syntax","for","anonymous","functions","is"
4216 ,D.dullyellow "(\\x -> x + 1)"
4217 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4220 "It is possible that I am confused about indetation! I generally recommend\
4221 \ switching to named functions if the definition cannot fit inline nicely, so\
4222 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4223 \ the whole thing out into a named function. Things tend to be clearer that way!"
4227 FuncIndentBody row col ->
4229 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4230 region = toRegion row col
4232 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4233 Code.toSnippet source surroundings (Just region)
4236 "I was expecting to see the body of your anonymous function next:"
4240 ["The","syntax","for","anonymous","functions","is"
4241 ,D.dullyellow "(\\x -> x + 1)"
4242 ,"so","I","am","missing","all","the","stuff","after","the","arrow!"
4245 "It is possible that I am confused about indetation! I generally recommend\
4246 \ switching to named functions if the definition cannot fit inline nicely, so\
4247 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4248 \ the whole thing out into a named function. Things tend to be clearer that way!"
4263toPatternReport :: Code.Source -> PContext -> Pattern -> Row -> Col -> Report.Report
4264toPatternReport source context pattern startRow startCol =
4266 PRecord record row col ->
4267 toPRecordReport source record row col
4269 PTuple tuple row col ->
4270 toPTupleReport source context tuple row col
4272 PList list row col ->
4273 toPListReport source context list row col
4276 case Code.whatIsNext source row col of
4277 Code.Keyword keyword ->
4279 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4280 region = toKeywordRegion row col keyword
4283 PArg -> "as an argument"
4284 PCase -> "in this pattern"
4285 PLet -> "in this pattern"
4287 Report.Report "RESERVED WORD" region [] $
4288 Code.toSnippet source surroundings (Just region)
4291 "It looks like you are trying to use `" ++ keyword ++ "` " ++ inThisThing ++ ":"
4294 "This is a reserved word! Try using some other name?"
4297 Code.Operator "-" ->
4299 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4300 region = toRegion row col
4302 Report.Report "UNEXPECTED SYMBOL" region [] $
4303 Code.toSnippet source surroundings (Just region)
4306 "I ran into a minus sign unexpectedly in this pattern:"
4309 "It is not possible to pattern match on negative numbers at this\
4310 \ time. Try using an `if` expression for that sort of thing for now."
4315 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4316 region = toRegion row col
4318 Report.Report "PROBLEM IN PATTERN" region [] $
4319 Code.toSnippet source surroundings (Just region)
4322 "I wanted to parse a pattern next, but I got stuck here:"
4325 ["I","am","not","sure","why","I","am","getting","stuck","exactly."
4326 ,"I","just","know","that","I","want","a","pattern","next."
4327 ,"Something","as","simple","as"
4328 ,D.dullyellow "maybeHeight","or",D.dullyellow "result"
4333 PChar char row col ->
4334 toCharReport source char row col
4336 PString string row col ->
4337 toStringReport source string row col
4339 PNumber number row col ->
4340 toNumberReport source number row col
4342 PFloat width row col ->
4344 region = toWiderRegion row col width
4346 Report.Report "UNEXPECTED PATTERN" region [] $
4347 Code.toSnippet source region Nothing
4350 "I cannot pattern match with floating point numbers:"
4353 ["Equality","on","floats","can","be","unreliable,","so","you","usually","want"
4354 ,"to","check","that","they","are","nearby","with","some","sort","of"
4355 ,D.dullyellow "(abs (actual - expected) < 0.001)","check."
4361 region = toRegion row col
4363 Report.Report "UNFINISHED PATTERN" region [] $
4364 Code.toSnippet source region Nothing $
4367 "I was expecting to see a variable name after the `as` keyword:"
4371 ["The","`as`","keyword","lets","you","write","patterns","like"
4372 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4373 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4374 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4375 ,"thing","with",D.dullyellow "point."
4378 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4379 \ people just want to use `as` as a variable name though. Try using a different name\
4384 PWildcardNotVar name width row col ->
4386 region = toWiderRegion row col (fromIntegral width)
4388 case dropWhile (=='_') (Name.toChars name) of
4389 [] -> [D.dullyellow "x","or",D.dullyellow "age"]
4390 c:cs -> [D.dullyellow (D.fromChars (Char.toLower c : cs))]
4392 Report.Report "UNEXPECTED NAME" region [] $
4393 Code.toSnippet source region Nothing $
4396 "Variable names cannot start with underscores like this:"
4399 ["You","can","either","have","an","underscore","like",D.dullyellow "_","to"
4400 ,"ignore","the","value,","or","you","can","have","a","name","like"
4401 ] ++ examples ++ ["to","use","the","matched","value." ]
4404 PSpace space row col ->
4405 toSpaceReport source space row col
4407 PIndentStart row col ->
4409 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4410 region = toRegion row col
4412 Report.Report "UNFINISHED PATTERN" region [] $
4413 Code.toSnippet source surroundings (Just region)
4416 "I wanted to parse a pattern next, but I got stuck here:"
4420 ["I","am","not","sure","why","I","am","getting","stuck","exactly."
4421 ,"I","just","know","that","I","want","a","pattern","next."
4422 ,"Something","as","simple","as"
4423 ,D.dullyellow "maybeHeight","or",D.dullyellow "result"
4427 "I can get confused by indentation. If you think there is a pattern next, maybe\
4428 \ it needs to be indented a bit more?"
4432 PIndentAlias row col ->
4434 region = toRegion row col
4436 Report.Report "UNFINISHED PATTERN" region [] $
4437 Code.toSnippet source region Nothing $
4440 "I was expecting to see a variable name after the `as` keyword:"
4444 ["The","`as`","keyword","lets","you","write","patterns","like"
4445 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4446 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4447 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4448 ,"thing","with",D.dullyellow "point."
4451 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4452 \ people just want to use `as` as a variable name though. Try using a different name\
4458toPRecordReport :: Code.Source -> PRecord -> Row -> Col -> Report.Report
4459toPRecordReport source record startRow startCol =
4461 PRecordOpen row col ->
4462 toUnfinishRecordPatternReport source row col startRow startCol $
4463 D.reflow "I was expecting to see a field name next."
4465 PRecordEnd row col ->
4466 toUnfinishRecordPatternReport source row col startRow startCol $
4468 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4469 ,"Try","adding","a",D.dullyellow "}","here?"
4472 PRecordField row col ->
4473 case Code.whatIsNext source row col of
4474 Code.Keyword keyword ->
4476 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4477 region = toKeywordRegion row col keyword
4479 Report.Report "RESERVED WORD" region [] $
4480 Code.toSnippet source surroundings (Just region)
4483 "I was not expecting to see `" ++ keyword ++ "` as a record field name:"
4486 "This is a reserved word, not available for variable names. Try another name!"
4490 toUnfinishRecordPatternReport source row col startRow startCol $
4491 D.reflow "I was expecting to see a field name next."
4493 PRecordSpace space row col ->
4494 toSpaceReport source space row col
4496 PRecordIndentOpen row col ->
4497 toUnfinishRecordPatternReport source row col startRow startCol $
4498 D.reflow "I was expecting to see a field name next."
4500 PRecordIndentEnd row col ->
4501 toUnfinishRecordPatternReport source row col startRow startCol $
4503 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4504 ,"Try","adding","a",D.dullyellow "}","here?"
4507 PRecordIndentField row col ->
4508 toUnfinishRecordPatternReport source row col startRow startCol $
4509 D.reflow "I was expecting to see a field name next."
4512toUnfinishRecordPatternReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
4513toUnfinishRecordPatternReport source row col startRow startCol message =
4515 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4516 region = toRegion row col
4518 Report.Report "UNFINISHED RECORD PATTERN" region [] $
4519 Code.toSnippet source surroundings (Just region)
4522 "I was partway through parsing a record pattern, but I got stuck here:"
4527 ["A","record","pattern","looks","like",D.dullyellow "{x,y}","or",D.dullyellow "{name,age}"
4528 ,"where","you","list","the","field","names","you","want","to","access."
4535toPTupleReport :: Code.Source -> PContext -> PTuple -> Row -> Col -> Report.Report
4536toPTupleReport source context tuple startRow startCol =
4538 PTupleOpen row col ->
4539 case Code.whatIsNext source row col of
4540 Code.Keyword keyword ->
4542 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4543 region = toKeywordRegion row col keyword
4545 Report.Report "RESERVED WORD" region [] $
4546 Code.toSnippet source surroundings (Just region)
4549 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name:"
4552 "This is a reserved word! Try using some other name?"
4557 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4558 region = toRegion row col
4560 Report.Report "UNFINISHED PARENTHESES" region [] $
4561 Code.toSnippet source surroundings (Just region)
4564 "I just saw an open parenthesis, but I got stuck here:"
4567 ["I","was","expecting","so","see","a","pattern","next."
4568 ,"Maybe","it","will","end","up","being","something"
4569 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4573 PTupleEnd row col ->
4574 case Code.whatIsNext source row col of
4575 Code.Keyword keyword ->
4577 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4578 region = toKeywordRegion row col keyword
4580 Report.Report "RESERVED WORD" region [] $
4581 Code.toSnippet source surroundings (Just region) $
4584 "I ran into a reserved word in this pattern:"
4587 "The `" ++ keyword ++ "` keyword is reserved. Try using a different name instead!"
4592 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4593 region = toKeywordRegion row col op
4595 Report.Report "UNEXPECTED SYMBOL" region [] $
4596 Code.toSnippet source surroundings (Just region) $
4599 "I ran into the " ++ op ++ " symbol unexpectedly in this pattern:"
4602 "Only the :: symbol that works in patterns. It is useful if you\
4603 \ are pattern matching on lists, trying to get the first element\
4604 \ off the front. Did you want that instead?"
4607 Code.Close term bracket ->
4609 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4610 region = toRegion row col
4612 Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
4613 Code.toSnippet source surroundings (Just region) $
4616 "I ran into a an unexpected " ++ term ++ " in this pattern:"
4619 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
4624 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4625 region = toRegion row col
4627 Report.Report "UNFINISHED PARENTHESES" region [] $
4628 Code.toSnippet source surroundings (Just region) $
4631 "I was partway through parsing a pattern, but I got stuck here:"
4634 ["I","was","expecting","a","closing","parenthesis","next,","so"
4635 ,"try","adding","a",D.dullyellow ")","to","see","if","that","helps?"
4639 PTupleExpr pattern row col ->
4640 toPatternReport source context pattern row col
4642 PTupleSpace space row col ->
4643 toSpaceReport source space row col
4645 PTupleIndentEnd row col ->
4647 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4648 region = toRegion row col
4650 Report.Report "UNFINISHED PARENTHESES" region [] $
4651 Code.toSnippet source surroundings (Just region) $
4654 "I was expecting a closing parenthesis next:"
4657 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
4659 "I can get confused by indentation in cases like this, so\
4660 \ maybe you have a closing parenthesis but it is not indented enough?"
4664 PTupleIndentExpr1 row col ->
4666 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4667 region = toRegion row col
4669 Report.Report "UNFINISHED PARENTHESES" region [] $
4670 Code.toSnippet source surroundings (Just region) $
4673 "I just saw an open parenthesis, but then I got stuck here:"
4676 ["I","was","expecting","so","see","a","pattern","next."
4677 ,"Maybe","it","will","end","up","being","something"
4678 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4682 PTupleIndentExprN row col ->
4684 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4685 region = toRegion row col
4687 Report.Report "UNFINISHED TUPLE PATTERN" region [] $
4688 Code.toSnippet source surroundings (Just region) $
4691 "I am partway through parsing a tuple pattern, but I got stuck here:"
4695 ["I","was","expecting","so","see","a","pattern","next."
4696 ,"I","am","expecting","the","final","result","to","be","something"
4697 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "."
4700 "I can get confused by indentation in cases like this, so the problem\
4701 \ may be that the next part is not indented enough?"
4706toPListReport :: Code.Source -> PContext -> PList -> Row -> Col -> Report.Report
4707toPListReport source context list startRow startCol =
4709 PListOpen row col ->
4710 case Code.whatIsNext source row col of
4711 Code.Keyword keyword ->
4713 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4714 region = toKeywordRegion row col keyword
4716 Report.Report "RESERVED WORD" region [] $
4717 Code.toSnippet source surroundings (Just region)
4720 "It looks like you are trying to use `" ++ keyword ++ "` to name an element of a list:"
4723 "This is a reserved word though! Try using some other name?"
4728 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4729 region = toRegion row col
4731 Report.Report "UNFINISHED LIST PATTERN" region [] $
4732 Code.toSnippet source surroundings (Just region) $
4735 "I just saw an open square bracket, but then I got stuck here:"
4737 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4742 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4743 region = toRegion row col
4745 Report.Report "UNFINISHED LIST PATTERN" region [] $
4746 Code.toSnippet source surroundings (Just region) $
4749 "I was expecting a closing square bracket to end this list pattern:"
4751 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4754 PListExpr pattern row col ->
4755 toPatternReport source context pattern row col
4757 PListSpace space row col ->
4758 toSpaceReport source space row col
4760 PListIndentOpen row col ->
4762 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4763 region = toRegion row col
4765 Report.Report "UNFINISHED LIST PATTERN" region [] $
4766 Code.toSnippet source surroundings (Just region) $
4769 "I just saw an open square bracket, but then I got stuck here:"
4772 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4774 "I can get confused by indentation in cases like this, so\
4775 \ maybe there is something next, but it is not indented enough?"
4779 PListIndentEnd row col ->
4781 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4782 region = toRegion row col
4784 Report.Report "UNFINISHED LIST PATTERN" region [] $
4785 Code.toSnippet source surroundings (Just region) $
4788 "I was expecting a closing square bracket to end this list pattern:"
4791 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4793 "I can get confused by indentation in cases like this, so\
4794 \ maybe you have a closing square bracket but it is not indented enough?"
4798 PListIndentExpr row col ->
4800 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4801 region = toRegion row col
4803 Report.Report "UNFINISHED LIST PATTERN" region [] $
4804 Code.toSnippet source surroundings (Just region) $
4807 "I am partway through parsing a list pattern, but I got stuck here:"
4811 "I was expecting to see another pattern next. Maybe a variable name."
4813 "I can get confused by indentation in cases like this, so\
4814 \ maybe there is more to this pattern but it is not indented enough?"
4824 = TC_Annotation Name.Name
4830toTypeReport :: Code.Source -> TContext -> Type -> Row -> Col -> Report.Report
4831toTypeReport source context tipe startRow startCol =
4833 TRecord record row col ->
4834 toTRecordReport source context record row col
4836 TTuple tuple row col ->
4837 toTTupleReport source context tuple row col
4840 case Code.whatIsNext source row col of
4841 Code.Keyword keyword ->
4843 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4844 region = toKeywordRegion row col keyword
4846 Report.Report "RESERVED WORD" region [] $
4847 Code.toSnippet source surroundings (Just region)
4850 "I was expecting to see a type next, but I got stuck on this reserved word:"
4853 "It looks like you are trying to use `" ++ keyword ++ "` as a type variable, but \
4854 \ it is a reserved word. Try using a different name!"
4859 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4860 region = toRegion row col
4864 TC_Annotation _ -> "type annotation"
4865 TC_CustomType -> "custom type"
4866 TC_TypeAlias -> "type alias"
4871 TC_Annotation name -> "the `" ++ Name.toChars name ++ "` type annotation"
4872 TC_CustomType -> "a custom type"
4873 TC_TypeAlias -> "a type alias"
4876 Report.Report ("PROBLEM IN " ++ map Char.toUpper thing) region [] $
4877 Code.toSnippet source surroundings (Just region)
4880 "I was partway through parsing " ++ something ++ ", but I got stuck here:"
4883 ["I","was","expecting","to","see","a","type","next."
4884 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
4888 TSpace space row col ->
4889 toSpaceReport source space row col
4891 TIndentStart row col ->
4893 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4894 region = toRegion row col
4898 TC_Annotation _ -> "type annotation"
4899 TC_CustomType -> "custom type"
4900 TC_TypeAlias -> "type alias"
4903 Report.Report ("UNFINISHED " ++ map Char.toUpper thing) region [] $
4904 Code.toSnippet source surroundings (Just region)
4907 "I was partway through parsing a " ++ thing ++ ", but I got stuck here:"
4911 ["I","was","expecting","to","see","a","type","next."
4912 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
4915 "I can get confused by indentation. If you think there is already a type\
4916 \ next, maybe it is not indented enough?"
4921toTRecordReport :: Code.Source -> TContext -> TRecord -> Row -> Col -> Report.Report
4922toTRecordReport source context record startRow startCol =
4924 TRecordOpen row col ->
4925 case Code.whatIsNext source row col of
4926 Code.Keyword keyword ->
4928 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4929 region = toKeywordRegion row col keyword
4931 Report.Report "RESERVED WORD" region [] $
4932 Code.toSnippet source surroundings (Just region)
4935 "I just started parsing a record type, but I got stuck on this field name:"
4938 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
4939 \ that is a reserved word. Try using a different name!"
4944 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4945 region = toRegion row col
4947 Report.Report "UNFINISHED RECORD TYPE" region [] $
4948 Code.toSnippet source surroundings (Just region)
4951 "I just started parsing a record type, but I got stuck here:"
4954 ["Record","types","look","like",D.dullyellow "{ name : String, age : Int },"
4955 ,"so","I","was","expecting","to","see","a","field","name","next."
4959 TRecordEnd row col ->
4961 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4962 region = toRegion row col
4964 Report.Report "UNFINISHED RECORD TYPE" region [] $
4965 Code.toSnippet source surroundings (Just region)
4968 "I am partway through parsing a record type, but I got stuck here:"
4972 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
4973 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
4976 "When I get stuck like this, it usually means that there is a missing parenthesis\
4977 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4981 TRecordField row col ->
4982 case Code.whatIsNext source row col of
4983 Code.Keyword keyword ->
4985 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4986 region = toKeywordRegion row col keyword
4988 Report.Report "RESERVED WORD" region [] $
4989 Code.toSnippet source surroundings (Just region)
4992 "I am partway through parsing a record type, but I got stuck on this field name:"
4995 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
4996 \ that is a reserved word. Try using a different name!"
5001 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5002 region = toRegion row col
5004 Report.Report "UNFINISHED RECORD TYPE" region [] $
5005 Code.toSnippet source surroundings (Just region)
5008 "I am partway through parsing a record type, but I got stuck after that last comma:"
5010 addNoteForRecordTypeError $
5012 "Trailing commas are not allowed in records, so I was expecting to see another\
5013 \ record field defined next. If you are done defining the record, the fix may\
5014 \ be to delete that last comma?"
5017 TRecordColon row col ->
5019 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5020 region = toRegion row col
5022 Report.Report "UNFINISHED RECORD TYPE" region [] $
5023 Code.toSnippet source surroundings (Just region)
5026 "I am partway through parsing a record type, but I got stuck here:"
5028 addNoteForRecordTypeError $
5030 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
5031 ,"a","colon","next.","So","try","putting","an",D.green ":","sign","here?"
5035 TRecordType tipe row col ->
5036 toTypeReport source context tipe row col
5038 TRecordSpace space row col ->
5039 toSpaceReport source space row col
5041 TRecordIndentOpen row col ->
5043 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5044 region = toRegion row col
5046 Report.Report "UNFINISHED RECORD TYPE" region [] $
5047 Code.toSnippet source surroundings (Just region)
5050 "I just saw the opening curly brace of a record type, but then I got stuck here:"
5052 addNoteForRecordTypeIndentError $
5054 ["I","am","expecting","a","record","like",D.dullyellow "{ name : String, age : Int }","here."
5055 ,"Try","defining","some","fields","of","your","own?"
5059 TRecordIndentEnd row col ->
5061 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5062 region = toRegion row col
5064 Report.Report "UNFINISHED RECORD TYPE" region [] $
5065 Code.toSnippet source surroundings (Just region)
5068 "I was expecting to see a closing curly brace next:"
5070 addNoteForRecordTypeIndentError $
5072 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
5076 TRecordIndentField row col ->
5078 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5079 region = toRegion row col
5081 Report.Report "UNFINISHED RECORD TYPE" region [] $
5082 Code.toSnippet source surroundings (Just region)
5085 "I am partway through parsing a record type, but I got stuck after that last comma:"
5087 addNoteForRecordTypeIndentError $
5089 "Trailing commas are not allowed in record types, so the fix may be to\
5090 \ delete that last comma? Or maybe you were in the middle of defining\
5091 \ an additional field?"
5094 TRecordIndentColon row col ->
5096 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5097 region = toRegion row col
5099 Report.Report "UNFINISHED RECORD TYPE" region [] $
5100 Code.toSnippet source surroundings (Just region)
5103 "I am partway through parsing a record type. I just saw a record\
5104 \ field, so I was expecting to see a colon next:"
5106 addNoteForRecordTypeIndentError $
5108 ["Try","putting","an",D.green ":","followed","by","a","type?"
5112 TRecordIndentType row col ->
5114 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5115 region = toRegion row col
5117 Report.Report "UNFINISHED RECORD TYPE" region [] $
5118 Code.toSnippet source surroundings (Just region)
5121 "I am partway through parsing a record type, and I was expecting to run into a type next:"
5123 addNoteForRecordTypeIndentError $
5125 ["Try","putting","something","like"
5126 ,D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5131addNoteForRecordTypeError :: D.Doc -> D.Doc
5132addNoteForRecordTypeError normalRecommendation =
5134 normalRecommendation
5137 "If you are trying to define a record type across multiple lines, I recommend using this format:"
5138 , D.indent 4 $ D.vcat $
5141 , ", height : Float"
5145 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5146 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5147 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5151addNoteForRecordTypeIndentError :: D.Doc -> D.Doc
5152addNoteForRecordTypeIndentError normalRecommendation =
5154 normalRecommendation
5157 "I may be confused by indentation. For example, if you are trying to define\
5158 \ a record type across multiple lines, I recommend using this format:"
5159 , D.indent 4 $ D.vcat $
5162 , ", height : Float"
5166 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5167 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5168 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5172toTTupleReport :: Code.Source -> TContext -> TTuple -> Row -> Col -> Report.Report
5173toTTupleReport source context tuple startRow startCol =
5175 TTupleOpen row col ->
5176 case Code.whatIsNext source row col of
5177 Code.Keyword keyword ->
5179 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5180 region = toKeywordRegion row col keyword
5182 Report.Report "RESERVED WORD" region [] $
5183 Code.toSnippet source surroundings (Just region)
5186 "I ran into a reserved word unexpectedly:"
5189 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but \
5190 \ it is a reserved word. Try using a different name!"
5195 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5196 region = toRegion row col
5198 Report.Report "UNFINISHED PARENTHESES" region [] $
5199 Code.toSnippet source surroundings (Just region)
5202 "I just saw an open parenthesis, so I was expecting to see a type next."
5205 ["Something","like",D.dullyellow "(Maybe Int)","or"
5206 ,D.dullyellow "(List Person)" <> "."
5207 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5211 TTupleEnd row col ->
5213 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5214 region = toRegion row col
5216 Report.Report "UNFINISHED PARENTHESES" region [] $
5217 Code.toSnippet source surroundings (Just region)
5220 "I was expecting to see a closing parentheses next, but I got stuck here:"
5223 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
5225 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
5226 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
5227 \ or missing brackets) that is confusing me."
5231 TTupleType tipe row col ->
5232 toTypeReport source context tipe row col
5234 TTupleSpace space row col ->
5235 toSpaceReport source space row col
5237 TTupleIndentType1 row col ->
5239 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5240 region = toRegion row col
5242 Report.Report "UNFINISHED PARENTHESES" region [] $
5243 Code.toSnippet source surroundings (Just region)
5246 "I just saw an open parenthesis, so I was expecting to see a type next."
5250 ["Something","like",D.dullyellow "(Maybe Int)","or"
5251 ,D.dullyellow "(List Person)" <> "."
5252 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5255 "I can get confused by indentation in cases like this, so\
5256 \ maybe you have a type but it is not indented enough?"
5260 TTupleIndentTypeN row col ->
5262 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5263 region = toRegion row col
5265 Report.Report "UNFINISHED TUPLE TYPE" region [] $
5266 Code.toSnippet source surroundings (Just region)
5269 "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."
5273 ["A","tuple","type","looks","like",D.dullyellow "(Float,Float)","or"
5274 ,D.dullyellow "(String,Int)" <> ","
5275 ,"so","I","think","there","is","a","type","missing","here?"
5278 "I can get confused by indentation in cases like this, so\
5279 \ maybe you have an expression but it is not indented enough?"
5283 TTupleIndentEnd row col ->
5285 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5286 region = toRegion row col
5288 Report.Report "UNFINISHED PARENTHESES" region [] $
5289 Code.toSnippet source surroundings (Just region)
5292 "I was expecting to see a closing parenthesis next:"
5295 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
5297 "I can get confused by indentation in cases like this, so\
5298 \ 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