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 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?"
619 Code.Other maybeChar ->
621 region = toRegion row col
625 Report.Report "UNEXPECTED SEMICOLON" region [] $
626 Code.toSnippet source region Nothing
629 "I got stuck on this semicolon:"
632 [ D.reflow $ "Try removing it?"
634 "Some languages require semicolons at the end of each statement. These are\
635 \ often called C-like languages, and they usually share a lot of language design\
636 \ choices. (E.g. side-effects, for loops, etc.) Elm manages effects with commands\
637 \ and subscriptions instead, so there is no special syntax for \"statements\" and\
638 \ therefore no need to use semicolons to separate them. I think this will make\
639 \ more sense as you work through <https://guide.elm-lang.org> though!"
644 Report.Report "UNEXPECTED COMMA" region [] $
645 Code.toSnippet source region Nothing
648 "I got stuck on this comma:"
652 "I do not think I am parsing a list or tuple right now. Try deleting the comma?"
654 "If this is supposed to be part of a list, the problem may be a bit earlier.\
655 \ Perhaps the opening [ is missing? Or perhaps some value in the list has an extra\
656 \ closing ] that is making me think the list ended earlier? The same kinds of\
657 \ things could be going wrong if this is supposed to be a tuple."
662 Report.Report "UNEXPECTED CHARACTER" region [] $
663 Code.toSnippet source region Nothing
666 "I got stuck on this character:"
670 "It is not used for anything in Elm syntax. It is used for multi-line strings in\
671 \ some languages though, so if you want a string that spans multiple lines, you\
672 \ can use Elm's multi-line string syntax like this:"
674 [ D.fillSep [D.green "markdown","=",D.dullyellow "\"\"\""]
676 , D.dullyellow "# Multi-line Strings"
678 , D.dullyellow "- start with triple double quotes"
679 , D.dullyellow "- write whatever you want"
680 , D.dullyellow "- no need to escape newlines or double quotes"
681 , D.dullyellow "- end with triple double quotes"
683 , D.dullyellow "\"\"\""
686 "Otherwise I do not know what is going on! Try removing the character?"
691 Report.Report "UNEXPECTED SYMBOL" region [] $
692 Code.toSnippet source region Nothing
695 "I got stuck on this dollar sign:"
698 "It is not used for anything in Elm syntax. Are you coming from a language where\
699 \ dollar signs can be used in variable names? If so, try a name that (1) starts\
700 \ with a letter and (2) only contains letters, numbers, and underscores."
703 Just c | elem c ['#','@','!','%','~'] ->
704 Report.Report "UNEXPECTED SYMBOL" region [] $
705 Code.toSnippet source region Nothing
708 "I got stuck on this symbol:"
711 "It is not used for anything in Elm syntax. Try removing it?"
715 Report.Report "SYNTAX PROBLEM" region [] $
716 Code.toSnippet source region Nothing
722 "Whatever I am running into is confusing me a lot! Normally I can give fairly\
723 \ specific hints, but something is really tripping me up this time."
726 ModuleProblem row col ->
728 region = toRegion row col
730 Report.Report "UNFINISHED MODULE DECLARATION" region [] $
731 Code.toSnippet source region Nothing
734 "I am parsing an `module` declaration, but I got stuck here:"
738 "Here are some examples of valid `module` declarations:"
739 , D.indent 4 $ D.vcat $
740 [ D.fillSep [D.cyan "module","Main",D.cyan "exposing","(..)"]
741 , D.fillSep [D.cyan "module","Dict",D.cyan "exposing","(Dict, empty, get)"]
744 "I generally recommend using an explicit exposing list. I can skip compiling a bunch\
745 \ of files when the public interface of a module stays the same, so exposing fewer\
746 \ values can help improve compile times!"
750 ModuleName row col ->
752 region = toRegion row col
754 Report.Report "EXPECTING MODULE NAME" region [] $
755 Code.toSnippet source region Nothing
758 "I was parsing an `module` declaration until I got stuck here:"
762 "I was expecting to see the module name next, like in these examples:"
763 , D.indent 4 $ D.vcat $
764 [ D.fillSep [D.cyan "module","Dict",D.cyan "exposing","(..)"]
765 , D.fillSep [D.cyan "module","Maybe",D.cyan "exposing","(..)"]
766 , D.fillSep [D.cyan "module","Html.Attributes",D.cyan "exposing","(..)"]
767 , D.fillSep [D.cyan "module","Json.Decode",D.cyan "exposing","(..)"]
770 "Notice that the module names all start with capital letters. That is required!"
774 ModuleExposing exposing row col ->
775 toExposingReport source exposing row col
777 PortModuleProblem row col ->
779 region = toRegion row col
781 Report.Report "UNFINISHED PORT MODULE DECLARATION" region [] $
782 Code.toSnippet source region Nothing
785 "I am parsing an `port module` declaration, but I got stuck here:"
789 "Here are some examples of valid `port module` declarations:"
790 , D.indent 4 $ D.vcat $
791 [ D.fillSep [D.cyan "port",D.cyan "module","WebSockets",D.cyan "exposing","(send, listen, keepAlive)"]
792 , D.fillSep [D.cyan "port",D.cyan "module","Maps",D.cyan "exposing","(Location, goto)"]
794 , D.link "Note" "Read" "ports" "for more help."
798 PortModuleName row col ->
800 region = toRegion row col
802 Report.Report "EXPECTING MODULE NAME" region [] $
803 Code.toSnippet source region Nothing
806 "I was parsing an `module` declaration until I got stuck here:"
810 "I was expecting to see the module name next, like in these examples:"
811 , D.indent 4 $ D.vcat $
812 [ D.fillSep [D.cyan "port",D.cyan "module","WebSockets",D.cyan "exposing","(send, listen, keepAlive)"]
813 , D.fillSep [D.cyan "port",D.cyan "module","Maps",D.cyan "exposing","(Location, goto)"]
816 "Notice that the module names start with capital letters. That is required!"
820 PortModuleExposing exposing row col ->
821 toExposingReport source exposing row col
825 region = toRegion row col
827 Report.Report "BAD MODULE DECLARATION" region [] $
828 Code.toSnippet source region Nothing
831 "I cannot parse this module declaration:"
834 "This type of module is reserved for the @elm organization. It is used to\
835 \ define certain effects, avoiding building them into the compiler."
840 region = toRegion row col
842 toBadFirstLineReport keyword =
843 Report.Report "TOO MUCH INDENTATION" region [] $
844 Code.toSnippet source region Nothing
847 "This `" ++ keyword ++ "` should not have any spaces before it:"
850 "Delete the spaces before `" ++ keyword ++ "` until there are none left!"
854 case Code.whatIsNext source row col of
855 Code.Keyword "module" -> toBadFirstLineReport "module"
856 Code.Keyword "import" -> toBadFirstLineReport "import"
857 Code.Keyword "type" -> toBadFirstLineReport "type"
858 Code.Keyword "port" -> toBadFirstLineReport "port"
860 Report.Report "SYNTAX PROBLEM" region [] $
861 Code.toSnippet source region Nothing
868 "I am not sure what is going on, but I recommend starting an Elm\
869 \ file with the following lines:"
871 [ D.fillSep [D.cyan "import","Html"]
873 , D.fillSep [D.green "main","="]
874 , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
877 "You should be able to copy those lines directly into your file. Check out the\
878 \ examples at <https://elm-lang.org/examples> for more help getting started!"
880 "This can also happen when something is indented too much!"
884 ImportStart row col ->
885 toImportReport source row col
887 ImportName row col ->
889 region = toRegion row col
891 Report.Report "EXPECTING IMPORT NAME" region [] $
892 Code.toSnippet source region Nothing
895 "I was parsing an `import` until I got stuck here:"
899 "I was expecting to see a module name next, like in these examples:"
900 , D.indent 4 $ D.vcat $
901 [ D.fillSep [D.cyan "import","Dict"]
902 , D.fillSep [D.cyan "import","Maybe"]
903 , D.fillSep [D.cyan "import","Html.Attributes"]
904 , D.fillSep [D.cyan "import","Json.Decode"]
907 "Notice that the module names all start with capital letters. That is required!"
912 toImportReport source row col
914 ImportAlias row col ->
916 region = toRegion row col
918 Report.Report "EXPECTING IMPORT ALIAS" region [] $
919 Code.toSnippet source region Nothing
922 "I was parsing an `import` until I got stuck here:"
926 "I was expecting to see an alias next, like in these examples:"
927 , D.indent 4 $ D.vcat $
928 [ D.fillSep [D.cyan "import","Html.Attributes",D.cyan "as","Attr"]
929 , D.fillSep [D.cyan "import","WebGL.Texture",D.cyan "as","Texture"]
930 , D.fillSep [D.cyan "import","Json.Decode",D.cyan "as","D"]
933 "Notice that the alias always starts with a capital letter. That is required!"
937 ImportExposing row col ->
938 toImportReport source row col
940 ImportExposingList exposing row col ->
941 toExposingReport source exposing row col
944 toImportReport source row col
946 ImportIndentName row col ->
947 toImportReport source row col
949 ImportIndentAlias row col ->
950 toImportReport source row col
952 ImportIndentExposingList row col ->
954 region = toRegion row col
956 Report.Report "UNFINISHED IMPORT" region [] $
957 Code.toSnippet source region Nothing
960 "I was parsing an `import` until I got stuck here:"
964 "I was expecting to see the list of exposed values next. For example, here\
965 \ are two ways to expose values from the `Html` module:"
966 , D.indent 4 $ D.vcat $
967 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
968 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
971 "I generally recommend the second style. It is more explicit, making it\
972 \ much easier to figure out where values are coming from in large projects!"
978 region = toRegion row col
980 Report.Report "BAD INFIX" region [] $
981 Code.toSnippet source region Nothing
984 "Something went wrong in this infix operator declaration:"
987 "This feature is used by the @elm organization to define the\
988 \ languages built-in operators."
991 Declarations decl _ _ ->
992 toDeclarationsReport source decl
999toImportReport :: Code.Source -> Row -> Col -> Report.Report
1000toImportReport source row col =
1002 region = toRegion row col
1004 Report.Report "UNFINISHED IMPORT" region [] $
1005 Code.toSnippet source region Nothing
1008 "I am partway through parsing an import, but I got stuck here:"
1012 "Here are some examples of valid `import` declarations:"
1013 , D.indent 4 $ D.vcat $
1014 [ D.fillSep [D.cyan "import","Html"]
1015 , D.fillSep [D.cyan "import","Html",D.cyan "as","H"]
1016 , D.fillSep [D.cyan "import","Html",D.cyan "as","H",D.cyan "exposing","(..)"]
1017 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
1020 "You are probably trying to import a different module, but try to make it look like one of these examples!"
1029toExposingReport :: Code.Source -> Exposing -> Row -> Col -> Report.Report
1030toExposingReport source exposing startRow startCol =
1032 ExposingSpace space row col ->
1033 toSpaceReport source space row col
1035 ExposingStart row col ->
1037 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1038 region = toRegion row col
1040 Report.Report "PROBLEM IN EXPOSING" region [] $
1041 Code.toSnippet source surroundings (Just region)
1044 "I want to parse exposed values, but I am getting stuck here:"
1048 ["Exposed","values","are","always","surrounded","by","parentheses."
1049 ,"So","try","adding","a",D.green "(","here?"
1051 , D.toSimpleNote "Here are some valid examples of `exposing` for reference:"
1052 , D.indent 4 $ D.vcat $
1053 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
1054 , D.fillSep [D.cyan "import","Html",D.cyan "exposing","(Html, div, text)"]
1057 "If you are getting tripped up, you can just expose everything for now. It should\
1058 \ get easier to make an explicit exposing list as you see more examples in the wild."
1062 ExposingValue row col ->
1063 case Code.whatIsNext source row col of
1064 Code.Keyword keyword ->
1066 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1067 region = toKeywordRegion row col keyword
1069 Report.Report "RESERVED WORD" region [] $
1070 Code.toSnippet source surroundings (Just region)
1073 "I got stuck on this reserved word:"
1076 "It looks like you are trying to expose `" ++ keyword ++ "` but that is a reserved word. Is there a typo?"
1081 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1082 region = toKeywordRegion row col op
1084 Report.Report "UNEXPECTED SYMBOL" region [] $
1085 Code.toSnippet source surroundings (Just region)
1088 "I got stuck on this symbol:"
1092 "If you are trying to expose an operator, add parentheses around it like this:"
1093 , D.indent 4 $ D.dullyellow (D.fromChars op) <> " -> " <> D.green ("(" <> D.fromChars op <> ")")
1099 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1100 region = toRegion row col
1102 Report.Report "PROBLEM IN EXPOSING" region [] $
1103 Code.toSnippet source surroundings (Just region)
1106 "I got stuck while parsing these exposed values:"
1110 "I do not have an exact recommendation, so here are some valid examples\
1111 \ of `exposing` for reference:"
1112 , D.indent 4 $ D.vcat $
1113 [ D.fillSep [D.cyan "import","Html",D.cyan "exposing","(..)"]
1114 , D.fillSep [D.cyan "import","Basics",D.cyan "exposing","(Int, Float, Bool(..), (+), not, sqrt)"]
1117 "These examples show how to expose types, variants, operators, and functions. Everything\
1118 \ should be some permutation of these examples, just with different names."
1122 ExposingOperator row col ->
1124 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1125 region = toRegion row col
1127 Report.Report "PROBLEM IN EXPOSING" region [] $
1128 Code.toSnippet source surroundings (Just region)
1131 "I just saw an open parenthesis, so I was expecting an operator next:"
1134 ["It","is","possible","to","expose","operators,","so","I","was","expecting"
1135 ,"to","see","something","like",D.dullyellow "(+)","or",D.dullyellow "(|=)"
1136 ,"or",D.dullyellow "(||)","after","I","saw","that","open","parenthesis."
1140 ExposingOperatorReserved op row col ->
1142 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1143 region = toRegion row col
1145 Report.Report "RESERVED SYMBOL" region [] $
1146 Code.toSnippet source surroundings (Just region)
1149 "I cannot expose this as an operator:"
1152 BadDot -> D.reflow "Try getting rid of this entry? Maybe I can give you a better hint after that?"
1153 BadPipe -> D.fillSep ["Maybe","you","want",D.dullyellow "(||)","instead?"]
1154 BadArrow -> D.reflow "Try getting rid of this entry? Maybe I can give you a better hint after that?"
1155 BadEquals -> D.fillSep ["Maybe","you","want",D.dullyellow "(==)","instead?"]
1156 BadHasType -> D.fillSep ["Maybe","you","want",D.dullyellow "(::)","instead?"]
1159 ExposingOperatorRightParen row col ->
1161 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1162 region = toRegion row col
1164 Report.Report "PROBLEM IN EXPOSING" region [] $
1165 Code.toSnippet source surroundings (Just region)
1168 "It looks like you are exposing an operator, but I got stuck here:"
1171 ["I","was","expecting","to","see","the","closing","parenthesis","immediately"
1172 ,"after","the","operator.","Try","adding","a",D.green ")","right","here?"
1176 ExposingEnd row col ->
1178 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1179 region = toRegion row col
1181 Report.Report "UNFINISHED EXPOSING" region [] $
1182 Code.toSnippet source surroundings (Just region)
1185 "I was partway through parsing exposed values, but I got stuck here:"
1188 "Maybe there is a comma missing before this?"
1191 ExposingTypePrivacy row col ->
1193 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1194 region = toRegion row col
1196 Report.Report "PROBLEM EXPOSING CUSTOM TYPE VARIANTS" region [] $
1197 Code.toSnippet source surroundings (Just region)
1200 "It looks like you are trying to expose the variants of a custom type:"
1204 ["You","need","to","write","something","like"
1205 ,D.dullyellow "Status(..)","or",D.dullyellow "Entity(..)"
1206 ,"though.","It","is","all","or","nothing,","otherwise","`case`"
1207 ,"expressions","could","miss","a","variant","and","crash!"
1210 "It is often best to keep the variants hidden! If someone pattern matches on\
1211 \ the variants, it is a MAJOR change if any new variants are added. Suddenly\
1212 \ their `case` expressions do not cover all variants! So if you do not need\
1213 \ people to pattern match, keep the variants hidden and expose functions to\
1214 \ construct values of this type. This way you can add new variants as a MINOR change!"
1218 ExposingIndentEnd row col ->
1220 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1221 region = toRegion row col
1223 Report.Report "UNFINISHED EXPOSING" region [] $
1224 Code.toSnippet source surroundings (Just region)
1227 "I was partway through parsing exposed values, but I got stuck here:"
1231 ["I","was","expecting","a","closing","parenthesis."
1232 ,"Try","adding","a",D.green ")","right","here?"
1235 "I can get confused when there is not enough indentation, so if you already\
1236 \ have a closing parenthesis, it probably just needs some spaces in front of it."
1240 ExposingIndentValue row col ->
1242 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1243 region = toRegion row col
1245 Report.Report "UNFINISHED EXPOSING" region [] $
1246 Code.toSnippet source surroundings (Just region)
1249 "I was partway through parsing exposed values, but I got stuck here:"
1252 "I was expecting another value to expose."
1260toSpaceReport :: Code.Source -> Space -> Row -> Col -> Report.Report
1261toSpaceReport source space row col =
1265 region = toRegion row col
1267 Report.Report "NO TABS" region [] $
1268 Code.toSnippet source region Nothing
1271 "I ran into a tab, but tabs are not allowed in Elm files."
1274 "Replace the tab with spaces."
1277 EndlessMultiComment ->
1279 region = toWiderRegion row col 2
1281 Report.Report "ENDLESS COMMENT" region [] $
1282 Code.toSnippet source region Nothing
1285 "I cannot find the end of this multi-line comment:"
1288 [ D.reflow "Add a -} somewhere after this to end the comment."
1290 "Multi-line comments can be nested in Elm, so {- {- -} -} is a comment\
1291 \ that happens to contain another comment. Like parentheses and curly braces,\
1292 \ the start and end markers must always be balanced. Maybe that is the problem?"
1301toRegion :: Row -> Col -> A.Region
1304 pos = A.Position row col
1309toWiderRegion :: Row -> Col -> Word16 -> A.Region
1310toWiderRegion row col extra =
1312 (A.Position row col)
1313 (A.Position row (col + extra))
1316toKeywordRegion :: Row -> Col -> [Char.Char] -> A.Region
1317toKeywordRegion row col keyword =
1319 (A.Position row col)
1320 (A.Position row (col + fromIntegral (length keyword)))
1323toDeclarationsReport :: Code.Source -> Decl -> Report.Report
1324toDeclarationsReport source decl =
1326 DeclStart row col ->
1327 case Code.whatIsNext source row col of
1328 Code.Close term bracket ->
1330 region = toRegion row col
1332 Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
1333 Code.toSnippet source region Nothing
1336 "I was not expecting to see a " ++ term ++ " here:"
1338 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
1341 Code.Keyword keyword ->
1343 region = toKeywordRegion row col keyword
1345 Report.Report "RESERVED WORD" region [] $
1346 Code.toSnippet source region Nothing
1349 "I was not expecting to run into the `" ++ keyword ++ "` keyword here:"
1354 "It is reserved for declaring imports at the top of your module. If you want\
1355 \ another import, try moving it up top with the other imports. If you want to\
1356 \ define a value or function, try changing the name to something else!"
1361 "It is reserved for writing `case` expressions. Try using a different name?"
1363 "If you are trying to write a `case` expression, it needs to be part of a\
1364 \ definition. So you could write something like this instead:"
1366 [ D.indent 0 $ D.fillSep [D.green "getWidth","maybeWidth","="]
1367 , D.indent 2 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
1368 , D.indent 4 $ D.fillSep [D.blue "Just","width","->"]
1369 , D.indent 6 $ D.fillSep ["width","+",D.dullyellow "200"]
1371 , D.indent 4 $ D.fillSep [D.blue "Nothing","->"]
1372 , D.indent 6 $ D.fillSep [D.dullyellow "400"]
1375 "This defines a `getWidth` function that we can use elsewhere in our program."
1381 "It is reserved for writing `if` expressions. Try using a different name?"
1383 "If you are trying to write an `if` expression, it needs to be part of a\
1384 \ definition. So you could write something like this instead:"
1386 [ D.indent 0 $ D.fillSep [D.green "reviewPowerLevel","powerLevel","="]
1387 , D.indent 2 $ D.fillSep $
1388 [D.cyan "if","powerLevel",">",D.dullyellow "9000"
1389 ,D.cyan "then",D.dullyellow "\"OVER 9000!!!\""
1390 ,D.cyan "else",D.dullyellow "\"not bad\""
1394 "This defines a `reviewPowerLevel` function that we can use elsewhere in our program."
1399 "It is a reserved word. Try changing the name to something else?"
1404 region = toRegion row col
1406 Report.Report "SYNTAX PROBLEM" region [] $
1407 Code.toSnippet source region Nothing
1410 "I was expecting to see a new declaration here:"
1414 "I am not sure what is going wrong exactly, but here are a couple valid\
1415 \ declarations for reference:"
1417 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1418 , D.fillSep [D.green "add","x","y","="]
1419 , D.fillSep [" ","x","+","y"]
1421 , D.fillSep [D.cyan "type",D.green "User","=","Anonymous","|","LoggedIn String"]
1423 "Note that all declarations start with lower-case letters in Elm. Capitalization\
1424 \ makes a difference, so be conscious of that if you are working from examples!"
1428 DeclSpace space row col ->
1429 toSpaceReport source space row col
1431 Port port_ row col ->
1432 toPortReport source port_ row col
1434 DeclType declType row col ->
1435 toDeclTypeReport source declType row col
1437 DeclDef name declDef row col ->
1438 toDeclDefReport source name declDef row col
1440 DeclFreshLineAfterDocComment row col ->
1442 region = toRegion row col
1444 Report.Report "EXPECTING DECLARATION" region [] $
1445 Code.toSnippet source region Nothing
1448 "I just saw a doc comment, but then I got stuck here:"
1451 "I was expecting to see the corresponding declaration next, starting on a fresh\
1452 \ line with no indentation."
1460toPortReport :: Code.Source -> Port -> Row -> Col -> Report.Report
1461toPortReport source port_ startRow startCol =
1463 PortSpace space row col ->
1464 toSpaceReport source space row col
1467 case Code.whatIsNext source row col of
1468 Code.Keyword keyword ->
1470 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1471 region = toKeywordRegion row col keyword
1473 Report.Report "RESERVED WORD" region [] $
1474 Code.toSnippet source surroundings (Just region)
1477 "I cannot handle ports with names like this:"
1480 "You are trying to make a port named `" ++ keyword
1481 ++ "` but that is a reserved word. Try using some other name?"
1486 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1487 region = toRegion row col
1489 Report.Report "PORT PROBLEM" region [] $
1490 Code.toSnippet source surroundings (Just region)
1493 "I just saw the start of a `port` declaration, but then I got stuck here:"
1497 ["I","was","expecting","to","see","a","name","like"
1498 ,D.dullyellow "send","or",D.dullyellow "receive","next."
1499 ,"Something","that","starts","with","a","lower-case","letter."
1505 PortColon row col ->
1507 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1508 region = toRegion row col
1510 Report.Report "PORT PROBLEM" region [] $
1511 Code.toSnippet source surroundings (Just region)
1514 "I just saw the start of a `port` declaration, but then I got stuck here:"
1518 "I was expecting to see a colon next. And then a type that tells me\
1519 \ what type of values are going to flow through."
1524 PortType tipe row col ->
1525 toTypeReport source TC_Port tipe row col
1527 PortIndentName row col ->
1529 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1530 region = toRegion row col
1532 Report.Report "UNFINISHED PORT" region [] $
1533 Code.toSnippet source surroundings (Just region)
1536 "I just saw the start of a `port` declaration, but then I got stuck here:"
1540 ["I","was","expecting","to","see","a","name","like"
1541 ,D.dullyellow "send","or",D.dullyellow "receive","next."
1542 ,"Something","that","starts","with","a","lower-case","letter."
1548 PortIndentColon row col ->
1550 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1551 region = toRegion row col
1553 Report.Report "UNFINISHED PORT" region [] $
1554 Code.toSnippet source surroundings (Just region)
1557 "I just saw the start of a `port` declaration, but then I got stuck here:"
1561 "I was expecting to see a colon next. And then a type that tells me\
1562 \ what type of values are going to flow through."
1567 PortIndentType row col ->
1569 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1570 region = toRegion row col
1572 Report.Report "UNFINISHED PORT" region [] $
1573 Code.toSnippet source surroundings (Just region)
1576 "I just saw the start of a `port` declaration, but then I got stuck here:"
1580 "I was expecting to see a type next. Here are examples of outgoing and\
1581 \ incoming ports for reference:"
1583 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
1584 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
1587 "The first line defines a `send` port so you can send strings out to JavaScript.\
1588 \ Maybe you send them on a WebSocket or put them into IndexedDB. The second line\
1589 \ defines a `receive` port so you can receive strings from JavaScript. Maybe you\
1590 \ get receive messages when new WebSocket messages come in or when an entry in\
1591 \ IndexedDB changes for some external reason."
1600 "Here are some example `port` declarations for reference:"
1602 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
1603 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
1606 "The first line defines a `send` port so you can send strings out to JavaScript.\
1607 \ Maybe you send them on a WebSocket or put them into IndexedDB. The second line\
1608 \ defines a `receive` port so you can receive strings from JavaScript. Maybe you\
1609 \ get receive messages when new WebSocket messages come in or when the IndexedDB\
1610 \ is changed for some external reason."
1618toDeclTypeReport :: Code.Source -> DeclType -> Row -> Col -> Report.Report
1619toDeclTypeReport source declType startRow startCol =
1621 DT_Space space row col ->
1622 toSpaceReport source space row col
1626 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1627 region = toRegion row col
1629 Report.Report "EXPECTING TYPE NAME" region [] $
1630 Code.toSnippet source surroundings (Just region)
1633 "I think I am parsing a type declaration, but I got stuck here:"
1637 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1638 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1644 DT_Alias typeAlias row col ->
1645 toTypeAliasReport source typeAlias row col
1647 DT_Union customType row col ->
1648 toCustomTypeReport source customType row col
1650 DT_IndentName row col ->
1652 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1653 region = toRegion row col
1655 Report.Report "EXPECTING TYPE NAME" region [] $
1656 Code.toSnippet source surroundings (Just region)
1659 "I think I am parsing a type declaration, but I got stuck here:"
1663 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1664 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1671toTypeAliasReport :: Code.Source -> TypeAlias -> Row -> Col -> Report.Report
1672toTypeAliasReport source typeAlias startRow startCol =
1674 AliasSpace space row col ->
1675 toSpaceReport source space row col
1677 AliasName row col ->
1679 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1680 region = toRegion row col
1682 Report.Report "EXPECTING TYPE ALIAS NAME" region [] $
1683 Code.toSnippet source surroundings (Just region)
1686 "I am partway through parsing a type alias, but I got stuck here:"
1690 ["I","was","expecting","a","name","like",D.dullyellow "Person","or",D.dullyellow "Point"
1691 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1697 AliasEquals row col ->
1698 case Code.whatIsNext source row col of
1699 Code.Keyword keyword ->
1701 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1702 region = toKeywordRegion row col keyword
1704 Report.Report "RESERVED WORD" region [] $
1705 Code.toSnippet source surroundings (Just region)
1708 "I ran into a reserved word unexpectedly while parsing this type alias:"
1712 "It looks like you are trying use `" ++ keyword
1713 ++ "` as a type variable, but it is a reserved word. Try using a different name?"
1720 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1721 region = toRegion row col
1723 Report.Report "PROBLEM IN TYPE ALIAS" region [] $
1724 Code.toSnippet source surroundings (Just region)
1727 "I am partway through parsing a type alias, but I got stuck here:"
1731 "I was expecting to see a type variable or an equals sign next."
1736 AliasBody tipe row col ->
1737 toTypeReport source TC_TypeAlias tipe row col
1739 AliasIndentEquals row col ->
1741 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1742 region = toRegion row col
1744 Report.Report "UNFINISHED TYPE ALIAS" region [] $
1745 Code.toSnippet source surroundings (Just region)
1748 "I am partway through parsing a type alias, but I got stuck here:"
1752 "I was expecting to see a type variable or an equals sign next."
1757 AliasIndentBody row col ->
1759 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1760 region = toRegion row col
1762 Report.Report "UNFINISHED TYPE ALIAS" region [] $
1763 Code.toSnippet source surroundings (Just region)
1766 "I am partway through parsing a type alias, but I got stuck here:"
1770 ["I","was","expecting","to","see","a","type","next.","Something","as","simple"
1771 ,"as",D.dullyellow "Int","or",D.dullyellow "Float","would","work!"
1778typeAliasNote :: D.Doc
1782 "Here is an example of a valid `type alias` for reference:"
1784 [ D.indent 0 $ D.fillSep [D.cyan "type",D.cyan "alias",D.green "Person","="]
1785 , D.indent 2 $ D.vcat $
1793 "This would let us use `Person` as a shorthand for that record type. Using this\
1794 \ shorthand makes type annotations much easier to read, and makes changing code\
1795 \ easier if you decide later that there is more to a person than age and height!"
1799toCustomTypeReport :: Code.Source -> CustomType -> Row -> Col -> Report.Report
1800toCustomTypeReport source customType startRow startCol =
1802 CT_Space space row col ->
1803 toSpaceReport source space row col
1807 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1808 region = toRegion row col
1810 Report.Report "EXPECTING TYPE NAME" region [] $
1811 Code.toSnippet source surroundings (Just region)
1814 "I think I am parsing a type declaration, but I got stuck here:"
1818 ["I","was","expecting","a","name","like",D.dullyellow "Status","or",D.dullyellow "Style"
1819 ,"next.","Just","make","sure","it","is","a","name","that","starts","with","a","capital","letter!"
1825 CT_Equals row col ->
1826 case Code.whatIsNext source row col of
1827 Code.Keyword keyword ->
1829 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1830 region = toKeywordRegion row col keyword
1832 Report.Report "RESERVED WORD" region [] $
1833 Code.toSnippet source surroundings (Just region)
1836 "I ran into a reserved word unexpectedly while parsing this custom type:"
1840 "It looks like you are trying use `" ++ keyword
1841 ++ "` as a type variable, but it is a reserved word. Try using a different name?"
1848 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1849 region = toRegion row col
1851 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1852 Code.toSnippet source surroundings (Just region)
1855 "I am partway through parsing a custom type, but I got stuck here:"
1859 "I was expecting to see a type variable or an equals sign next."
1866 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1867 region = toRegion row col
1869 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1870 Code.toSnippet source surroundings (Just region)
1873 "I am partway through parsing a custom type, but I got stuck here:"
1877 "I was expecting to see a vertical bar like | next."
1882 CT_Variant row col ->
1884 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1885 region = toRegion row col
1887 Report.Report "PROBLEM IN CUSTOM TYPE" region [] $
1888 Code.toSnippet source surroundings (Just region)
1891 "I am partway through parsing a custom type, but I got stuck here:"
1895 ["I","was","expecting","to","see","a","variant","name","next."
1896 ,"Something","like",D.dullyellow "Success","or",D.dullyellow "Sandwich" <> "."
1897 ,"Any","name","that","starts","with","a","capital","letter","really!"
1903 CT_VariantArg tipe row col ->
1904 toTypeReport source TC_CustomType tipe row col
1906 CT_IndentEquals row col ->
1908 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1909 region = toRegion row col
1911 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1912 Code.toSnippet source surroundings (Just region)
1915 "I am partway through parsing a custom type, but I got stuck here:"
1919 "I was expecting to see a type variable or an equals sign next."
1924 CT_IndentBar row col ->
1926 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1927 region = toRegion row col
1929 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1930 Code.toSnippet source surroundings (Just region)
1933 "I am partway through parsing a custom type, but I got stuck here:"
1937 "I was expecting to see a vertical bar like | next."
1942 CT_IndentAfterBar row col ->
1944 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1945 region = toRegion row col
1947 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1948 Code.toSnippet source surroundings (Just region)
1951 "I am partway through parsing a custom type, but I got stuck here:"
1955 "I just saw a vertical bar, so I was expecting to see another variant defined next."
1960 CT_IndentAfterEquals row col ->
1962 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
1963 region = toRegion row col
1965 Report.Report "UNFINISHED CUSTOM TYPE" region [] $
1966 Code.toSnippet source surroundings (Just region)
1969 "I am partway through parsing a custom type, but I got stuck here:"
1973 "I just saw an equals sign, so I was expecting to see the first variant defined next."
1979customTypeNote :: D.Doc
1983 "Here is an example of a valid `type` declaration for reference:"
1985 [ D.indent 0 $ D.fillSep [D.cyan "type",D.green "Status"]
1986 , D.indent 2 $ D.fillSep ["=","Failure"]
1987 , D.indent 2 $ D.fillSep ["|","Waiting"]
1988 , D.indent 2 $ D.fillSep ["|","Success","String"]
1991 "This defines a new `Status` type with three variants. This could be useful if\
1992 \ we are waiting for an HTTP request. Maybe we start with `Waiting` and then\
1993 \ switch to `Failure` or `Success \"message from server\"` depending on how\
1994 \ things go. Notice that the Success variant has some associated data, allowing\
1995 \ us to store a String if the request goes well!"
2003toDeclDefReport :: Code.Source -> Name.Name -> DeclDef -> Row -> Col -> Report.Report
2004toDeclDefReport source name declDef startRow startCol =
2006 DeclDefSpace space row col ->
2007 toSpaceReport source space row col
2009 DeclDefEquals row col ->
2010 case Code.whatIsNext source row col of
2011 Code.Keyword keyword ->
2013 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2014 region = toKeywordRegion row col keyword
2016 Report.Report "RESERVED WORD" region [] $
2017 Code.toSnippet source surroundings (Just region)
2020 "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
2023 "This is a reserved word! Try using some other name?"
2026 Code.Operator "->" ->
2028 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2029 region = toWiderRegion row col 2
2031 Report.Report "MISSING COLON?" region [] $
2032 Code.toSnippet source surroundings (Just region)
2035 "I was not expecting to see an arrow here:"
2039 ["This","usually","means","a",D.green ":","is","missing","a","bit","earlier","in"
2040 ,"a","type","annotation.","It","could","be","something","else","though,","so"
2041 ,"here","is","a","valid","definition","for","reference:"
2044 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2045 , D.fillSep [D.green "add","x","y","="]
2046 , D.fillSep [" ","x","+","y"]
2049 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
2055 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2056 region = toKeywordRegion row col op
2058 Report.Report "UNEXPECTED SYMBOL" region [] $
2059 Code.toSnippet source surroundings (Just region)
2062 "I was not expecting to see this symbol here:"
2066 "I am not sure what is going wrong exactly, so here is a valid\
2067 \ definition (with an optional type annotation) for reference:"
2069 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2070 , D.fillSep [D.green "add","x","y","="]
2071 , D.fillSep [" ","x","+","y"]
2074 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
2080 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2081 region = toRegion row col
2083 Report.Report "PROBLEM IN DEFINITION" region [] $
2084 Code.toSnippet source surroundings (Just region)
2087 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
2091 "I am not sure what is going wrong exactly, so here is a valid\
2092 \ definition (with an optional type annotation) for reference:"
2094 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2095 , D.fillSep [D.green "add","x","y","="]
2096 , D.fillSep [" ","x","+","y"]
2099 "Try to use that format!"
2103 DeclDefType tipe row col ->
2104 toTypeReport source (TC_Annotation name) tipe row col
2106 DeclDefArg pattern row col ->
2107 toPatternReport source PArg pattern row col
2109 DeclDefBody expr row col ->
2110 toExprReport source (InDef name startRow startCol) expr row col
2112 DeclDefNameRepeat row col ->
2114 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2115 region = toRegion row col
2117 Report.Report "EXPECTING DEFINITION" region [] $
2118 Code.toSnippet source surroundings (Just region)
2121 "I just saw the type annotation for `" ++ Name.toChars name
2122 ++ "` so I was expecting to see its definition here:"
2126 "Type annotations always appear directly above the relevant\
2127 \ definition, without anything else in between. (Not even doc comments!)"
2132 DeclDefNameMatch defName row col ->
2134 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2135 region = toRegion row col
2137 Report.Report "NAME MISMATCH" region [] $
2138 Code.toSnippet source surroundings (Just region)
2141 "I just saw a type annotation for `" ++ Name.toChars name ++ "`, but it is followed by a definition for `" ++ Name.toChars defName ++ "`:"
2145 "These names do not match! Is there a typo?"
2146 , D.indent 4 $ D.fillSep $
2147 [D.dullyellow (D.fromName defName),"->",D.green (D.fromName name)]
2151 DeclDefIndentType row col ->
2153 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2154 region = toRegion row col
2156 Report.Report "UNFINISHED DEFINITION" region [] $
2157 Code.toSnippet source surroundings (Just region)
2160 "I got stuck while parsing the `" ++ Name.toChars name ++ "` type annotation:"
2164 "I just saw a colon, so I am expecting to see a type next."
2169 DeclDefIndentEquals row col ->
2171 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2172 region = toRegion row col
2174 Report.Report "UNFINISHED DEFINITION" region [] $
2175 Code.toSnippet source surroundings (Just region)
2178 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
2182 "I was expecting to see an argument or an equals sign next."
2187 DeclDefIndentBody row col ->
2189 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2190 region = toRegion row col
2192 Report.Report "UNFINISHED DEFINITION" region [] $
2193 Code.toSnippet source surroundings (Just region)
2196 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
2200 "I was expecting to see an expression next. What is it equal to?"
2210 "Here is a valid definition (with a type annotation) for reference:"
2212 [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2213 , D.fillSep [D.green "add","x","y","="]
2214 , D.fillSep [" ","x","+","y"]
2217 "The top line (called a \"type annotation\") is optional. You can leave it off\
2218 \ if you want. As you get more comfortable with Elm and as your project grows,\
2219 \ it becomes more and more valuable to add them though! They work great as\
2220 \ compiler-verified documentation, and they often improve error messages!"
2229 = InNode Node Row Col Context
2230 | InDef Name.Name Row Col
2231 | InDestruct Row Col
2247getDefName :: Context -> Maybe Name.Name
2250 InDestruct _ _ -> Nothing
2251 InDef name _ _ -> Just name
2252 InNode _ _ _ c -> getDefName c
2255isWithin :: Node -> Context -> Bool
2256isWithin desiredNode context =
2258 InDestruct _ _ -> False
2259 InDef _ _ _ -> False
2260 InNode actualNode _ _ _ -> desiredNode == actualNode
2267toExprReport :: Code.Source -> Context -> Expr -> Row -> Col -> Report.Report
2268toExprReport source context expr startRow startCol =
2271 toLetReport source context let_ row col
2273 Case case_ row col ->
2274 toCaseReport source context case_ row col
2277 toIfReport source context if_ row col
2279 List list row col ->
2280 toListReport source context list row col
2282 Record record row col ->
2283 toRecordReport source context record row col
2285 Tuple tuple row col ->
2286 toTupleReport source context tuple row col
2288 Func func row col ->
2289 toFuncReport source context func row col
2292 let region = toRegion row col in
2293 Report.Report "EXPECTING RECORD ACCESSOR" region [] $
2294 Code.toSnippet source region Nothing
2297 "I was expecting to see a record accessor here:"
2300 ["Something","like",D.dullyellow".name","or",D.dullyellow".price"
2301 ,"that","accesses","a","value","from","a","record."
2306 let region = toRegion row col in
2307 Report.Report "EXPECTING RECORD ACCESSOR" region [] $
2308 Code.toSnippet source region Nothing
2311 "I am trying to parse a record accessor here:"
2316 ["Something","like",D.dullyellow".name","or",D.dullyellow".price"
2317 ,"that","accesses","a","value","from","a","record."
2321 "Record field names must start with a lower case letter!"
2325 OperatorRight op row col ->
2326 let region = toRegion row col in
2327 Report.Report "MISSING EXPRESSION" region [] $
2328 Code.toSnippet source region Nothing
2331 "I was expecting to see an expression after this " ++ Name.toChars op ++ " operator:"
2335 ["You","can","just","put","anything","for","now,","like"
2336 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2337 ,"Once","there","is","something","there,","I","can","probably"
2338 ,"give","a","more","specific","hint!"
2341 "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2342 \ Or if I run into operators in unexpected spots. Point is, there are a\
2343 \ couple ways I can get confused and give sort of weird advice!"
2347 OperatorReserved operator row col ->
2348 toOperatorReport source context operator row col
2352 (contextRow, contextCol, aThing) =
2354 InDestruct r c -> (r, c, "a definition")
2355 InDef name r c -> (r, c, "the `" ++ Name.toChars name ++ "` definition")
2356 InNode NRecord r c _ -> (r, c, "a record")
2357 InNode NParens r c _ -> (r, c, "some parentheses")
2358 InNode NList r c _ -> (r, c, "a list")
2359 InNode NFunc r c _ -> (r, c, "an anonymous function")
2360 InNode NCond r c _ -> (r, c, "an `if` expression")
2361 InNode NThen r c _ -> (r, c, "an `if` expression")
2362 InNode NElse r c _ -> (r, c, "an `if` expression")
2363 InNode NCase r c _ -> (r, c, "a `case` expression")
2364 InNode NBranch r c _ -> (r, c, "a `case` expression")
2366 surroundings = A.Region (A.Position contextRow contextCol) (A.Position row col)
2367 region = toRegion row col
2369 Report.Report "MISSING EXPRESSION" region [] $
2370 Code.toSnippet source surroundings (Just region)
2373 "I am partway through parsing " ++ aThing ++ ", but I got stuck here:"
2377 ["I","was","expecting","to","see","an","expression","like"
2378 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2379 ,"Once","there","is","something","there,","I","can","probably"
2380 ,"give","a","more","specific","hint!"
2383 "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2384 \ Or if I run into operators in unexpected spots. Point is, there are a\
2385 \ couple ways I can get confused and give sort of weird advice!"
2389 Char char row col ->
2390 toCharReport source char row col
2392 String string row col ->
2393 toStringReport source string row col
2395 Number number row col ->
2396 toNumberReport source number row col
2398 Space space row col ->
2399 toSpaceReport source space row col
2401 EndlessShader row col ->
2403 region = toWiderRegion row col 6
2405 Report.Report "ENDLESS SHADER" region [] $
2406 Code.toSnippet source region Nothing
2408 D.reflow "I cannot find the end of this shader:"
2410 D.reflow "Add a |] somewhere after this to end the shader."
2413 ShaderProblem problem row col ->
2415 region = toRegion row col
2417 Report.Report "SHADER PROBLEM" region [] $
2418 Code.toSnippet source region Nothing
2421 "I ran into a problem while parsing this GLSL block."
2425 "I use a 3rd party GLSL parser for now, and I did my best to extract their error message:"
2426 , D.indent 4 $ D.vcat $
2427 map D.fromChars (filter (/="") (lines problem))
2431 IndentOperatorRight op row col ->
2433 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2434 region = toRegion row col
2436 Report.Report "MISSING EXPRESSION" region [] $
2437 Code.toSnippet source surroundings (Just region)
2440 "I was expecting to see an expression after this " ++ Name.toChars op ++ " operator:"
2445 ["You","can","just","put","anything","for","now,","like"
2446 ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2447 ,"Once","there","is","something","there,","I","can","probably"
2448 ,"give","a","more","specific","hint!"
2452 "I may be getting confused by your indentation? The easiest way to make sure\
2453 \ this is not an indentation problem is to put the expression on the right of\
2454 \ the " ++ Name.toChars op ++ " operator on the same line."
2463toCharReport :: Code.Source -> Char -> Row -> Col -> Report.Report
2464toCharReport source char row col =
2468 region = toRegion row col
2470 Report.Report "MISSING SINGLE QUOTE" region [] $
2471 Code.toSnippet source region Nothing
2474 "I thought I was parsing a character, but I got to the end of\
2475 \ the line without seeing the closing single quote:"
2478 "Add a closing single quote here!"
2481 CharEscape escape ->
2482 toEscapeReport source escape row col
2484 CharNotString width ->
2486 region = toWiderRegion row col width
2488 Report.Report "NEEDS DOUBLE QUOTES" region [] $
2489 Code.toSnippet source region Nothing
2491 "The following string uses single quotes:"
2494 [ "Please switch to double quotes instead:"
2496 D.dullyellow "'this'" <> " => " <> D.green "\"this\""
2498 "Elm uses double quotes for strings like \"hello\", whereas it uses single\
2499 \ quotes for individual characters like 'a' and 'ø'. This distinction helps with\
2500 \ code like (String.any (\\c -> c == 'X') \"90210\") where you are inspecting\
2501 \ individual characters."
2510toStringReport :: Code.Source -> String -> Row -> Col -> Report.Report
2511toStringReport source string row col =
2513 StringEndless_Single ->
2515 region = toRegion row col
2517 Report.Report "ENDLESS STRING" region [] $
2518 Code.toSnippet source region Nothing
2521 "I got to the end of the line without seeing the closing double quote:"
2525 ["Strings","look","like",D.green "\"this\"","with","double"
2526 ,"quotes","on","each","end.","Is","the","closing","double"
2527 ,"quote","missing","in","your","code?"
2530 "For a string that spans multiple lines, you can use the multi-line string\
2531 \ syntax like this:"
2533 [ D.fillSep [D.green "markdown","=",D.dullyellow "\"\"\""]
2535 , D.dullyellow "# Multi-line Strings"
2537 , D.dullyellow "- start with triple double quotes"
2538 , D.dullyellow "- write whatever you want"
2539 , D.dullyellow "- no need to escape newlines or double quotes"
2540 , D.dullyellow "- end with triple double quotes"
2542 , D.dullyellow "\"\"\""
2547 StringEndless_Multi ->
2549 region = toWiderRegion row col 3
2551 Report.Report "ENDLESS STRING" region [] $
2552 Code.toSnippet source region Nothing
2555 "I cannot find the end of this multi-line string:"
2558 [ D.reflow "Add a \"\"\" somewhere after this to end the string."
2560 "Here is a valid multi-line string for reference:"
2562 [ D.fillSep [D.green "markdown","=",D.dullyellow "\"\"\""]
2564 , D.dullyellow "# Multi-line Strings"
2566 , D.dullyellow "- start with triple double quotes"
2567 , D.dullyellow "- write whatever you want"
2568 , D.dullyellow "- no need to escape newlines or double quotes"
2569 , D.dullyellow "- end with triple double quotes"
2571 , D.dullyellow "\"\"\""
2576 StringEscape escape ->
2577 toEscapeReport source escape row col
2584toEscapeReport :: Code.Source -> Escape -> Row -> Col -> Report.Report
2585toEscapeReport source escape row col =
2589 region = toWiderRegion row col 2
2591 Report.Report "UNKNOWN ESCAPE" region [] $
2592 Code.toSnippet source region Nothing
2595 "Backslashes always start escaped characters, but I do not recognize this one:"
2599 "Valid escape characters include:"
2600 , D.dullyellow $ D.indent 4 $ D.vcat $
2610 "Do you want one of those instead? Maybe you need \\\\ to escape a backslash?"
2612 "The last style lets encode ANY character by its Unicode code\
2613 \ point. That means \\u{0009} and \\t are the same. You can use\
2614 \ that style for anything not covered by the other six escapes!"
2618 BadUnicodeFormat width ->
2620 region = toWiderRegion row col width
2622 Report.Report "BAD UNICODE ESCAPE" region [] $
2623 Code.toSnippet source region Nothing
2626 "I ran into an invalid Unicode escape:"
2630 "Here are some examples of valid Unicode escapes:"
2631 , D.dullyellow $ D.indent 4 $ D.vcat $
2638 "Notice that the code point is always surrounded by curly braces.\
2639 \ Maybe you are missing the opening or closing curly brace?"
2642 BadUnicodeCode width ->
2644 region = toWiderRegion row col width
2646 Report.Report "BAD UNICODE ESCAPE" region [] $
2647 Code.toSnippet source region Nothing
2650 "This is not a valid code point:"
2653 "The valid code points are between 0 and 10FFFF inclusive."
2656 BadUnicodeLength width numDigits badCode ->
2658 region = toWiderRegion row col width
2660 Report.Report "BAD UNICODE ESCAPE" region [] $
2661 Code.toSnippet source region Nothing $
2662 if numDigits < 4 then
2665 "Every code point needs at least four digits:"
2668 goodCode = replicate (4 - numDigits) '0' ++ map Char.toUpper (showHex badCode "")
2669 suggestion = "\\u{" <> D.fromChars goodCode <> "}"
2671 D.fillSep ["Try",D.green suggestion,"instead?"]
2677 "This code point has too many digits:"
2680 ["Valid","code","points","are","between"
2681 ,D.green "\\u{0000}","and",D.green "\\u{10FFFF}" <> ","
2682 ,"so","try","trimming","any","leading","zeros","until"
2683 ,"you","have","between","four","and","six","digits."
2692toNumberReport :: Code.Source -> Number -> Row -> Col -> Report.Report
2693toNumberReport source number row col =
2695 region = toRegion row col
2699 Report.Report "WEIRD NUMBER" region [] $
2700 Code.toSnippet source region Nothing
2703 "I thought I was reading a number, but I ran into some weird stuff here:"
2707 "I recognize numbers in the following formats:"
2708 , D.indent 4 $ D.vcat [ "42", "3.14", "6.022e23", "0x002B" ]
2710 "So is there a way to write it like one of those?"
2715 Report.Report "WEIRD NUMBER" region [] $
2716 Code.toSnippet source region Nothing
2719 "Numbers cannot end with a dot like this:"
2722 ["Switching","to",D.green (D.fromChars (show int))
2723 ,"or",D.green (D.fromChars (show int ++ ".0"))
2724 ,"will","work","though!"
2729 Report.Report "WEIRD HEXIDECIMAL" region [] $
2730 Code.toSnippet source region Nothing
2733 "I thought I was reading a hexidecimal number until I got here:"
2737 "Valid hexidecimal digits include 0123456789abcdefABCDEF, so I can\
2738 \ only recognize things like this:"
2739 , D.indent 4 $ D.vcat [ "0x2B", "0x002B", "0x00ffb3" ]
2743 NumberNoLeadingZero ->
2744 Report.Report "LEADING ZEROS" region [] $
2745 Code.toSnippet source region Nothing
2748 "I do not accept numbers with leading zeros:"
2752 "Just delete the leading zeros and it should work!"
2754 "Some languages let you to specify octal numbers by adding a leading zero.\
2755 \ So in C, writing 0111 is the same as writing 73. Some people are used to\
2756 \ that, but others probably want it to equal 111. Either path is going to\
2757 \ surprise people from certain backgrounds, so Elm tries to avoid this whole\
2767toOperatorReport :: Code.Source -> Context -> BadOperator -> Row -> Col -> Report.Report
2768toOperatorReport source context operator row col =
2772 region = toRegion row col
2774 Report.Report "UNEXPECTED SYMBOL" region [] $
2775 Code.toSnippet source region Nothing
2777 "I was not expecting this dot:"
2780 "Dots are for record access and decimal points, so\
2781 \ they cannot float around on their own. Maybe\
2782 \ there is some extra whitespace?"
2787 region = toRegion row col
2789 Report.Report "UNEXPECTED SYMBOL" region [] $
2790 Code.toSnippet source region Nothing
2793 "I was not expecting this vertical bar:"
2796 "Vertical bars should only appear in custom type declarations. Maybe you want || instead?"
2801 region = toWiderRegion row col 2
2803 Report.Report "UNEXPECTED ARROW" region [] $
2804 Code.toSnippet source region Nothing $
2805 if isWithin NCase context then
2808 "I am parsing a `case` expression right now, but this arrow is confusing me:"
2811 [ D.reflow "Maybe the `of` keyword is missing on a previous line?"
2816 else if isWithin NBranch context then
2819 "I am parsing a `case` expression right now, but this arrow is confusing me:"
2823 "It makes sense to see arrows around here, so I suspect it is something earlier."
2824 , noteForCaseIndentError
2831 "I was not expecting an arrow here:"
2834 "Arrows should only appear in `case` expressions and anonymous functions. Maybe\
2835 \ you want > or >= instead?"
2840 region = toRegion row col
2842 Report.Report "UNEXPECTED EQUALS" region [] $
2843 Code.toSnippet source region Nothing
2846 "I was not expecting to see this equals sign:"
2850 D.reflow "Maybe you want == instead? To check if two values are equal?"
2853 if isWithin NRecord context then
2854 "Records look like { x = 3, y = 4 } with the equals sign right\
2855 \ after the field name. So maybe you forgot a comma?"
2857 case getDefName context of
2859 "I may be getting confused by your indentation. I need all definitions to be indented\
2860 \ exactly the same amount, so if this is meant to be a new definition, it may have too\
2861 \ many spaces in front of it."
2864 "I may be getting confused by your indentation. I think I am still parsing the `"
2865 ++ Name.toChars name ++ "` definition. Is this supposed to be part of a definition\
2866 \ after that? If so, the problem may be a bit before the equals sign. I need all\
2867 \ definitions to be indented exactly the same amount, so the problem may be that\
2868 \ this new definition has too many spaces in front of it."
2874 region = toRegion row col
2876 Report.Report "UNEXPECTED SYMBOL" region [] $
2877 Code.toSnippet source region Nothing $
2880 "I was not expecting to run into the \"has type\" symbol here:"
2882 case getDefName context of
2885 ["Maybe","you","want",D.green "::","instead?"
2886 ,"To","put","something","on","the","front","of","a","list?"
2893 ["Maybe","you","want",D.green "::","instead?"
2894 ,"To","put","something","on","the","front","of","a","list?"
2897 "The single colon is reserved for type annotations and record types, but I think\
2898 \ I am parsing the definition of `" ++ Name.toChars name ++ "` right now."
2901 "I may be getting confused by your indentation. Is this supposed to be part of\
2902 \ a type annotation AFTER the `" ++ Name.toChars name ++ "` definition? If so,\
2903 \ the problem may be a bit before the \"has type\" symbol. I need all definitions to\
2904 \ be exactly aligned (with exactly the same indentation) so the problem may be that\
2905 \ this new definition is indented a bit too much."
2914toLetReport :: Code.Source -> Context -> Let -> Row -> Col -> Report.Report
2915toLetReport source context let_ startRow startCol =
2917 LetSpace space row col ->
2918 toSpaceReport source space row col
2922 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2923 region = toRegion row col
2925 Report.Report "LET PROBLEM" region [] $
2926 Code.toSnippet source surroundings (Just region)
2929 "I was partway through parsing a `let` expression, but I got stuck here:"
2933 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2934 ,"keyword","next.","Is","there","a","typo?"
2937 "This can also happen if you are trying to define another value within the `let` but\
2938 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2939 \ spaces before it. They should line up exactly!"
2943 LetDefAlignment _ row col ->
2945 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2946 region = toRegion row col
2948 Report.Report "LET PROBLEM" region [] $
2949 Code.toSnippet source surroundings (Just region)
2952 "I was partway through parsing a `let` expression, but I got stuck here:"
2956 ["Based","on","the","indentation,","I","was","expecting","to","see","the",D.cyan "in"
2957 ,"keyword","next.","Is","there","a","typo?"
2960 "This can also happen if you are trying to define another value within the `let` but\
2961 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2962 \ spaces before it. They should line up exactly!"
2966 LetDefName row col ->
2967 case Code.whatIsNext source row col of
2968 Code.Keyword keyword ->
2970 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2971 region = toKeywordRegion row col keyword
2973 Report.Report "RESERVED WORD" region [] $
2974 Code.toSnippet source surroundings (Just region)
2977 "I was partway through parsing a `let` expression, but I got stuck here:"
2980 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but\
2981 \ it is a reserved word! Try using a different name instead."
2985 toUnfinishLetReport source row col startRow startCol $
2987 "I was expecting the name of a definition next."
2989 LetDef name def row col ->
2990 toLetDefReport source name def row col
2992 LetDestruct destruct row col ->
2993 toLetDestructReport source destruct row col
2995 LetBody expr row col ->
2996 toExprReport source context expr row col
2998 LetIndentDef row col ->
2999 toUnfinishLetReport source row col startRow startCol $
3001 "I was expecting a value to be defined here."
3003 LetIndentIn row col ->
3004 toUnfinishLetReport source row col startRow startCol $
3006 ["I","was","expecting","to","see","the",D.cyan "in","keyword","next."
3007 ,"Or","maybe","more","of","that","expression?"
3010 LetIndentBody row col ->
3011 toUnfinishLetReport source row col startRow startCol $
3013 "I was expecting an expression next. Tell me what should happen with the value you just defined!"
3016toUnfinishLetReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
3017toUnfinishLetReport source row col startRow startCol message =
3019 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3020 region = toRegion row col
3022 Report.Report "UNFINISHED LET" region [] $
3023 Code.toSnippet source surroundings (Just region)
3026 "I was partway through parsing a `let` expression, but I got stuck here:"
3031 "Here is an example with a valid `let` expression for reference:"
3033 [ D.indent 0 $ D.fillSep [D.green "viewPerson","person","="]
3034 , D.indent 2 $ D.fillSep [D.cyan "let"]
3035 , D.indent 4 $ D.fillSep ["fullName","="]
3036 , D.indent 6 $ D.fillSep ["person.firstName","++",D.dullyellow "\" \"","++","person.lastName"]
3037 , D.indent 2 $ D.fillSep [D.cyan "in"]
3038 , D.indent 2 $ D.fillSep ["div","[]","[","text","fullName","]"]
3041 "Here we defined a `viewPerson` function that turns a person into some HTML. We use\
3042 \ a `let` expression to define the `fullName` we want to show. Notice the indentation! The\
3043 \ `fullName` is indented more than the `let` keyword, and the actual value of `fullName` is\
3044 \ indented a bit more than that. That is important!"
3049toLetDefReport :: Code.Source -> Name.Name -> Def -> Row -> Col -> Report.Report
3050toLetDefReport source name def startRow startCol =
3052 DefSpace space row col ->
3053 toSpaceReport source space row col
3055 DefType tipe row col ->
3056 toTypeReport source (TC_Annotation name) tipe row col
3058 DefNameRepeat row col ->
3060 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3061 region = toRegion row col
3063 Report.Report "EXPECTING DEFINITION" region [] $
3064 Code.toSnippet source surroundings (Just region)
3067 "I just saw the type annotation for `" ++ Name.toChars name
3068 ++ "` so I was expecting to see its definition here:"
3072 "Type annotations always appear directly above the relevant\
3073 \ definition, without anything else in between."
3078 DefNameMatch defName row col ->
3080 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3081 region = toRegion row col
3083 Report.Report "NAME MISMATCH" region [] $
3084 Code.toSnippet source surroundings (Just region)
3087 "I just saw a type annotation for `" ++ Name.toChars name ++ "`, but it is followed by a definition for `" ++ Name.toChars defName ++ "`:"
3091 "These names do not match! Is there a typo?"
3092 , D.indent 4 $ D.fillSep $
3093 [D.dullyellow (D.fromName defName),"->",D.green (D.fromName name)]
3097 DefArg pattern row col ->
3098 toPatternReport source PArg pattern row col
3100 DefEquals row col ->
3101 case Code.whatIsNext source row col of
3102 Code.Keyword keyword ->
3104 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3105 region = toKeywordRegion row col keyword
3107 Report.Report "RESERVED WORD" region [] $
3108 Code.toSnippet source surroundings (Just region)
3111 "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
3114 "This is a reserved word! Try using some other name?"
3117 Code.Operator "->" ->
3119 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3120 region = toWiderRegion row col 2
3122 Report.Report "MISSING COLON?" region [] $
3123 Code.toSnippet source surroundings (Just region)
3126 "I was not expecting to see an arrow here:"
3130 ["This","usually","means","a",D.green ":","is","missing","a","bit","earlier","in"
3131 ,"a","type","annotation.","It","could","be","something","else","though,","so"
3132 ,"here","is","a","valid","definition","for","reference:"
3135 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3136 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3137 , D.indent 6 $ D.fillSep ["x","+","y"]
3140 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
3146 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3147 region = toKeywordRegion row col op
3149 Report.Report "UNEXPECTED SYMBOL" region [] $
3150 Code.toSnippet source surroundings (Just region)
3153 "I was not expecting to see this symbol here:"
3157 "I am not sure what is going wrong exactly, so here is a valid\
3158 \ definition (with an optional type annotation) for reference:"
3160 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3161 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3162 , D.indent 6 $ D.fillSep ["x","+","y"]
3165 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
3171 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3172 region = toRegion row col
3174 Report.Report "PROBLEM IN DEFINITION" region [] $
3175 Code.toSnippet source surroundings (Just region)
3178 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3182 "I am not sure what is going wrong exactly, so here is a valid\
3183 \ definition (with an optional type annotation) for reference:"
3185 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3186 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3187 , D.indent 4 $ D.fillSep ["x","+","y"]
3190 "Try to use that format!"
3194 DefBody expr row col ->
3195 toExprReport source (InDef name startRow startCol) expr row col
3197 DefIndentEquals row col ->
3199 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3200 region = toRegion row col
3202 Report.Report "UNFINISHED DEFINITION" region [] $
3203 Code.toSnippet source surroundings (Just region)
3206 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3210 "I was expecting to see an argument or an equals sign next."
3215 DefIndentType row col ->
3217 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3218 region = toRegion row col
3220 Report.Report "UNFINISHED DEFINITION" region [] $
3221 Code.toSnippet source surroundings (Just region)
3224 "I got stuck while parsing the `" ++ Name.toChars name ++ "` type annotation:"
3228 "I just saw a colon, so I am expecting to see a type next."
3233 DefIndentBody row col ->
3235 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3236 region = toRegion row col
3238 Report.Report "UNFINISHED DEFINITION" region [] $
3239 Code.toSnippet source surroundings (Just region)
3242 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3246 "I was expecting to see an expression next. What is it equal to?"
3251 DefAlignment indent row col ->
3253 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3254 region = toRegion row col
3255 offset = indent - col
3257 Report.Report "PROBLEM IN DEFINITION" region [] $
3258 Code.toSnippet source surroundings (Just region)
3261 "I got stuck while parsing the `" ++ Name.toChars name ++ "` definition:"
3264 "I just saw a type annotation indented " ++ show indent ++ " spaces, so I was\
3265 \ expecting to see the corresponding definition next with the exact same amount\
3266 \ of indentation. It looks like this line needs "
3267 ++ show offset ++ " more " ++ (if offset == 1 then "space" else "spaces") ++ "?"
3276 "Here is a valid definition (with a type annotation) for reference:"
3278 [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3279 , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3280 , D.indent 6 $ D.fillSep ["x","+","y"]
3283 "The top line (called a \"type annotation\") is optional. You can leave it off\
3284 \ if you want. As you get more comfortable with Elm and as your project grows,\
3285 \ it becomes more and more valuable to add them though! They work great as\
3286 \ compiler-verified documentation, and they often improve error messages!"
3290toLetDestructReport :: Code.Source -> Destruct -> Row -> Col -> Report.Report
3291toLetDestructReport source destruct startRow startCol =
3293 DestructSpace space row col ->
3294 toSpaceReport source space row col
3296 DestructPattern pattern row col ->
3297 toPatternReport source PLet pattern row col
3299 DestructEquals row col ->
3301 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3302 region = toRegion row col
3304 Report.Report "PROBLEM IN DEFINITION" region [] $
3305 Code.toSnippet source surroundings (Just region)
3308 "I got stuck trying to parse this definition:"
3310 case Code.whatIsNext source row col of
3311 Code.Operator ":" ->
3314 "I was expecting to see an equals sign next, followed by an expression\
3315 \ telling me what to compute."
3317 "It looks like you may be trying to write a type annotation? It is not\
3318 \ possible to add type annotations on destructuring definitions like this.\
3319 \ You can assign a name to the overall structure, put a type annotation on\
3320 \ that, and then destructure separately though."
3325 "I was expecting to see an equals sign next, followed by an expression\
3326 \ telling me what to compute."
3329 DestructBody expr row col ->
3330 toExprReport source (InDestruct startRow startCol) expr row col
3332 DestructIndentEquals row col ->
3334 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3335 region = toRegion row col
3337 Report.Report "UNFINISHED DEFINITION" region [] $
3338 Code.toSnippet source surroundings (Just region)
3341 "I got stuck trying to parse this definition:"
3344 "I was expecting to see an equals sign next, followed by an expression\
3345 \ telling me what to compute."
3348 DestructIndentBody row col ->
3350 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3351 region = toRegion row col
3353 Report.Report "UNFINISHED DEFINITION" region [] $
3354 Code.toSnippet source surroundings (Just region)
3357 "I got stuck while parsing this definition:"
3360 "I was expecting to see an expression next. What is it equal to?"
3368toCaseReport :: Code.Source -> Context -> Case -> Row -> Col -> Report.Report
3369toCaseReport source context case_ startRow startCol =
3371 CaseSpace space row col ->
3372 toSpaceReport source space row col
3375 toUnfinishCaseReport source row col startRow startCol $
3376 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3378 CasePattern pattern row col ->
3379 toPatternReport source PCase pattern row col
3381 CaseArrow row col ->
3382 case Code.whatIsNext source row col of
3383 Code.Keyword keyword ->
3385 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3386 region = toKeywordRegion row col keyword
3388 Report.Report "RESERVED WORD" region [] $
3389 Code.toSnippet source surroundings (Just region)
3392 "I am partway through parsing a `case` expression, but I got stuck here:"
3395 "It looks like you are trying to use `" ++ keyword ++ "` in one of your\
3396 \ patterns, but it is a reserved word. Try using a different name?"
3399 Code.Operator ":" ->
3401 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3402 region = toRegion row col
3404 Report.Report "UNEXPECTED OPERATOR" region [] $
3405 Code.toSnippet source surroundings (Just region)
3408 "I am partway through parsing a `case` expression, but I got stuck here:"
3411 ["I","am","seeing",D.dullyellow ":","but","maybe","you","want",D.green "::","instead?"
3412 ,"For","pattern","matching","on","lists?"
3416 Code.Operator "=" ->
3418 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3419 region = toRegion row col
3421 Report.Report "UNEXPECTED OPERATOR" region [] $
3422 Code.toSnippet source surroundings (Just region)
3425 "I am partway through parsing a `case` expression, but I got stuck here:"
3428 ["I","am","seeing",D.dullyellow "=","but","maybe","you","want",D.green "->","instead?"
3434 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3435 region = toRegion row col
3437 Report.Report "MISSING ARROW" region [] $
3438 Code.toSnippet source surroundings (Just region)
3441 "I am partway through parsing a `case` expression, but I got stuck here:"
3444 [ D.reflow "I was expecting to see an arrow next."
3445 , noteForCaseIndentError
3449 CaseExpr expr row col ->
3450 toExprReport source (InNode NCase startRow startCol context) expr row col
3452 CaseBranch expr row col ->
3453 toExprReport source (InNode NBranch startRow startCol context) expr row col
3455 CaseIndentOf row col ->
3456 toUnfinishCaseReport source row col startRow startCol $
3457 D.fillSep ["I","was","expecting","to","see","the",D.dullyellow "of","keyword","next."]
3459 CaseIndentExpr row col ->
3460 toUnfinishCaseReport source row col startRow startCol $
3461 D.reflow "I was expecting to see a expression next."
3463 CaseIndentPattern row col ->
3464 toUnfinishCaseReport source row col startRow startCol $
3465 D.reflow "I was expecting to see a pattern next."
3467 CaseIndentArrow row col ->
3468 toUnfinishCaseReport source row col startRow startCol $
3470 ["I","just","saw","a","pattern,","so","I","was","expecting"
3471 ,"to","see","a",D.dullyellow "->","next."
3474 CaseIndentBranch row col ->
3475 toUnfinishCaseReport source row col startRow startCol $
3477 "I was expecting to see an expression next. What should I do when\
3478 \ I run into this particular pattern?"
3480 CasePatternAlignment indent row col ->
3481 toUnfinishCaseReport source row col startRow startCol $
3483 "I suspect this is a pattern that is not indented far enough? (" ++ show indent ++ " spaces)"
3486toUnfinishCaseReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
3487toUnfinishCaseReport source row col startRow startCol message =
3489 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3490 region = toRegion row col
3492 Report.Report "UNFINISHED CASE" region [] $
3493 Code.toSnippet source surroundings (Just region)
3496 "I was partway through parsing a `case` expression, but I got stuck here:"
3505noteForCaseError :: D.Doc
3509 "Here is an example of a valid `case` expression for reference."
3511 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3512 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3513 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3515 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3516 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3519 "Notice the indentation. Each pattern is aligned, and each branch is indented\
3520 \ a bit more than the corresponding pattern. That is important!"
3524noteForCaseIndentError :: D.Doc
3525noteForCaseIndentError =
3528 "Sometimes I get confused by indentation, so try to make your `case` look\
3529 \ something like this:"
3531 [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3532 , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3533 , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3535 , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3536 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3539 "Notice the indentation! Each pattern is aligned, and each branch is indented\
3540 \ a bit more than the corresponding pattern. That is important!"
3548toIfReport :: Code.Source -> Context -> If -> Row -> Col -> Report.Report
3549toIfReport source context if_ startRow startCol =
3551 IfSpace space row col ->
3552 toSpaceReport source space row col
3556 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3557 region = toRegion row col
3559 Report.Report "UNFINISHED IF" region [] $
3560 Code.toSnippet source surroundings (Just region)
3563 "I was expecting to see more of this `if` expression, but I got stuck here:"
3566 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3572 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3573 region = toRegion row col
3575 Report.Report "UNFINISHED IF" region [] $
3576 Code.toSnippet source surroundings (Just region)
3579 "I was expecting to see more of this `if` expression, but I got stuck here:"
3582 ["I","was","expecting","to","see","the",D.cyan "else","keyword","next."
3586 IfElseBranchStart row col ->
3588 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3589 region = toRegion row col
3591 Report.Report "UNFINISHED IF" region [] $
3592 Code.toSnippet source surroundings (Just region)
3595 "I just saw the start of an `else` branch, but then I got stuck here:"
3598 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3601 IfCondition expr row col ->
3602 toExprReport source (InNode NCond startRow startCol context) expr row col
3604 IfThenBranch expr row col ->
3605 toExprReport source (InNode NThen startRow startCol context) expr row col
3607 IfElseBranch expr row col ->
3608 toExprReport source (InNode NElse startRow startCol context) expr row col
3610 IfIndentCondition row col ->
3612 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3613 region = toRegion row col
3615 Report.Report "UNFINISHED IF" region [] $
3616 Code.toSnippet source surroundings (Just region)
3619 "I was expecting to see more of this `if` expression, but I got stuck here:"
3623 ["I","was","expecting","to","see","an","expression","like",D.dullyellow "x < 0"
3624 ,"that","evaluates","to","True","or","False."
3627 "I can be confused by indentation. Maybe something is not indented enough?"
3631 IfIndentThen row col ->
3633 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3634 region = toRegion row col
3636 Report.Report "UNFINISHED IF" region [] $
3637 Code.toSnippet source surroundings (Just region)
3640 "I was expecting to see more of this `if` expression, but I got stuck here:"
3644 ["I","was","expecting","to","see","the",D.cyan "then","keyword","next."
3647 "I can be confused by indentation. Maybe something is not indented enough?"
3651 IfIndentThenBranch row col ->
3653 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3654 region = toRegion row col
3656 Report.Report "UNFINISHED IF" region [] $
3657 Code.toSnippet source surroundings (Just region)
3660 "I got stuck after the start of this `then` branch:"
3664 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3666 "I can be confused by indentation, so if the `then` branch is already\
3667 \ present, it may not be indented enough for me to recognize it."
3671 IfIndentElseBranch row col ->
3673 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3674 region = toRegion row col
3676 Report.Report "UNFINISHED IF" region [] $
3677 Code.toSnippet source surroundings (Just region)
3680 "I got stuck after the start of this `else` branch:"
3684 "I was expecting to see an expression next. Maybe it is not filled in yet?"
3686 "I can be confused by indentation, so if the `else` branch is already\
3687 \ present, it may not be indented enough for me to recognize it."
3691 IfIndentElse row col ->
3693 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3694 region = toRegion row col
3696 Report.Report "UNFINISHED IF" region [] $
3697 Code.toSnippet source surroundings (Just region)
3700 "I was expecting to see an `else` branch after this:"
3704 "I know what to do when the condition is `True`, but not when it is `False`."
3706 ["Add","an",D.cyan "else","branch","to","handle","that","scenario!"]
3715toRecordReport :: Code.Source -> Context -> Record -> Row -> Col -> Report.Report
3716toRecordReport source context record startRow startCol =
3718 RecordOpen row col ->
3719 case Code.whatIsNext source row col of
3720 Code.Keyword keyword ->
3722 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3723 region = toKeywordRegion row col keyword
3725 Report.Report "RESERVED WORD" region [] $
3726 Code.toSnippet source surroundings (Just region)
3729 "I just started parsing a record, but I got stuck on this field name:"
3732 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3733 \ that is a reserved word. Try using a different name!"
3738 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3739 region = toRegion row col
3741 Report.Report "UNFINISHED RECORD" region [] $
3742 Code.toSnippet source surroundings (Just region)
3745 "I just started parsing a record, but I got stuck here:"
3748 ["Records","look","like",D.dullyellow "{ x = 3, y = 4 },"
3749 ,"so","I","was","expecting","to","see","a","field","name","next."
3753 RecordEnd row col ->
3755 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3756 region = toRegion row col
3758 Report.Report "UNFINISHED RECORD" region [] $
3759 Code.toSnippet source surroundings (Just region)
3762 "I am partway through parsing a record, but I got stuck here:"
3766 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
3767 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
3770 "When I get stuck like this, it usually means that there is a missing parenthesis\
3771 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
3775 RecordField row col ->
3776 case Code.whatIsNext source row col of
3777 Code.Keyword keyword ->
3779 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3780 region = toKeywordRegion row col keyword
3782 Report.Report "RESERVED WORD" region [] $
3783 Code.toSnippet source surroundings (Just region)
3786 "I am partway through parsing a record, but I got stuck on this field name:"
3789 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
3790 \ that is a reserved word. Try using a different name!"
3795 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3796 region = toRegion row col
3798 Report.Report "UNFINISHED RECORD" region [] $
3799 Code.toSnippet source surroundings (Just region)
3802 "I am partway through parsing a record, but I got stuck after that last comma:"
3804 addNoteForRecordError $
3806 "Trailing commas are not allowed in records, so I was expecting to see another\
3807 \ record field defined next. If you are done defining the record, the fix may\
3808 \ be to delete that last comma?"
3811 RecordEquals row col ->
3813 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3814 region = toRegion row col
3816 Report.Report "UNFINISHED RECORD" region [] $
3817 Code.toSnippet source surroundings (Just region)
3820 "I am partway through parsing a record, but I got stuck here:"
3822 addNoteForRecordError $
3824 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
3825 ,"an","equals","sign","next.","So","try","putting","an",D.green "=","sign","here?"
3829 RecordExpr expr row col ->
3830 toExprReport source (InNode NRecord startRow startCol context) expr row col
3832 RecordSpace space row col ->
3833 toSpaceReport source space row col
3835 RecordIndentOpen row col ->
3837 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3838 region = toRegion row col
3840 Report.Report "UNFINISHED RECORD" region [] $
3841 Code.toSnippet source surroundings (Just region)
3844 "I just saw the opening curly brace of a record, but then I got stuck here:"
3846 addNoteForRecordIndentError $
3848 ["I","am","expecting","a","record","like",D.dullyellow "{ x = 3, y = 4 }","here."
3849 ,"Try","defining","some","fields","of","your","own?"
3853 RecordIndentEnd row col ->
3855 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3856 region = toRegion row col
3858 Report.Report "UNFINISHED RECORD" region [] $
3859 Code.toSnippet source surroundings (Just region)
3862 "I was expecting to see a closing curly brace next:"
3864 addNoteForRecordIndentError $
3866 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
3870 RecordIndentField row col ->
3872 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3873 region = toRegion row col
3875 Report.Report "UNFINISHED RECORD" region [] $
3876 Code.toSnippet source surroundings (Just region)
3879 "I am partway through parsing a record, but I got stuck after that last comma:"
3881 addNoteForRecordError $
3883 "Trailing commas are not allowed in records, so the fix may be to\
3884 \ delete that last comma? Or maybe you were in the middle of defining\
3885 \ an additional field?"
3888 RecordIndentEquals row col ->
3890 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3891 region = toRegion row col
3893 Report.Report "UNFINISHED RECORD" region [] $
3894 Code.toSnippet source surroundings (Just region)
3897 "I am partway through parsing a record. I just saw a record\
3898 \ field, so I was expecting to see an equals sign next:"
3900 addNoteForRecordIndentError $
3902 ["Try","putting","an",D.green "=","followed","by","an","expression?"
3906 RecordIndentExpr row col ->
3908 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3909 region = toRegion row col
3911 Report.Report "UNFINISHED RECORD" region [] $
3912 Code.toSnippet source surroundings (Just region)
3915 "I am partway through parsing a record, and I was expecting to run into an expression next:"
3917 addNoteForRecordIndentError $
3919 ["Try","putting","something","like"
3920 ,D.dullyellow "42","or",D.dullyellow"\"hello\"","for","now?"
3925addNoteForRecordError :: D.Doc -> D.Doc
3926addNoteForRecordError normalRecommendation =
3928 normalRecommendation
3931 "If you are trying to define a record across multiple lines, I recommend using this format:"
3932 , D.indent 4 $ D.vcat $
3933 [ "{ name = \"Alice\""
3939 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3940 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3941 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3945addNoteForRecordIndentError :: D.Doc -> D.Doc
3946addNoteForRecordIndentError normalRecommendation =
3948 normalRecommendation
3951 "I may be confused by indentation. For example, if you are trying to define\
3952 \ a record across multiple lines, I recommend using this format:"
3953 , D.indent 4 $ D.vcat $
3954 [ "{ name = \"Alice\""
3960 "Notice that each line starts with some indentation. Usually two or four spaces. I\
3961 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3962 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
3970toTupleReport :: Code.Source -> Context -> Tuple -> Row -> Col -> Report.Report
3971toTupleReport source context tuple startRow startCol =
3973 TupleExpr expr row col ->
3974 toExprReport source (InNode NParens startRow startCol context) expr row col
3976 TupleSpace space row col ->
3977 toSpaceReport source space row col
3981 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3982 region = toRegion row col
3984 Report.Report "UNFINISHED PARENTHESES" region [] $
3985 Code.toSnippet source surroundings (Just region)
3988 "I was expecting to see a closing parentheses next, but I got stuck here:"
3991 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
3993 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
3994 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
3995 \ or missing brackets) that is confusing me."
3999 TupleOperatorClose row col ->
4001 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4002 region = toRegion row col
4004 Report.Report "UNFINISHED OPERATOR FUNCTION" region [] $
4005 Code.toSnippet source surroundings (Just region)
4007 D.reflow "I was expecting a closing parenthesis here:"
4010 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
4012 "I think I am parsing an operator function right now, so I am expecting to see\
4013 \ something like (+) or (&&) where an operator is surrounded by parentheses with\
4018 TupleOperatorReserved operator row col ->
4020 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4021 region = toRegion row col
4023 Report.Report "UNEXPECTED SYMBOL" region [] $
4024 Code.toSnippet source surroundings (Just region)
4027 "I ran into an unexpected symbol here:"
4031 BadDot -> ["Maybe","you","wanted","a","record","accessor","like",D.dullyellow ".x","or",D.dullyellow ".name","instead?"]
4032 BadPipe -> ["Try",D.dullyellow "(||)","instead?","To","turn","boolean","OR","into","a","function?"]
4033 BadArrow -> ["Maybe","you","wanted",D.dullyellow "(>)","or",D.dullyellow "(>=)","instead?"]
4034 BadEquals -> ["Try",D.dullyellow "(==)","instead?","To","make","a","function","that","checks","equality?"]
4035 BadHasType -> ["Try",D.dullyellow "(::)","instead?","To","add","values","to","the","front","of","lists?"]
4038 TupleIndentExpr1 row col ->
4040 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4041 region = toRegion row col
4043 Report.Report "UNFINISHED PARENTHESES" region [] $
4044 Code.toSnippet source surroundings (Just region)
4047 "I just saw an open parenthesis, so I was expecting to see an expression next."
4051 ["Something","like",D.dullyellow "(4 + 5)","or"
4052 ,D.dullyellow "(String.reverse \"desserts\")" <> "."
4053 ,"Anything","where","you","are","putting","parentheses","around","normal","expressions."
4056 "I can get confused by indentation in cases like this, so\
4057 \ maybe you have an expression but it is not indented enough?"
4061 TupleIndentExprN row col ->
4063 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4064 region = toRegion row col
4066 Report.Report "UNFINISHED TUPLE" region [] $
4067 Code.toSnippet source surroundings (Just region)
4070 "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."
4074 ["A","tuple","looks","like",D.dullyellow "(3,4)","or"
4075 ,D.dullyellow "(\"Tom\",42)" <> ","
4076 ,"so","I","think","there","is","an","expression","missing","here?"
4079 "I can get confused by indentation in cases like this, so\
4080 \ maybe you have an expression but it is not indented enough?"
4084 TupleIndentEnd row col ->
4086 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4087 region = toRegion row col
4089 Report.Report "UNFINISHED PARENTHESES" region [] $
4090 Code.toSnippet source surroundings (Just region)
4093 "I was expecting to see a closing parenthesis next:"
4096 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
4098 "I can get confused by indentation in cases like this, so\
4099 \ maybe you have a closing parenthesis but it is not indented enough?"
4104toListReport :: Code.Source -> Context -> List -> Row -> Col -> Report.Report
4105toListReport source context list startRow startCol =
4107 ListSpace space row col ->
4108 toSpaceReport source space row col
4112 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4113 region = toRegion row col
4115 Report.Report "UNFINISHED LIST" region [] $
4116 Code.toSnippet source surroundings (Just region)
4119 "I am partway through parsing a list, but I got stuck here:"
4123 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
4124 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
4127 "When I get stuck like this, it usually means that there is a missing parenthesis\
4128 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4132 ListExpr expr row col ->
4136 surroundings = A.Region (A.Position startRow startCol) (A.Position r c)
4137 region = toRegion r c
4139 Report.Report "UNFINISHED LIST" region [] $
4140 Code.toSnippet source surroundings (Just region)
4143 "I was expecting to see another list entry after that last comma:"
4147 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
4149 "I recommend using the following format for lists that span multiple lines:"
4150 , D.indent 4 $ D.vcat $
4157 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4158 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4159 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4164 toExprReport source (InNode NList startRow startCol context) expr row col
4168 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4169 region = toRegion row col
4171 Report.Report "UNFINISHED LIST" region [] $
4172 Code.toSnippet source surroundings (Just region)
4175 "I am partway through parsing a list, but I got stuck here:"
4179 ["I","was","expecting","to","see","a","closing","square","bracket","before","this,"
4180 ,"so","try","adding","a",D.dullyellow "]","and","see","if","that","helps?"
4183 "When I get stuck like this, it usually means that there is a missing parenthesis\
4184 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
4188 ListIndentOpen row col ->
4190 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4191 region = toRegion row col
4193 Report.Report "UNFINISHED LIST" region [] $
4194 Code.toSnippet source surroundings (Just region)
4197 "I cannot find the end of this list:"
4201 ["You","could","change","it","to","something","like"
4202 ,D.dullyellow "[3,4,5]"
4204 ,D.dullyellow "[]" <> "."
4205 ,"Anything","where","there","is","an","open","and","close","square","brace,"
4206 ,"and","where","the","elements","of","the","list","are","separated","by","commas."
4209 "I may be confused by indentation. For example, if you are trying to define\
4210 \ a list across multiple lines, I recommend using this format:"
4211 , D.indent 4 $ D.vcat $
4218 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4219 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4220 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4224 ListIndentEnd row col ->
4226 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4227 region = toRegion row col
4229 Report.Report "UNFINISHED LIST" region [] $
4230 Code.toSnippet source surroundings (Just region)
4233 "I cannot find the end of this list:"
4237 ["You","can","just","add","a","closing",D.dullyellow "]"
4238 ,"right","here,","and","I","will","be","all","set!"
4241 "I may be confused by indentation. For example, if you are trying to define\
4242 \ a list across multiple lines, I recommend using this format:"
4243 , D.indent 4 $ D.vcat $
4250 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4251 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4252 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4256 ListIndentExpr row col ->
4258 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4259 region = toRegion row col
4261 Report.Report "UNFINISHED LIST" region [] $
4262 Code.toSnippet source surroundings (Just region)
4265 "I was expecting to see another list entry after this comma:"
4269 "Trailing commas are not allowed in lists, so the fix may be to delete the comma?"
4271 "I recommend using the following format for lists that span multiple lines:"
4272 , D.indent 4 $ D.vcat $
4279 "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4280 \ This style can be jarring for people coming from C-like syntax, but folks generally\
4281 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4286toFuncReport :: Code.Source -> Context -> Func -> Row -> Col -> Report.Report
4287toFuncReport source context func startRow startCol =
4289 FuncSpace space row col ->
4290 toSpaceReport source space row col
4292 FuncArg pattern row col ->
4293 toPatternReport source PArg pattern row col
4295 FuncBody expr row col ->
4296 toExprReport source (InNode NFunc startRow startCol context) expr row col
4298 FuncArrow row col ->
4299 case Code.whatIsNext source row col of
4300 Code.Keyword keyword ->
4302 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4303 region = toKeywordRegion row col keyword
4305 Report.Report "RESERVED WORD" region [] $
4306 Code.toSnippet source surroundings (Just region)
4309 "I was parsing an anonymous function, but I got stuck here:"
4312 "It looks like you are trying to use `" ++ keyword ++ "` as an argument, but\
4313 \ it is a reserved word in this language. Try using a different argument name!"
4318 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4319 region = toRegion row col
4321 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4322 Code.toSnippet source surroundings (Just region)
4325 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4328 ["The","syntax","for","anonymous","functions","is"
4329 ,D.dullyellow "(\\x -> x + 1)"
4330 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4334 FuncIndentArg row col ->
4336 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4337 region = toRegion row col
4339 Report.Report "MISSING ARGUMENT" region [] $
4340 Code.toSnippet source surroundings (Just region)
4343 "I just saw the beginning of an anonymous function, so I was expecting to see an argument next:"
4347 ["Something","like",D.dullyellow"x","or",D.dullyellow "name" <> "."
4348 ,"Anything","that","starts","with","a","lower","case","letter!"
4351 "The syntax for anonymous functions is (\\x -> x + 1) where the backslash\
4352 \ is meant to look a bit like a lambda if you squint. This visual pun seemed\
4353 \ like a better idea at the time!"
4357 FuncIndentArrow row col ->
4359 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4360 region = toRegion row col
4362 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4363 Code.toSnippet source surroundings (Just region)
4366 "I just saw the beginning of an anonymous function, so I was expecting to see an arrow next:"
4370 ["The","syntax","for","anonymous","functions","is"
4371 ,D.dullyellow "(\\x -> x + 1)"
4372 ,"so","I","am","missing","the","arrow","and","the","body","of","the","function."
4375 "It is possible that I am confused about indetation! I generally recommend\
4376 \ switching to named functions if the definition cannot fit inline nicely, so\
4377 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4378 \ the whole thing out into a named function. Things tend to be clearer that way!"
4382 FuncIndentBody row col ->
4384 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4385 region = toRegion row col
4387 Report.Report "UNFINISHED ANONYMOUS FUNCTION" region [] $
4388 Code.toSnippet source surroundings (Just region)
4391 "I was expecting to see the body of your anonymous function next:"
4395 ["The","syntax","for","anonymous","functions","is"
4396 ,D.dullyellow "(\\x -> x + 1)"
4397 ,"so","I","am","missing","all","the","stuff","after","the","arrow!"
4400 "It is possible that I am confused about indetation! I generally recommend\
4401 \ switching to named functions if the definition cannot fit inline nicely, so\
4402 \ either (1) try to fit the whole anonymous function on one line or (2) break\
4403 \ the whole thing out into a named function. Things tend to be clearer that way!"
4418toPatternReport :: Code.Source -> PContext -> Pattern -> Row -> Col -> Report.Report
4419toPatternReport source context pattern startRow startCol =
4421 PRecord record row col ->
4422 toPRecordReport source record row col
4424 PTuple tuple row col ->
4425 toPTupleReport source context tuple row col
4427 PList list row col ->
4428 toPListReport source context list row col
4431 case Code.whatIsNext source row col of
4432 Code.Keyword keyword ->
4434 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4435 region = toKeywordRegion row col keyword
4438 PArg -> "as an argument"
4439 PCase -> "in this pattern"
4440 PLet -> "in this pattern"
4442 Report.Report "RESERVED WORD" region [] $
4443 Code.toSnippet source surroundings (Just region)
4446 "It looks like you are trying to use `" ++ keyword ++ "` " ++ inThisThing ++ ":"
4449 "This is a reserved word! Try using some other name?"
4452 Code.Operator "-" ->
4454 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4455 region = toRegion row col
4457 Report.Report "UNEXPECTED SYMBOL" region [] $
4458 Code.toSnippet source surroundings (Just region)
4461 "I ran into a minus sign unexpectedly in this pattern:"
4464 "It is not possible to pattern match on negative numbers at this\
4465 \ time. Try using an `if` expression for that sort of thing for now."
4470 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4471 region = toRegion row col
4473 Report.Report "PROBLEM IN PATTERN" region [] $
4474 Code.toSnippet source surroundings (Just region)
4477 "I wanted to parse a pattern next, but I got stuck here:"
4480 ["I","am","not","sure","why","I","am","getting","stuck","exactly."
4481 ,"I","just","know","that","I","want","a","pattern","next."
4482 ,"Something","as","simple","as"
4483 ,D.dullyellow "maybeHeight","or",D.dullyellow "result"
4488 PChar char row col ->
4489 toCharReport source char row col
4491 PString string row col ->
4492 toStringReport source string row col
4494 PNumber number row col ->
4495 toNumberReport source number row col
4497 PFloat width row col ->
4499 region = toWiderRegion row col width
4501 Report.Report "UNEXPECTED PATTERN" region [] $
4502 Code.toSnippet source region Nothing
4505 "I cannot pattern match with floating point numbers:"
4508 ["Equality","on","floats","can","be","unreliable,","so","you","usually","want"
4509 ,"to","check","that","they","are","nearby","with","some","sort","of"
4510 ,D.dullyellow "(abs (actual - expected) < 0.001)","check."
4516 region = toRegion row col
4518 Report.Report "UNFINISHED PATTERN" region [] $
4519 Code.toSnippet source region Nothing $
4522 "I was expecting to see a variable name after the `as` keyword:"
4526 ["The","`as`","keyword","lets","you","write","patterns","like"
4527 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4528 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4529 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4530 ,"thing","with",D.dullyellow "point" <> "."
4533 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4534 \ people just want to use `as` as a variable name though. Try using a different name\
4539 PWildcardNotVar name width row col ->
4541 region = toWiderRegion row col (fromIntegral width)
4543 case dropWhile (=='_') (Name.toChars name) of
4544 [] -> [D.dullyellow "x","or",D.dullyellow "age"]
4545 c:cs -> [D.dullyellow (D.fromChars (Char.toLower c : cs))]
4547 Report.Report "UNEXPECTED NAME" region [] $
4548 Code.toSnippet source region Nothing $
4551 "Variable names cannot start with underscores like this:"
4554 ["You","can","either","have","an","underscore","like",D.dullyellow "_","to"
4555 ,"ignore","the","value,","or","you","can","have","a","name","like"
4556 ] ++ examples ++ ["to","use","the","matched","value." ]
4559 PSpace space row col ->
4560 toSpaceReport source space row col
4562 PIndentStart row col ->
4564 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4565 region = toRegion row col
4567 Report.Report "UNFINISHED PATTERN" region [] $
4568 Code.toSnippet source surroundings (Just region)
4571 "I wanted to parse a pattern next, but I got stuck here:"
4575 ["I","am","not","sure","why","I","am","getting","stuck","exactly."
4576 ,"I","just","know","that","I","want","a","pattern","next."
4577 ,"Something","as","simple","as"
4578 ,D.dullyellow "maybeHeight","or",D.dullyellow "result"
4582 "I can get confused by indentation. If you think there is a pattern next, maybe\
4583 \ it needs to be indented a bit more?"
4587 PIndentAlias row col ->
4589 region = toRegion row col
4591 Report.Report "UNFINISHED PATTERN" region [] $
4592 Code.toSnippet source region Nothing $
4595 "I was expecting to see a variable name after the `as` keyword:"
4599 ["The","`as`","keyword","lets","you","write","patterns","like"
4600 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
4601 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
4602 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4603 ,"thing","with",D.dullyellow "point."
4606 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
4607 \ people just want to use `as` as a variable name though. Try using a different name\
4613toPRecordReport :: Code.Source -> PRecord -> Row -> Col -> Report.Report
4614toPRecordReport source record startRow startCol =
4616 PRecordOpen row col ->
4617 toUnfinishRecordPatternReport source row col startRow startCol $
4618 D.reflow "I was expecting to see a field name next."
4620 PRecordEnd row col ->
4621 toUnfinishRecordPatternReport source row col startRow startCol $
4623 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4624 ,"Try","adding","a",D.dullyellow "}","here?"
4627 PRecordField row col ->
4628 case Code.whatIsNext source row col of
4629 Code.Keyword keyword ->
4631 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4632 region = toKeywordRegion row col keyword
4634 Report.Report "RESERVED WORD" region [] $
4635 Code.toSnippet source surroundings (Just region)
4638 "I was not expecting to see `" ++ keyword ++ "` as a record field name:"
4641 "This is a reserved word, not available for variable names. Try another name!"
4645 toUnfinishRecordPatternReport source row col startRow startCol $
4646 D.reflow "I was expecting to see a field name next."
4648 PRecordSpace space row col ->
4649 toSpaceReport source space row col
4651 PRecordIndentOpen row col ->
4652 toUnfinishRecordPatternReport source row col startRow startCol $
4653 D.reflow "I was expecting to see a field name next."
4655 PRecordIndentEnd row col ->
4656 toUnfinishRecordPatternReport source row col startRow startCol $
4658 ["I","was","expecting","to","see","a","closing","curly","brace","next."
4659 ,"Try","adding","a",D.dullyellow "}","here?"
4662 PRecordIndentField row col ->
4663 toUnfinishRecordPatternReport source row col startRow startCol $
4664 D.reflow "I was expecting to see a field name next."
4667toUnfinishRecordPatternReport :: Code.Source -> Row -> Col -> Row -> Col -> D.Doc -> Report.Report
4668toUnfinishRecordPatternReport source row col startRow startCol message =
4670 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4671 region = toRegion row col
4673 Report.Report "UNFINISHED RECORD PATTERN" region [] $
4674 Code.toSnippet source surroundings (Just region)
4677 "I was partway through parsing a record pattern, but I got stuck here:"
4682 ["A","record","pattern","looks","like",D.dullyellow "{x,y}","or",D.dullyellow "{name,age}"
4683 ,"where","you","list","the","field","names","you","want","to","access."
4690toPTupleReport :: Code.Source -> PContext -> PTuple -> Row -> Col -> Report.Report
4691toPTupleReport source context tuple startRow startCol =
4693 PTupleOpen row col ->
4694 case Code.whatIsNext source row col of
4695 Code.Keyword keyword ->
4697 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4698 region = toKeywordRegion row col keyword
4700 Report.Report "RESERVED WORD" region [] $
4701 Code.toSnippet source surroundings (Just region)
4704 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name:"
4707 "This is a reserved word! Try using some other name?"
4712 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4713 region = toRegion row col
4715 Report.Report "UNFINISHED PARENTHESES" region [] $
4716 Code.toSnippet source surroundings (Just region)
4719 "I just saw an open parenthesis, but I got stuck here:"
4722 ["I","was","expecting","to","see","a","pattern","next."
4723 ,"Maybe","it","will","end","up","being","something"
4724 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4728 PTupleEnd row col ->
4729 case Code.whatIsNext source row col of
4730 Code.Keyword keyword ->
4732 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4733 region = toKeywordRegion row col keyword
4735 Report.Report "RESERVED WORD" region [] $
4736 Code.toSnippet source surroundings (Just region) $
4739 "I ran into a reserved word in this pattern:"
4742 "The `" ++ keyword ++ "` keyword is reserved. Try using a different name instead!"
4747 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4748 region = toKeywordRegion row col op
4750 Report.Report "UNEXPECTED SYMBOL" region [] $
4751 Code.toSnippet source surroundings (Just region) $
4754 "I ran into the " ++ op ++ " symbol unexpectedly in this pattern:"
4757 "Only the :: symbol that works in patterns. It is useful if you\
4758 \ are pattern matching on lists, trying to get the first element\
4759 \ off the front. Did you want that instead?"
4762 Code.Close term bracket ->
4764 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4765 region = toRegion row col
4767 Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
4768 Code.toSnippet source surroundings (Just region) $
4771 "I ran into a an unexpected " ++ term ++ " in this pattern:"
4774 "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
4779 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4780 region = toRegion row col
4782 Report.Report "UNFINISHED PARENTHESES" region [] $
4783 Code.toSnippet source surroundings (Just region) $
4786 "I was partway through parsing a pattern, but I got stuck here:"
4789 ["I","was","expecting","a","closing","parenthesis","next,","so"
4790 ,"try","adding","a",D.dullyellow ")","to","see","if","that","helps?"
4794 PTupleExpr pattern row col ->
4795 toPatternReport source context pattern row col
4797 PTupleSpace space row col ->
4798 toSpaceReport source space row col
4800 PTupleIndentEnd row col ->
4802 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4803 region = toRegion row col
4805 Report.Report "UNFINISHED PARENTHESES" region [] $
4806 Code.toSnippet source surroundings (Just region) $
4809 "I was expecting a closing parenthesis next:"
4812 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
4814 "I can get confused by indentation in cases like this, so\
4815 \ maybe you have a closing parenthesis but it is not indented enough?"
4819 PTupleIndentExpr1 row col ->
4821 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4822 region = toRegion row col
4824 Report.Report "UNFINISHED PARENTHESES" region [] $
4825 Code.toSnippet source surroundings (Just region) $
4828 "I just saw an open parenthesis, but then I got stuck here:"
4831 ["I","was","expecting","to","see","a","pattern","next."
4832 ,"Maybe","it","will","end","up","being","something"
4833 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
4837 PTupleIndentExprN row col ->
4839 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4840 region = toRegion row col
4842 Report.Report "UNFINISHED TUPLE PATTERN" region [] $
4843 Code.toSnippet source surroundings (Just region) $
4846 "I am partway through parsing a tuple pattern, but I got stuck here:"
4850 ["I","was","expecting","to","see","a","pattern","next."
4851 ,"I","am","expecting","the","final","result","to","be","something"
4852 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "."
4855 "I can get confused by indentation in cases like this, so the problem\
4856 \ may be that the next part is not indented enough?"
4861toPListReport :: Code.Source -> PContext -> PList -> Row -> Col -> Report.Report
4862toPListReport source context list startRow startCol =
4864 PListOpen row col ->
4865 case Code.whatIsNext source row col of
4866 Code.Keyword keyword ->
4868 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4869 region = toKeywordRegion row col keyword
4871 Report.Report "RESERVED WORD" region [] $
4872 Code.toSnippet source surroundings (Just region)
4875 "It looks like you are trying to use `" ++ keyword ++ "` to name an element of a list:"
4878 "This is a reserved word though! Try using some other name?"
4883 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4884 region = toRegion row col
4886 Report.Report "UNFINISHED LIST PATTERN" region [] $
4887 Code.toSnippet source surroundings (Just region) $
4890 "I just saw an open square bracket, but then I got stuck here:"
4892 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4897 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4898 region = toRegion row col
4900 Report.Report "UNFINISHED LIST PATTERN" region [] $
4901 Code.toSnippet source surroundings (Just region) $
4904 "I was expecting a closing square bracket to end this list pattern:"
4906 D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4909 PListExpr pattern row col ->
4910 toPatternReport source context pattern row col
4912 PListSpace space row col ->
4913 toSpaceReport source space row col
4915 PListIndentOpen row col ->
4917 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4918 region = toRegion row col
4920 Report.Report "UNFINISHED LIST PATTERN" region [] $
4921 Code.toSnippet source surroundings (Just region) $
4924 "I just saw an open square bracket, but then I got stuck here:"
4927 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4929 "I can get confused by indentation in cases like this, so\
4930 \ maybe there is something next, but it is not indented enough?"
4934 PListIndentEnd row col ->
4936 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4937 region = toRegion row col
4939 Report.Report "UNFINISHED LIST PATTERN" region [] $
4940 Code.toSnippet source surroundings (Just region) $
4943 "I was expecting a closing square bracket to end this list pattern:"
4946 [ D.fillSep ["Try","adding","a",D.dullyellow "]","to","see","if","that","helps?"]
4948 "I can get confused by indentation in cases like this, so\
4949 \ maybe you have a closing square bracket but it is not indented enough?"
4953 PListIndentExpr row col ->
4955 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4956 region = toRegion row col
4958 Report.Report "UNFINISHED LIST PATTERN" region [] $
4959 Code.toSnippet source surroundings (Just region) $
4962 "I am partway through parsing a list pattern, but I got stuck here:"
4966 "I was expecting to see another pattern next. Maybe a variable name."
4968 "I can get confused by indentation in cases like this, so\
4969 \ maybe there is more to this pattern but it is not indented enough?"
4979 = TC_Annotation Name.Name
4985toTypeReport :: Code.Source -> TContext -> Type -> Row -> Col -> Report.Report
4986toTypeReport source context tipe startRow startCol =
4988 TRecord record row col ->
4989 toTRecordReport source context record row col
4991 TTuple tuple row col ->
4992 toTTupleReport source context tuple row col
4995 case Code.whatIsNext source row col of
4996 Code.Keyword keyword ->
4998 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4999 region = toKeywordRegion row col keyword
5001 Report.Report "RESERVED WORD" region [] $
5002 Code.toSnippet source surroundings (Just region)
5005 "I was expecting to see a type next, but I got stuck on this reserved word:"
5008 "It looks like you are trying to use `" ++ keyword ++ "` as a type variable, but \
5009 \ it is a reserved word. Try using a different name!"
5014 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5015 region = toRegion row col
5019 TC_Annotation _ -> "type annotation"
5020 TC_CustomType -> "custom type"
5021 TC_TypeAlias -> "type alias"
5026 TC_Annotation name -> "the `" ++ Name.toChars name ++ "` type annotation"
5027 TC_CustomType -> "a custom type"
5028 TC_TypeAlias -> "a type alias"
5031 Report.Report ("PROBLEM IN " ++ map Char.toUpper thing) region [] $
5032 Code.toSnippet source surroundings (Just region)
5035 "I was partway through parsing " ++ something ++ ", but I got stuck here:"
5038 ["I","was","expecting","to","see","a","type","next."
5039 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5043 TSpace space row col ->
5044 toSpaceReport source space row col
5046 TIndentStart row col ->
5048 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5049 region = toRegion row col
5053 TC_Annotation _ -> "type annotation"
5054 TC_CustomType -> "custom type"
5055 TC_TypeAlias -> "type alias"
5058 Report.Report ("UNFINISHED " ++ map Char.toUpper thing) region [] $
5059 Code.toSnippet source surroundings (Just region)
5062 "I was partway through parsing a " ++ thing ++ ", but I got stuck here:"
5066 ["I","was","expecting","to","see","a","type","next."
5067 ,"Try","putting",D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5070 "I can get confused by indentation. If you think there is already a type\
5071 \ next, maybe it is not indented enough?"
5076toTRecordReport :: Code.Source -> TContext -> TRecord -> Row -> Col -> Report.Report
5077toTRecordReport source context record startRow startCol =
5079 TRecordOpen row col ->
5080 case Code.whatIsNext source row col of
5081 Code.Keyword keyword ->
5083 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5084 region = toKeywordRegion row col keyword
5086 Report.Report "RESERVED WORD" region [] $
5087 Code.toSnippet source surroundings (Just region)
5090 "I just started parsing a record type, but I got stuck on this field name:"
5093 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
5094 \ that is a reserved word. Try using a different name!"
5099 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5100 region = toRegion row col
5102 Report.Report "UNFINISHED RECORD TYPE" region [] $
5103 Code.toSnippet source surroundings (Just region)
5106 "I just started parsing a record type, but I got stuck here:"
5109 ["Record","types","look","like",D.dullyellow "{ name : String, age : Int },"
5110 ,"so","I","was","expecting","to","see","a","field","name","next."
5114 TRecordEnd row col ->
5116 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5117 region = toRegion row col
5119 Report.Report "UNFINISHED RECORD TYPE" region [] $
5120 Code.toSnippet source surroundings (Just region)
5123 "I am partway through parsing a record type, but I got stuck here:"
5127 ["I","was","expecting","to","see","a","closing","curly","brace","before","this,"
5128 ,"so","try","adding","a",D.dullyellow "}","and","see","if","that","helps?"
5131 "When I get stuck like this, it usually means that there is a missing parenthesis\
5132 \ or bracket somewhere earlier. It could also be a stray keyword or operator."
5136 TRecordField row col ->
5137 case Code.whatIsNext source row col of
5138 Code.Keyword keyword ->
5140 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5141 region = toKeywordRegion row col keyword
5143 Report.Report "RESERVED WORD" region [] $
5144 Code.toSnippet source surroundings (Just region)
5147 "I am partway through parsing a record type, but I got stuck on this field name:"
5150 "It looks like you are trying to use `" ++ keyword ++ "` as a field name, but \
5151 \ that is a reserved word. Try using a different name!"
5156 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5157 region = toRegion row col
5159 Report.Report "UNFINISHED RECORD TYPE" region [] $
5160 Code.toSnippet source surroundings (Just region)
5163 "I am partway through parsing a record type, but I got stuck after that last comma:"
5165 addNoteForRecordTypeError $
5167 "Trailing commas are not allowed in records, so I was expecting to see another\
5168 \ record field defined next. If you are done defining the record, the fix may\
5169 \ be to delete that last comma?"
5172 TRecordColon row col ->
5174 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5175 region = toRegion row col
5177 Report.Report "UNFINISHED RECORD TYPE" region [] $
5178 Code.toSnippet source surroundings (Just region)
5181 "I am partway through parsing a record type, but I got stuck here:"
5183 addNoteForRecordTypeError $
5185 ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
5186 ,"a","colon","next.","So","try","putting","an",D.green ":","sign","here?"
5190 TRecordType tipe row col ->
5191 toTypeReport source context tipe row col
5193 TRecordSpace space row col ->
5194 toSpaceReport source space row col
5196 TRecordIndentOpen row col ->
5198 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5199 region = toRegion row col
5201 Report.Report "UNFINISHED RECORD TYPE" region [] $
5202 Code.toSnippet source surroundings (Just region)
5205 "I just saw the opening curly brace of a record type, but then I got stuck here:"
5207 addNoteForRecordTypeIndentError $
5209 ["I","am","expecting","a","record","like",D.dullyellow "{ name : String, age : Int }","here."
5210 ,"Try","defining","some","fields","of","your","own?"
5214 TRecordIndentEnd row col ->
5216 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5217 region = toRegion row col
5219 Report.Report "UNFINISHED RECORD TYPE" region [] $
5220 Code.toSnippet source surroundings (Just region)
5223 "I was expecting to see a closing curly brace next:"
5225 addNoteForRecordTypeIndentError $
5227 ["Try","putting","an",D.green "}","and","see","if","that","helps?"
5231 TRecordIndentField row col ->
5233 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5234 region = toRegion row col
5236 Report.Report "UNFINISHED RECORD TYPE" region [] $
5237 Code.toSnippet source surroundings (Just region)
5240 "I am partway through parsing a record type, but I got stuck after that last comma:"
5242 addNoteForRecordTypeIndentError $
5244 "Trailing commas are not allowed in record types, so the fix may be to\
5245 \ delete that last comma? Or maybe you were in the middle of defining\
5246 \ an additional field?"
5249 TRecordIndentColon row col ->
5251 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5252 region = toRegion row col
5254 Report.Report "UNFINISHED RECORD TYPE" region [] $
5255 Code.toSnippet source surroundings (Just region)
5258 "I am partway through parsing a record type. I just saw a record\
5259 \ field, so I was expecting to see a colon next:"
5261 addNoteForRecordTypeIndentError $
5263 ["Try","putting","an",D.green ":","followed","by","a","type?"
5267 TRecordIndentType row col ->
5269 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5270 region = toRegion row col
5272 Report.Report "UNFINISHED RECORD TYPE" region [] $
5273 Code.toSnippet source surroundings (Just region)
5276 "I am partway through parsing a record type, and I was expecting to run into a type next:"
5278 addNoteForRecordTypeIndentError $
5280 ["Try","putting","something","like"
5281 ,D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5286addNoteForRecordTypeError :: D.Doc -> D.Doc
5287addNoteForRecordTypeError normalRecommendation =
5289 normalRecommendation
5292 "If you are trying to define a record type across multiple lines, I recommend using this format:"
5293 , D.indent 4 $ D.vcat $
5296 , ", height : Float"
5300 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5301 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5302 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5306addNoteForRecordTypeIndentError :: D.Doc -> D.Doc
5307addNoteForRecordTypeIndentError normalRecommendation =
5309 normalRecommendation
5312 "I may be confused by indentation. For example, if you are trying to define\
5313 \ a record type across multiple lines, I recommend using this format:"
5314 , D.indent 4 $ D.vcat $
5317 , ", height : Float"
5321 "Notice that each line starts with some indentation. Usually two or four spaces. I\
5322 \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5323 \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5327toTTupleReport :: Code.Source -> TContext -> TTuple -> Row -> Col -> Report.Report
5328toTTupleReport source context tuple startRow startCol =
5330 TTupleOpen row col ->
5331 case Code.whatIsNext source row col of
5332 Code.Keyword keyword ->
5334 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5335 region = toKeywordRegion row col keyword
5337 Report.Report "RESERVED WORD" region [] $
5338 Code.toSnippet source surroundings (Just region)
5341 "I ran into a reserved word unexpectedly:"
5344 "It looks like you are trying to use `" ++ keyword ++ "` as a variable name, but \
5345 \ it is a reserved word. Try using a different name!"
5350 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5351 region = toRegion row col
5353 Report.Report "UNFINISHED PARENTHESES" region [] $
5354 Code.toSnippet source surroundings (Just region)
5357 "I just saw an open parenthesis, so I was expecting to see a type next."
5360 ["Something","like",D.dullyellow "(Maybe Int)","or"
5361 ,D.dullyellow "(List Person)" <> "."
5362 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5366 TTupleEnd row col ->
5368 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5369 region = toRegion row col
5371 Report.Report "UNFINISHED PARENTHESES" region [] $
5372 Code.toSnippet source surroundings (Just region)
5375 "I was expecting to see a closing parenthesis next, but I got stuck here:"
5378 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]
5380 "I can get stuck when I run into keywords, operators, parentheses, or brackets\
5381 \ unexpectedly. So there may be some earlier syntax trouble (like extra parenthesis\
5382 \ or missing brackets) that is confusing me."
5386 TTupleType tipe row col ->
5387 toTypeReport source context tipe row col
5389 TTupleSpace space row col ->
5390 toSpaceReport source space row col
5392 TTupleIndentType1 row col ->
5394 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5395 region = toRegion row col
5397 Report.Report "UNFINISHED PARENTHESES" region [] $
5398 Code.toSnippet source surroundings (Just region)
5401 "I just saw an open parenthesis, so I was expecting to see a type next."
5405 ["Something","like",D.dullyellow "(Maybe Int)","or"
5406 ,D.dullyellow "(List Person)" <> "."
5407 ,"Anything","where","you","are","putting","parentheses","around","normal","types."
5410 "I can get confused by indentation in cases like this, so\
5411 \ maybe you have a type but it is not indented enough?"
5415 TTupleIndentTypeN row col ->
5417 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5418 region = toRegion row col
5420 Report.Report "UNFINISHED TUPLE TYPE" region [] $
5421 Code.toSnippet source surroundings (Just region)
5424 "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."
5428 ["A","tuple","type","looks","like",D.dullyellow "(Float,Float)","or"
5429 ,D.dullyellow "(String,Int)" <> ","
5430 ,"so","I","think","there","is","a","type","missing","here?"
5433 "I can get confused by indentation in cases like this, so\
5434 \ maybe you have an expression but it is not indented enough?"
5438 TTupleIndentEnd row col ->
5440 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5441 region = toRegion row col
5443 Report.Report "UNFINISHED PARENTHESES" region [] $
5444 Code.toSnippet source surroundings (Just region)
5447 "I was expecting to see a closing parenthesis next:"
5450 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps!"]
5452 "I can get confused by indentation in cases like this, so\
5453 \ 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