@@ -69,6 +69,9 @@ data Error
6969 | ModuleNameMismatch ModuleName.Raw (A.Located ModuleName.Raw)
7070 | UnexpectedPort A.Region
7171 | NoPorts A.Region
72+ | NoPortsInPackage (A.Located Name.Name)
73+ | NoPortModulesInPackage A.Region
74+ | NoEffectsOutsideKernel A.Region
7275 | ParseError Module
7376
7477
@@ -517,7 +520,7 @@ toReport source err =
517520 ,
518521 D.stack
519522 [ D.reflow $
520− "I need it to match the file path, so I was expecting it to see `"
523+ "I need it to match the file path, so I was expecting to see `"
521524 ++ ModuleName.toChars expectedName
522525 ++ "` here. Make the following change, and you should be all set!"
523526 , D.indent 4 $
@@ -561,10 +564,84 @@ toReport source err =
561564 ]
562565 )
563566
567+ NoPortsInPackage (A.At region _) ->
568+ Report.Report "PACKAGES CANNOT HAVE PORTS" region [] $
569+ Code.toSnippet source region Nothing
570+ (
571+ D.reflow $
572+ "Packages cannot declare any ports, so I am getting stuck here:"
573+ ,
574+ D.stack
575+ [ D.reflow $
576+ "Remove this port declaration."
577+ , noteForPortsInPackage
578+ ]
579+ )
580+
581+ NoPortModulesInPackage region ->
582+ Report.Report "PACKAGES CANNOT HAVE PORTS" region [] $
583+ Code.toSnippet source region Nothing
584+ (
585+ D.reflow $
586+ "Packages cannot declare any ports, so I am getting stuck here:"
587+ ,
588+ D.stack
589+ [ D.fillSep $
590+ ["Remove","the",D.cyan "port","keyword","and","I"
591+ ,"should","be","able","to","continue."
592+ ]
593+ , noteForPortsInPackage
594+ ]
595+ )
596+
597+ NoEffectsOutsideKernel region ->
598+ Report.Report "INVALID EFFECT MODULE" region [] $
599+ Code.toSnippet source region Nothing
600+ (
601+ D.reflow $
602+ "It is not possible to declare an `effect module` outside the @elm organization,\
603+ \ so I am getting stuck here:"
604+ ,
605+ D.stack
606+ [ D.reflow $
607+ "Switch to a normal module declaration."
608+ , D.toSimpleNote $
609+ "Effect modules are designed to allow certain core functionality to be\
610+ \ defined separately from the compiler. So the @elm organization has access to\
611+ \ this so that certain changes, extensions, and fixes can be introduced without\
612+ \ needing to release new Elm binaries. For example, we want to make it possible\
613+ \ to test effects, but this may require changes to the design of effect modules.\
614+ \ By only having them defined in the @elm organization, that kind of design work\
615+ \ can proceed much more smoothly."
616+ ]
617+ )
618+
564619 ParseError modul ->
565620 toParseErrorReport source modul
566621
567622
623+noteForPortsInPackage :: D.Doc
624+noteForPortsInPackage =
625+ D.stack
626+ [ D.toSimpleNote $
627+ "One of the major goals of the package ecosystem is to be completely written\
628+ \ in Elm. This means when you install an Elm package, you can be sure you are safe\
629+ \ from security issues on install and that you are not going to get any runtime\
630+ \ exceptions coming from your new dependency. This design also sets the ecosystem\
631+ \ up to target other platforms more easily (like mobile phones, WebAssembly, etc.)\
632+ \ since no community code explicitly depends on JavaScript even existing."
633+ , D.reflow $
634+ "Given that overall goal, allowing ports in packages would lead to some pretty\
635+ \ surprising behavior. If ports were allowed in packages, you could install a\
636+ \ package but not realize that it brings in an indirect dependency that defines a\
637+ \ port. Now you have a program that does not work and the fix is to realize that\
638+ \ some JavaScript needs to be added for a dependency you did not even know about.\
639+ \ That would be extremely frustrating! \"So why not allow the package author to\
640+ \ include the necessary JS code as well?\" Now we are back in conflict with our\
641+ \ overall goal to keep all community packages free from runtime exceptions."
642+ ]
643+
644+
568645toParseErrorReport :: Code.Source -> Module -> Report.Report
569646toParseErrorReport source modul =
570647 case modul of
@@ -572,64 +649,9 @@ toParseErrorReport source modul =
572649 toSpaceReport source space row col
573650
574651 ModuleBadEnd row col ->
575− case Code.whatIsNext source row col of
576− Code.Keyword keyword ->
577− let
578− region = toKeywordRegion row col keyword
579− in
580− Report.Report "RESERVED WORD" region [] $
581− Code.toSnippet source region Nothing
582− (
583− D.reflow $
584− "I got stuck on this reserved word:"
585− ,
586− D.reflow $
587− "The name `" ++ keyword ++ "` is reserved, so try using a different name?"
588− )
589−
590− Code.Operator op ->
591− let
592− region = toKeywordRegion row col op
593− in
594− Report.Report "UNEXPECTED SYMBOL" region [] $
595− Code.toSnippet source region Nothing
596− (
597− D.reflow $
598− "I ran into an unexpected symbol:"
599− ,
600− D.reflow $
601− "I was not expecting to see a " ++ op ++ " here. Try deleting it? Maybe\
602− \ I can give a better hint from there?"
603− )
604−
605− Code.Close term bracket ->
606− let
607− region = toRegion row col
608− in
609− Report.Report ("UNEXPECTED " ++ map Char.toUpper term) region [] $
610− Code.toSnippet source region Nothing
611− (
612− D.reflow $
613− "I ran into an unexpected " ++ term ++ ":"
614− ,
615− D.reflow $
616− "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
617− )
618−
619− Code.Other ->
620− let
621− region = toRegion row col
622− in
623− Report.Report "SYNTAX PROBLEM" region [] $
624− Code.toSnippet source region Nothing
625− (
626− D.reflow $
627− "I got stuck here:"
628− ,
629− D.reflow $
630− "Whatever I am running into is confusing me a lot! Normally I can give fairly\
631− \ specific hints, but something is really tripping me up this time."
632− )
652+ if col == 1
653+ then toDeclStartReport source row col
654+ else toWeirdEndReport source row col
633655
634656 ModuleProblem row col ->
635657 let
@@ -775,15 +797,15 @@ toParseErrorReport source modul =
775797 [ D.reflow $
776798 "I am not sure what is going on, but I recommend starting an Elm\
777799 \ file with the following lines:"
778− , D.vcat
800+ , D.indent 4 $ D.vcat $
779801 [ D.fillSep [D.cyan "import","Html"]
780802 , ""
781− , D.fillSep [D.green "main","="]
782− , D.indent 2 $ D.fillSep [D.cyan "Html" <> ".text",D.dullyellow "\"Hello!\""]
803+ , "main ="
804+ , " Html.text " <> D.dullyellow "\"Hello!\""
783805 ]
784806 , D.reflow $
785− "You should be able to copy those lines directly into your file. Check out\
786− \ some of the examples on https://elm-lang.org for more help getting started!"
807+ "You should be able to copy those lines directly into your file. Check out the\
808+ \ examples at <https://elm-lang.org/examples> for more help getting started!"
787809 , D.toSimpleNote $
788810 "This can also happen when something is indented too much!"
789811 ]
@@ -808,11 +830,12 @@ toParseErrorReport source modul =
808830 , D.indent 4 $ D.vcat $
809831 [ D.fillSep [D.cyan "import","Dict"]
810832 , D.fillSep [D.cyan "import","Maybe"]
811− , D.fillSep [D.cyan "import","Html.Attributes"]
812− , D.fillSep [D.cyan "import","Json.Decode"]
833+ , D.fillSep [D.cyan "import","Html.Attributes",D.cyan "as","A"]
834+ , D.fillSep [D.cyan "import","Json.Decode",D.cyan "exposing","(..)"]
813835 ]
814836 , D.reflow $
815837 "Notice that the module names all start with capital letters. That is required!"
838+ , D.reflowLink "Read" "imports" "to learn more."
816839 ]
817840 )
818841
@@ -823,7 +846,7 @@ toParseErrorReport source modul =
823846 let
824847 region = toRegion row col
825848 in
826− Report.Report "EXECTING IMPORT ALIAS" region [] $
849+ Report.Report "EXPECTING IMPORT ALIAS" region [] $
827850 Code.toSnippet source region Nothing
828851 (
829852 D.reflow $
@@ -839,6 +862,7 @@ toParseErrorReport source modul =
839862 ]
840863 , D.reflow $
841864 "Notice that the alias always starts with a capital letter. That is required!"
865+ , D.reflowLink "Read" "imports" "to learn more."
842866 ]
843867 )
844868
@@ -901,6 +925,192 @@ toParseErrorReport source modul =
901925
902926
903927
928+-- WEIRD END
929+
930+
931+toWeirdEndReport :: Code.Source -> Row -> Col -> Report.Report
932+toWeirdEndReport source row col =
933+ case Code.whatIsNext source row col of
934+ Code.Keyword keyword ->
935+ let
936+ region = toKeywordRegion row col keyword
937+ in
938+ Report.Report "RESERVED WORD" region [] $
939+ Code.toSnippet source region Nothing
940+ (
941+ D.reflow $
942+ "I got stuck on this reserved word:"
943+ ,
944+ D.reflow $
945+ "The name `" ++ keyword ++ "` is reserved, so try using a different name?"
946+ )
947+
948+ Code.Operator op ->
949+ let
950+ region = toKeywordRegion row col op
951+ in
952+ Report.Report "UNEXPECTED SYMBOL" region [] $
953+ Code.toSnippet source region Nothing
954+ (
955+ D.reflow $
956+ "I ran into an unexpected symbol:"
957+ ,
958+ D.reflow $
959+ "I was not expecting to see a " ++ op ++ " here. Try deleting it? Maybe\
960+ \ I can give a better hint from there?"
961+ )
962+
963+ Code.Close term bracket ->
964+ let
965+ region = toRegion row col
966+ in
967+ Report.Report ("UNEXPECTED " ++ map Char.toUpper term) region [] $
968+ Code.toSnippet source region Nothing
969+ (
970+ D.reflow $
971+ "I ran into an unexpected " ++ term ++ ":"
972+ ,
973+ D.reflow $
974+ "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
975+ )
976+
977+ Code.Lower c cs ->
978+ let
979+ region = toKeywordRegion row col (c:cs)
980+ in
981+ Report.Report "UNEXPECTED NAME" region [] $
982+ Code.toSnippet source region Nothing
983+ (
984+ D.reflow $
985+ "I got stuck on this name:"
986+ ,
987+ D.reflow $
988+ "It is confusing me a lot! Normally I can give fairly specific hints, but\
989+ \ something is really tripping me up this time."
990+ )
991+
992+ Code.Upper c cs ->
993+ let
994+ region = toKeywordRegion row col (c:cs)
995+ in
996+ Report.Report "UNEXPECTED NAME" region [] $
997+ Code.toSnippet source region Nothing
998+ (
999+ D.reflow $
1000+ "I got stuck on this name:"
1001+ ,
1002+ D.reflow $
1003+ "It is confusing me a lot! Normally I can give fairly specific hints, but\
1004+ \ something is really tripping me up this time."
1005+ )
1006+
1007+ Code.Other maybeChar ->
1008+ let
1009+ region = toRegion row col
1010+ in
1011+ case maybeChar of
1012+ Just ';' ->
1013+ Report.Report "UNEXPECTED SEMICOLON" region [] $
1014+ Code.toSnippet source region Nothing
1015+ (
1016+ D.reflow $
1017+ "I got stuck on this semicolon:"
1018+ ,
1019+ D.stack
1020+ [ D.reflow $ "Try removing it?"
1021+ , D.toSimpleNote $
1022+ "Some languages require semicolons at the end of each statement. These are\
1023+ \ often called C-like languages, and they usually share a lot of language design\
1024+ \ choices. (E.g. side-effects, for loops, etc.) Elm manages effects with commands\
1025+ \ and subscriptions instead, so there is no special syntax for \"statements\" and\
1026+ \ therefore no need to use semicolons to separate them. I think this will make\
1027+ \ more sense as you work through <https://guide.elm-lang.org> though!"
1028+ ]
1029+ )
1030+
1031+ Just ',' ->
1032+ Report.Report "UNEXPECTED COMMA" region [] $
1033+ Code.toSnippet source region Nothing
1034+ (
1035+ D.reflow $
1036+ "I got stuck on this comma:"
1037+ ,
1038+ D.stack
1039+ [ D.reflow $
1040+ "I do not think I am parsing a list or tuple right now. Try deleting the comma?"
1041+ , D.toSimpleNote $
1042+ "If this is supposed to be part of a list, the problem may be a bit earlier.\
1043+ \ Perhaps the opening [ is missing? Or perhaps some value in the list has an extra\
1044+ \ closing ] that is making me think the list ended earlier? The same kinds of\
1045+ \ things could be going wrong if this is supposed to be a tuple."
1046+ ]
1047+ )
1048+
1049+ Just '`' ->
1050+ Report.Report "UNEXPECTED CHARACTER" region [] $
1051+ Code.toSnippet source region Nothing
1052+ (
1053+ D.reflow $
1054+ "I got stuck on this character:"
1055+ ,
1056+ D.stack
1057+ [ D.reflow $
1058+ "It is not used for anything in Elm syntax. It is used for multi-line strings in\
1059+ \ some languages though, so if you want a string that spans multiple lines, you\
1060+ \ can use Elm's multi-line string syntax like this:"
1061+ , D.dullyellow $ D.indent 4 $ D.vcat $
1062+ [ "\"\"\""
1063+ , "# Multi-line Strings"
1064+ , ""
1065+ , "- start with triple double quotes"
1066+ , "- write whatever you want"
1067+ , "- no need to escape newlines or double quotes"
1068+ , "- end with triple double quotes"
1069+ , "\"\"\""
1070+ ]
1071+ , D.reflow $
1072+ "Otherwise I do not know what is going on! Try removing the character?"
1073+ ]
1074+ )
1075+
1076+ Just '$' ->
1077+ Report.Report "UNEXPECTED SYMBOL" region [] $
1078+ Code.toSnippet source region Nothing
1079+ (
1080+ D.reflow $
1081+ "I got stuck on this dollar sign:"
1082+ ,
1083+ D.reflow $
1084+ "It is not used for anything in Elm syntax. Are you coming from a language where\
1085+ \ dollar signs can be used in variable names? If so, try a name that (1) starts\
1086+ \ with a letter and (2) only contains letters, numbers, and underscores."
1087+ )
1088+
1089+ Just c | elem c ['#','@','!','%','~'] ->
1090+ Report.Report "UNEXPECTED SYMBOL" region [] $
1091+ Code.toSnippet source region Nothing
1092+ (
1093+ D.reflow $
1094+ "I got stuck on this symbol:"
1095+ ,
1096+ D.reflow $
1097+ "It is not used for anything in Elm syntax. Try removing it?"
1098+ )
1099+
1100+ _ ->
1101+ Report.Report "SYNTAX PROBLEM" region [] $
1102+ Code.toSnippet source region Nothing
1103+ (
1104+ D.reflow $
1105+ "I got stuck here:"
1106+ ,
1107+ D.reflow $
1108+ "Whatever I am running into is confusing me a lot! Normally I can give fairly\
1109+ \ specific hints, but something is really tripping me up this time."
1110+ )
1111+
1112+
1113+
9041114-- IMPORTS
9051115
9061116
@@ -926,6 +1136,7 @@ toImportReport source row col =
9261136 ]
9271137 , D.reflow $
9281138 "You are probably trying to import a different module, but try to make it look like one of these examples!"
1139+ , D.reflowLink "Read" "imports" "to learn more."
9291140 ]
9301141 )
9311142
@@ -1232,106 +1443,7 @@ toDeclarationsReport :: Code.Source -> Decl -> Report.Report
12321443toDeclarationsReport source decl =
12331444 case decl of
12341445 DeclStart row col ->
1235− case Code.whatIsNext source row col of
1236− Code.Close term bracket ->
1237− let
1238− region = toRegion row col
1239− in
1240− Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
1241− Code.toSnippet source region Nothing
1242− (
1243− D.reflow $
1244− "I was not expecting to see a " ++ term ++ " here:"
1245− , D.reflow $
1246− "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
1247− )
1248−
1249− Code.Keyword keyword ->
1250− let
1251− region = toKeywordRegion row col keyword
1252− in
1253− Report.Report "RESERVED WORD" region [] $
1254− Code.toSnippet source region Nothing
1255− (
1256− D.reflow $
1257− "I was not expecting to run into the `" ++ keyword ++ "` keyword here:"
1258− ,
1259− case keyword of
1260− "import" ->
1261− D.reflow $
1262− "It is reserved for declaring imports at the top of your module. If you want\
1263− \ another import, try moving it up top with the other imports. If you want to\
1264− \ define a value or function, try changing the name to something else!"
1265−
1266− "case" ->
1267− D.stack
1268− [ D.reflow $
1269− "It is reserved for writing `case` expressions. Try using a different name?"
1270− , D.toSimpleNote $
1271− "If you are trying to write a `case` expression, it needs to be part of a\
1272− \ definition. So you could write something like this instead:"
1273− , D.vcat $
1274− [ D.indent 0 $ D.fillSep [D.green "getWidth","maybeWidth","="]
1275− , D.indent 2 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
1276− , D.indent 4 $ D.fillSep [D.blue "Just","width","->"]
1277− , D.indent 6 $ D.fillSep ["width","+",D.dullyellow "200"]
1278− , ""
1279− , D.indent 4 $ D.fillSep [D.blue "Nothing","->"]
1280− , D.indent 6 $ D.fillSep [D.dullyellow "400"]
1281− ]
1282− , D.reflow $
1283− "This defines a `getWidth` function that we can use elsewhere in our program."
1284− ]
1285−
1286− "if" ->
1287− D.stack
1288− [ D.reflow $
1289− "It is reserved for writing `if` expressions. Try using a different name?"
1290− , D.toSimpleNote $
1291− "If you are trying to write an `if` expression, it needs to be part of a\
1292− \ definition. So you could write something like this instead:"
1293− , D.vcat $
1294− [ D.indent 0 $ D.fillSep [D.green "reviewPowerLevel","powerLevel","="]
1295− , D.indent 2 $ D.fillSep $
1296− [D.cyan "if","powerLevel",">",D.dullyellow "9000"
1297− ,D.cyan "then",D.dullyellow "\"OVER 9000!!!\""
1298− ,D.cyan "else",D.dullyellow "\"not bad\""
1299− ]
1300− ]
1301− , D.reflow $
1302− "This defines a `reviewPowerLevel` function that we can use elsewhere in our program."
1303− ]
1304−
1305− _ ->
1306− D.reflow $
1307− "It is a reserved word. Try changing the name to something else?"
1308− )
1309−
1310− _ ->
1311− let
1312− region = toRegion row col
1313− in
1314− Report.Report "SYNTAX PROBLEM" region [] $
1315− Code.toSnippet source region Nothing
1316− (
1317− D.reflow $
1318− "I was expecting to see a new declaration here:"
1319− ,
1320− D.stack
1321− [ D.reflow $
1322− "I am not sure what is going wrong exactly, but here are a couple valid\
1323− \ declarations for reference:"
1324− , D.vcat
1325− [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1326− , D.fillSep [D.green "add","x","y","="]
1327− , D.fillSep [" ","x","+","y"]
1328− ]
1329− , D.fillSep [D.cyan "type",D.green "User","=","Anonymous","|","LoggedIn String"]
1330− , D.reflow $
1331− "Note that all declarations start with lower-case letters in Elm. Capitalization\
1332− \ makes a difference, so be consious of that if you are working from examples!"
1333− ]
1334− )
1446+ toDeclStartReport source row col
13351447
13361448 DeclSpace space row col ->
13371449 toSpaceReport source space row col
@@ -1361,6 +1473,165 @@ toDeclarationsReport source decl =
13611473 )
13621474
13631475
1476+toDeclStartReport :: Code.Source -> Row -> Col -> Report.Report
1477+toDeclStartReport source row col =
1478+ case Code.whatIsNext source row col of
1479+ Code.Close term bracket ->
1480+ let
1481+ region = toRegion row col
1482+ in
1483+ Report.Report ("STRAY " ++ map Char.toUpper term) region [] $
1484+ Code.toSnippet source region Nothing
1485+ (
1486+ D.reflow $
1487+ "I was not expecting to see a " ++ term ++ " here:"
1488+ , D.reflow $
1489+ "This " ++ bracket : " does not match up with an earlier open " ++ term ++ ". Try deleting it?"
1490+ )
1491+
1492+ Code.Keyword keyword ->
1493+ let
1494+ region = toKeywordRegion row col keyword
1495+ in
1496+ Report.Report "RESERVED WORD" region [] $
1497+ Code.toSnippet source region Nothing
1498+ (
1499+ D.reflow $
1500+ "I was not expecting to run into the `" ++ keyword ++ "` keyword here:"
1501+ ,
1502+ case keyword of
1503+ "import" ->
1504+ D.reflow $
1505+ "It is reserved for declaring imports at the top of your module. If you want\
1506+ \ another import, try moving it up top with the other imports. If you want to\
1507+ \ define a value or function, try changing the name to something else!"
1508+
1509+ "case" ->
1510+ D.stack
1511+ [ D.reflow $
1512+ "It is reserved for writing `case` expressions. Try using a different name?"
1513+ , D.toSimpleNote $
1514+ "If you are trying to write a `case` expression, it needs to be part of a\
1515+ \ definition. So you could write something like this instead:"
1516+ , D.indent 4 $ D.vcat $
1517+ [ D.indent 0 $ D.fillSep ["getWidth","maybeWidth","="]
1518+ , D.indent 2 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
1519+ , D.indent 4 $ D.fillSep [D.blue "Just","width","->"]
1520+ , D.indent 6 $ D.fillSep ["width","+",D.dullyellow "200"]
1521+ , ""
1522+ , D.indent 4 $ D.fillSep [D.blue "Nothing","->"]
1523+ , D.indent 6 $ D.fillSep [D.dullyellow "400"]
1524+ ]
1525+ , D.reflow $
1526+ "This defines a `getWidth` function that you can use elsewhere in your program."
1527+ ]
1528+
1529+ "if" ->
1530+ D.stack
1531+ [ D.reflow $
1532+ "It is reserved for writing `if` expressions. Try using a different name?"
1533+ , D.toSimpleNote $
1534+ "If you are trying to write an `if` expression, it needs to be part of a\
1535+ \ definition. So you could write something like this instead:"
1536+ , D.indent 4 $ D.vcat $
1537+ [ "greet name ="
1538+ , D.fillSep $
1539+ [" "
1540+ ,D.cyan "if","name","==",D.dullyellow "\"Abraham Lincoln\""
1541+ ,D.cyan "then",D.dullyellow "\"Greetings Mr. President.\""
1542+ ,D.cyan "else",D.dullyellow "\"Hey!\""
1543+ ]
1544+ ]
1545+ , D.reflow $
1546+ "This defines a `reviewPowerLevel` function that you can use elsewhere in your program."
1547+ ]
1548+
1549+ _ ->
1550+ D.reflow $
1551+ "It is a reserved word. Try changing the name to something else?"
1552+ )
1553+
1554+ Code.Upper c cs ->
1555+ let
1556+ region = toRegion row col
1557+ in
1558+ Report.Report "UNEXPECTED CAPITAL LETTER" region [] $
1559+ Code.toSnippet source region Nothing
1560+ (
1561+ D.reflow $
1562+ "Declarations always start with a lower-case letter, so I am getting stuck here:"
1563+ ,
1564+ D.stack
1565+ [ D.fillSep $
1566+ ["Try","a","name","like"
1567+ ,D.green (D.fromChars (Char.toLower c : cs))
1568+ ,"instead?"
1569+ ]
1570+ , D.toSimpleNote $
1571+ "Here are a couple valid declarations for reference:"
1572+ , D.indent 4 $ D.vcat $
1573+ [ "greet : String -> String"
1574+ , "greet name ="
1575+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
1576+ , ""
1577+ , D.cyan "type" <> " User = Anonymous | LoggedIn String"
1578+ ]
1579+ , D.reflow $
1580+ "Notice that they always start with a lower-case letter. Capitalization matters!"
1581+ ]
1582+ )
1583+
1584+ Code.Other (Just char) | elem char ['(', '{', '[', '+', '-', '*', '/', '^', '&', '|', '"', '\'', '!', '@', '#', '$', '%'] ->
1585+ let
1586+ region = toRegion row col
1587+ in
1588+ Report.Report "UNEXPECTED SYMBOL" region [] $
1589+ Code.toSnippet source region Nothing
1590+ (
1591+ D.reflow $
1592+ "I am getting stuck because this line starts with the " ++ [char] ++ " symbol:"
1593+ ,
1594+ D.stack
1595+ [ D.reflow $
1596+ "When a line has no spaces at the beginning, I expect it to be a declaration like one of these:"
1597+ , D.indent 4 $ D.vcat $
1598+ [ "greet : String -> String"
1599+ , "greet name ="
1600+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
1601+ , ""
1602+ , D.cyan "type" <> " User = Anonymous | LoggedIn String"
1603+ ]
1604+ , D.reflow $
1605+ "If this is not supposed to be a declaration, try adding some spaces before it?"
1606+ ]
1607+ )
1608+
1609+ _ ->
1610+ let
1611+ region = toRegion row col
1612+ in
1613+ Report.Report "WEIRD DECLARATION" region [] $
1614+ Code.toSnippet source region Nothing
1615+ (
1616+ D.reflow $
1617+ "I am trying to parse a declaration, but I am getting stuck here:"
1618+ ,
1619+ D.stack
1620+ [ D.reflow $
1621+ "When a line has no spaces at the beginning, I expect it to be a declaration like one of these:"
1622+ , D.indent 4 $ D.vcat $
1623+ [ "greet : String -> String"
1624+ , "greet name ="
1625+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
1626+ , ""
1627+ , D.cyan "type" <> " User = Anonymous | LoggedIn String"
1628+ ]
1629+ , D.reflow $
1630+ "Try to make your declaration look like one of those? Or if this is not\
1631+ \ supposed to be a declaration, try adding some spaces before it?"
1632+ ]
1633+ )
1634+
13641635
13651636-- PORT
13661637
@@ -1487,7 +1758,7 @@ toPortReport source port_ startRow startCol =
14871758 [ D.reflow $
14881759 "I was expecting to see a type next. Here are examples of outgoing and\
14891760 \ incoming ports for reference:"
1490− , D.vcat
1761+ , D.indent 4 $ D.vcat $
14911762 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
14921763 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
14931764 ]
@@ -1506,7 +1777,7 @@ portNote =
15061777 D.stack
15071778 [ D.toSimpleNote $
15081779 "Here are some example `port` declarations for reference:"
1509− , D.vcat
1780+ , D.indent 4 $ D.vcat $
15101781 [ D.fillSep [D.cyan "port","send",":","String -> Cmd msg"]
15111782 , D.fillSep [D.cyan "port","receive",":","(String -> msg) -> Sub msg"]
15121783 ]
@@ -1636,7 +1907,7 @@ toTypeAliasReport source typeAlias startRow startCol =
16361907 ,
16371908 D.stack
16381909 [ D.reflow $
1639− "I was expecting to see a type variable or an an equals sign next."
1910+ "I was expecting to see a type variable or an equals sign next."
16401911 , typeAliasNote
16411912 ]
16421913 )
@@ -1657,7 +1928,7 @@ toTypeAliasReport source typeAlias startRow startCol =
16571928 ,
16581929 D.stack
16591930 [ D.reflow $
1660− "I was expecting to see a type variable or an an equals sign next."
1931+ "I was expecting to see a type variable or an equals sign next."
16611932 , typeAliasNote
16621933 ]
16631934 )
@@ -1689,8 +1960,8 @@ typeAliasNote =
16891960 [ D.toSimpleNote $
16901961 "Here is an example of a valid `type alias` for reference:"
16911962 , D.vcat $
1692− [ D.indent 0 $ D.fillSep [D.cyan "type",D.cyan "alias",D.green "Person","="]
1693− , D.indent 2 $ D.vcat $
1963+ [ D.indent 4 $ D.fillSep [D.cyan "type",D.cyan "alias","Person","="]
1964+ , D.indent 6 $ D.vcat $
16941965 ["{ name : String"
16951966 ,", age : Int"
16961967 ,", height : Float"
@@ -1764,7 +2035,7 @@ toCustomTypeReport source customType startRow startCol =
17642035 ,
17652036 D.stack
17662037 [ D.reflow $
1767− "I was expecting to see a type variable or an an equals sign next."
2038+ "I was expecting to see a type variable or an equals sign next."
17682039 , customTypeNote
17692040 ]
17702041 )
@@ -1824,7 +2095,7 @@ toCustomTypeReport source customType startRow startCol =
18242095 ,
18252096 D.stack
18262097 [ D.reflow $
1827− "I was expecting to see a type variable or an an equals sign next."
2098+ "I was expecting to see a type variable or an equals sign next."
18282099 , customTypeNote
18292100 ]
18302101 )
@@ -1890,10 +2161,10 @@ customTypeNote =
18902161 [ D.toSimpleNote $
18912162 "Here is an example of a valid `type` declaration for reference:"
18922163 , D.vcat $
1893− [ D.indent 0 $ D.fillSep [D.cyan "type",D.green "Status"]
1894− , D.indent 2 $ D.fillSep ["=","Failure"]
1895− , D.indent 2 $ D.fillSep ["|","Waiting"]
1896− , D.indent 2 $ D.fillSep ["|","Success","String"]
2164+ [ D.indent 4 $ D.fillSep [D.cyan "type","Status"]
2165+ , D.indent 6 $ D.fillSep ["=","Failure"]
2166+ , D.indent 6 $ D.fillSep ["|","Waiting"]
2167+ , D.indent 6 $ D.fillSep ["|","Success","String"]
18972168 ]
18982169 , D.reflow $
18992170 "This defines a new `Status` type with three variants. This could be useful if\
@@ -1924,11 +2195,55 @@ toDeclDefReport source name declDef startRow startCol =
19242195 Report.Report "RESERVED WORD" region [] $
19252196 Code.toSnippet source surroundings (Just region)
19262197 (
1927− D.reflow $
1928− "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
2198+ D.fillSep
2199+ ["The","name"
2200+ ,"`" <> D.cyan (D.fromChars keyword) <> "`"
2201+ ,"is","reserved","in","Elm,","so","it","cannot"
2202+ ,"be","used","as","an","argument","here:"
2203+ ]
19292204 ,
2205+ D.stack
2206+ [ D.reflow $
2207+ "Try renaming it to something else."
2208+ , case keyword of
2209+ "as" ->
2210+ D.toFancyNote
2211+ ["This","keyword","is","reserved","for","pattern","matches","like"
2212+ ,"((x,y)",D.cyan "as","point)","where","you","want","to","name","a","tuple","and"
2213+ ,"the","values","it","contains."
2214+ ]
2215+
2216+ _ ->
2217+ D.toSimpleNote $
2218+ "The `" ++ keyword ++ "` keyword has a special meaning in Elm, so it can only be used in certain situations."
2219+ ]
2220+ )
2221+
2222+ Code.Operator "->" ->
2223+ let
2224+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2225+ region = toWiderRegion row col 2
2226+ in
2227+ Report.Report "MISSING COLON?" region [] $
2228+ Code.toSnippet source surroundings (Just region)
2229+ (
19302230 D.reflow $
1931− "This is a reserved word! Try using some other name?"
2231+ "I was not expecting to see an arrow here:"
2232+ ,
2233+ D.stack
2234+ [ D.fillSep
2235+ ["This","usually","means","a",D.green ":","is","missing","a","bit","earlier","in"
2236+ ,"a","type","annotation.","It","could","be","something","else","though,","so"
2237+ ,"here","is","a","valid","definition","for","reference:"
2238+ ]
2239+ , D.indent 4 $ D.vcat $
2240+ [ "greet : String -> String"
2241+ , "greet name ="
2242+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
2243+ ]
2244+ , D.reflow $
2245+ "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
2246+ ]
19322247 )
19332248
19342249 Code.Operator op ->
@@ -1946,10 +2261,10 @@ toDeclDefReport source name declDef startRow startCol =
19462261 [ D.reflow $
19472262 "I am not sure what is going wrong exactly, so here is a valid\
19482263 \ definition (with an optional type annotation) for reference:"
1949− , D.vcat
1950− [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1951− , D.fillSep [D.green "add","x","y","="]
1952− , D.fillSep [" ","x","+","y"]
2264+ , D.indent 4 $ D.vcat $
2265+ [ "greet : String -> String"
2266+ , "greet name ="
2267+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
19532268 ]
19542269 , D.reflow $
19552270 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
@@ -1971,10 +2286,10 @@ toDeclDefReport source name declDef startRow startCol =
19712286 [ D.reflow $
19722287 "I am not sure what is going wrong exactly, so here is a valid\
19732288 \ definition (with an optional type annotation) for reference:"
1974− , D.vcat
1975− [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
1976− , D.fillSep [D.green "add","x","y","="]
1977− , D.fillSep [" ","x","+","y"]
2289+ , D.indent 4 $ D.vcat $
2290+ [ "greet : String -> String"
2291+ , "greet name ="
2292+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
19782293 ]
19792294 , D.reflow $
19802295 "Try to use that format!"
@@ -2089,10 +2404,10 @@ declDefNote =
20892404 D.stack
20902405 [ D.reflow $
20912406 "Here is a valid definition (with a type annotation) for reference:"
2092− , D.vcat
2093− [ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2094− , D.fillSep [D.green "add","x","y","="]
2095− , D.fillSep [" ","x","+","y"]
2407+ , D.indent 4 $ D.vcat $
2408+ [ "greet : String -> String"
2409+ , "greet name ="
2410+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
20962411 ]
20972412 , D.reflow $
20982413 "The top line (called a \"type annotation\") is optional. You can leave it off\
@@ -2204,25 +2519,40 @@ toExprReport source context expr startRow startCol =
22042519 )
22052520
22062521 OperatorRight op row col ->
2207− let region = toRegion row col in
2522+ let
2523+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
2524+ region = toRegion row col
2525+ isMath = elem op ["-","+","*","/","^"]
2526+ in
22082527 Report.Report "MISSING EXPRESSION" region [] $
2209− Code.toSnippet source region Nothing
2528+ Code.toSnippet source surroundings (Just region)
22102529 (
22112530 D.reflow $
2212− "I was expecting to see an expression after this " ++ Name.toChars op ++ " operator:"
2531+ "I just saw a " ++ Name.toChars op ++ " "
2532+ ++ (if isMath then "sign" else "operator")
2533+ ++ ", so I am getting stuck here:"
22132534 ,
2214− D.stack
2215− [ D.fillSep $
2216− ["You","can","just","put","anything","for","now,","like"
2217− ,D.dullyellow "42","or",D.dullyellow"\"hello\"" <> "."
2218− ,"Once","there","is","something","there,","I","can","probably"
2219− ,"give","a","more","specific","hint!"
2220− ]
2221− , D.toSimpleNote $
2222− "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2223− \ Or if I run into operators in unexpected spots. Point is, there are a\
2224− \ couple ways I can get confused and give sort of weird advice!"
2225− ]
2535+ if isMath then
2536+ D.fillSep
2537+ ["I","was","expecting","to","see","an","expression","next."
2538+ ,"Something","like",D.dullyellow "42","or",D.dullyellow "1000"
2539+ ,"that","makes","sense","with","a",D.fromName op,"sign."
2540+ ]
2541+ else if op == "&&" || op == "||" then
2542+ D.fillSep
2543+ ["I","was","expecting","to","see","an","expression","next."
2544+ ,"Something","like",D.dullyellow "True","or",D.dullyellow "False"
2545+ ,"that","makes","sense","with","boolean","logic."
2546+ ]
2547+ else if op == "|>" then
2548+ D.reflow $
2549+ "I was expecting to see a function next."
2550+ else if op == "<|" then
2551+ D.reflow $
2552+ "I was expecting to see an argument next."
2553+ else
2554+ D.reflow $
2555+ "I was expecting to see an expression next."
22262556 )
22272557
22282558 OperatorReserved operator row col ->
@@ -2243,7 +2573,6 @@ toExprReport source context expr startRow startCol =
22432573 InNode NElse r c _ -> (r, c, "an `if` expression")
22442574 InNode NCase r c _ -> (r, c, "a `case` expression")
22452575 InNode NBranch r c _ -> (r, c, "a `case` expression")
2246− -- TODO check if this is actually the best way to get error messages here
22472576
22482577 surroundings = A.Region (A.Position contextRow contextCol) (A.Position row col)
22492578 region = toRegion row col
@@ -2262,7 +2591,7 @@ toExprReport source context expr startRow startCol =
22622591 ,"give","a","more","specific","hint!"
22632592 ]
22642593 , D.toSimpleNote $
2265− "This can also happen if run into reserved words like `let` or `as` unexpectedly.\
2594+ "This can also happen if I run into reserved words like `let` or `as` unexpectedly.\
22662595 \ Or if I run into operators in unexpected spots. Point is, there are a\
22672596 \ couple ways I can get confused and give sort of weird advice!"
22682597 ]
@@ -2408,7 +2737,19 @@ toStringReport source string row col =
24082737 ,"quotes","on","each","end.","Is","the","closing","double"
24092738 ,"quote","missing","in","your","code?"
24102739 ]
2411− , D.link "Note" "Read" "TODO" "if you want a string that spans multiple lines."
2740+ , D.toSimpleNote $
2741+ "For a string that spans multiple lines, you can use the multi-line string\
2742+ \ syntax like this:"
2743+ , D.dullyellow $ D.indent 4 $ D.vcat $
2744+ [ "\"\"\""
2745+ , "# Multi-line Strings"
2746+ , ""
2747+ , "- start with triple double quotes"
2748+ , "- write whatever you want"
2749+ , "- no need to escape newlines or double quotes"
2750+ , "- end with triple double quotes"
2751+ , "\"\"\""
2752+ ]
24122753 ]
24132754 )
24142755
@@ -2424,7 +2765,18 @@ toStringReport source string row col =
24242765 ,
24252766 D.stack
24262767 [ D.reflow "Add a \"\"\" somewhere after this to end the string."
2427− , D.link "Hint" "Read" "TODO" "for more information on strings and multi-line strings."
2768+ , D.toSimpleNote $
2769+ "Here is a valid multi-line string for reference:"
2770+ , D.dullyellow $ D.indent 4 $ D.vcat $
2771+ [ "\"\"\""
2772+ , "# Multi-line Strings"
2773+ , ""
2774+ , "- start with triple double quotes"
2775+ , "- write whatever you want"
2776+ , "- no need to escape newlines or double quotes"
2777+ , "- end with triple double quotes"
2778+ , "\"\"\""
2779+ ]
24282780 ]
24292781 )
24302782
@@ -2657,33 +3009,41 @@ toOperatorReport source context operator row col =
26573009 in
26583010 Report.Report "UNEXPECTED ARROW" region [] $
26593011 Code.toSnippet source region Nothing $
2660− if isWithin NBranch context then
3012+ if isWithin NCase context then
26613013 (
26623014 D.reflow $
2663− "I was not expecting to see an arrow here:"
3015+ "I am parsing a `case` expression right now, but this arrow is confusing me:"
26643016 ,
26653017 D.stack
2666− [
2667− D.reflow $
2668− "I think I am parsing a `case` expression right now, so it makes sense to\
2669− \ see arrows around here. This one is confusing me though!"
2670− ,
2671− D.toSimpleHint $
2672− "I may be getting confused by the indentation. Every pattern in a `case` must be\
2673− \ exactly aligned (with exactly the same amount of indentation) so maybe this arrow\
2674− \ appears after the next `case` pattern (correctly!) but the pattern itself is\
2675− \ indented too far?"
3018+ [ D.reflow "Maybe the `of` keyword is missing on a previous line?"
3019+ , noteForCaseError
26763020 ]
26773021 )
26783022
2679− else
3023+ else if isWithin NBranch context then
26803024 (
26813025 D.reflow $
2682− "I was not expecting an arrow here:"
3026+ "I am parsing a `case` expression right now, but this arrow is confusing me:"
26833027 ,
3028+ D.stack
3029+ [ D.reflow $
3030+ "It makes sense to see arrows around here, so I suspect it is something earlier. Maybe this pattern is indented a bit farther than the previous patterns?"
3031+ , noteForCaseIndentError
3032+ ]
3033+ )
3034+
3035+ else
3036+ (
26843037 D.reflow $
2685− "Arrows should only appear in `case` expressions and anonymous functions. Maybe\
2686− \ you want > or >= instead?"
3038+ "I was partway through parsing an expression when I got stuck on this arrow:"
3039+ ,
3040+ D.stack
3041+ [ "Arrows should only appear in `case` expressions and anonymous functions.\n\
3042+ \Maybe it was supposed to be a > sign instead?"
3043+ , D.toSimpleNote $
3044+ "The syntax for anonymous functions is (\\x -> x + 1) so the arguments all appear\
3045+ \ after the backslash and before the arrow. Maybe a backslash is missing earlier?"
3046+ ]
26873047 )
26883048
26893049 BadEquals ->
@@ -2810,7 +3170,7 @@ toLetReport source context let_ startRow startCol =
28103170 , D.toSimpleNote $
28113171 "This can also happen if you are trying to define another value within the `let` but\
28123172 \ it is not indented enough. Make sure each definition has exactly the same amount of\
2813− \ spaces before it. The should line up exactly!"
3173+ \ spaces before it. They should line up exactly!"
28143174 ]
28153175 )
28163176
@@ -2880,8 +3240,8 @@ toUnfinishLetReport source row col startRow startCol message =
28803240 [ message
28813241 , D.toSimpleNote $
28823242 "Here is an example with a valid `let` expression for reference:"
2883− , D.vcat $
2884− [ D.indent 0 $ D.fillSep [D.green "viewPerson","person","="]
3243+ , D.indent 4 $ D.vcat $
3244+ [ D.indent 0 $ D.fillSep ["viewPerson","person","="]
28853245 , D.indent 2 $ D.fillSep [D.cyan "let"]
28863246 , D.indent 4 $ D.fillSep ["fullName","="]
28873247 , D.indent 6 $ D.fillSep ["person.firstName","++",D.dullyellow "\" \"","++","person.lastName"]
@@ -2958,11 +3318,55 @@ toLetDefReport source name def startRow startCol =
29583318 Report.Report "RESERVED WORD" region [] $
29593319 Code.toSnippet source surroundings (Just region)
29603320 (
2961− D.reflow $
2962− "It looks like you are trying to use `" ++ keyword ++ "` as an argument:"
3321+ D.fillSep
3322+ ["The","name"
3323+ ,"`" <> D.cyan (D.fromChars keyword) <> "`"
3324+ ,"is","reserved","in","Elm,","so","it","cannot"
3325+ ,"be","used","as","an","argument","here:"
3326+ ]
29633327 ,
3328+ D.stack
3329+ [ D.reflow $
3330+ "Try renaming it to something else."
3331+ , case keyword of
3332+ "as" ->
3333+ D.toFancyNote
3334+ ["This","keyword","is","reserved","for","pattern","matches","like"
3335+ ,"((x,y)",D.cyan "as","point)","where","you","want","to","name","a","tuple","and"
3336+ ,"the","values","it","contains."
3337+ ]
3338+
3339+ _ ->
3340+ D.toSimpleNote $
3341+ "The `" ++ keyword ++ "` keyword has a special meaning in Elm, so it can only be used in certain situations."
3342+ ]
3343+ )
3344+
3345+ Code.Operator "->" ->
3346+ let
3347+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3348+ region = toWiderRegion row col 2
3349+ in
3350+ Report.Report "MISSING COLON?" region [] $
3351+ Code.toSnippet source surroundings (Just region)
3352+ (
29643353 D.reflow $
2965− "This is a reserved word! Try using some other name?"
3354+ "I was not expecting to see an arrow here:"
3355+ ,
3356+ D.stack
3357+ [ D.fillSep
3358+ ["This","usually","means","a",D.green ":","is","missing","a","bit","earlier","in"
3359+ ,"a","type","annotation.","It","could","be","something","else","though,","so"
3360+ ,"here","is","a","valid","definition","for","reference:"
3361+ ]
3362+ , D.indent 4 $ D.vcat $
3363+ [ "greet : String -> String"
3364+ , "greet name ="
3365+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
3366+ ]
3367+ , D.reflow $
3368+ "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
3369+ ]
29663370 )
29673371
29683372 Code.Operator op ->
@@ -2980,10 +3384,10 @@ toLetDefReport source name def startRow startCol =
29803384 [ D.reflow $
29813385 "I am not sure what is going wrong exactly, so here is a valid\
29823386 \ definition (with an optional type annotation) for reference:"
2983− , D.vcat
2984− [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
2985− , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
2986− , D.indent 6 $ D.fillSep ["x","+","y"]
3387+ , D.indent 4 $ D.vcat $
3388+ [ "greet : String -> String"
3389+ , "greet name ="
3390+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
29873391 ]
29883392 , D.reflow $
29893393 "Try to use that format with your `" ++ Name.toChars name ++ "` definition!"
@@ -3005,10 +3409,10 @@ toLetDefReport source name def startRow startCol =
30053409 [ D.reflow $
30063410 "I am not sure what is going wrong exactly, so here is a valid\
30073411 \ definition (with an optional type annotation) for reference:"
3008− , D.vcat
3009− [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3010− , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3011− , D.indent 4 $ D.fillSep ["x","+","y"]
3412+ , D.indent 4 $ D.vcat $
3413+ [ "greet : String -> String"
3414+ , "greet name ="
3415+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
30123416 ]
30133417 , D.reflow $
30143418 "Try to use that format!"
@@ -3098,10 +3502,10 @@ defNote =
30983502 D.stack
30993503 [ D.reflow $
31003504 "Here is a valid definition (with a type annotation) for reference:"
3101− , D.vcat
3102− [ D.indent 4 $ D.fillSep [D.green "add",":","Int","->","Int","->","Int"]
3103− , D.indent 4 $ D.fillSep [D.green "add","x","y","="]
3104− , D.indent 6 $ D.fillSep ["x","+","y"]
3505+ , D.indent 4 $ D.vcat $
3506+ [ "greet : String -> String"
3507+ , "greet name ="
3508+ , " " <> D.dullyellow "\"Hello \"" <> " ++ name ++ " <> D.dullyellow "\"!\""
31053509 ]
31063510 , D.reflow $
31073511 "The top line (called a \"type annotation\") is optional. You can leave it off\
@@ -3264,9 +3668,10 @@ toCaseReport source context case_ startRow startCol =
32643668 D.reflow $
32653669 "I am partway through parsing a `case` expression, but I got stuck here:"
32663670 ,
3267− addNoteForCaseIndentError $
3268− D.reflow $
3269− "I was expecting to see an arrow next."
3671+ D.stack
3672+ [ D.reflow "I was expecting to see an arrow next."
3673+ , noteForCaseIndentError
3674+ ]
32703675 )
32713676
32723677 CaseExpr expr row col ->
@@ -3320,28 +3725,33 @@ toUnfinishCaseReport source row col startRow startCol message =
33203725 ,
33213726 D.stack
33223727 [ message
3323− , D.toSimpleNote $
3324− "Here is an example of a valid `case` expression for reference."
3325− , D.vcat $
3326− [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3327− , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3328− , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3329− , ""
3330− , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3331− , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3332− ]
3333− , D.reflow $
3334− "Notice the indentation. Each pattern is aligned, and each branch is indented\
3335− \ a bit more than the corresponding pattern. That is important!"
3728+ , noteForCaseError
33363729 ]
33373730 )
33383731
33393732
3340−addNoteForCaseIndentError :: D.Doc -> D.Doc
3341−addNoteForCaseIndentError message =
3342− D.stack $
3343− message
3344− :
3733+noteForCaseError :: D.Doc
3734+noteForCaseError =
3735+ D.stack
3736+ [ D.toSimpleNote $
3737+ "Here is an example of a valid `case` expression for reference."
3738+ , D.vcat $
3739+ [ D.indent 4 $ D.fillSep [D.cyan "case","maybeWidth",D.cyan "of"]
3740+ , D.indent 6 $ D.fillSep [D.blue "Just","width","->"]
3741+ , D.indent 8 $ D.fillSep ["width","+",D.dullyellow "200"]
3742+ , ""
3743+ , D.indent 6 $ D.fillSep [D.blue "Nothing","->"]
3744+ , D.indent 8 $ D.fillSep [D.dullyellow "400"]
3745+ ]
3746+ , D.reflow $
3747+ "Notice the indentation. Each pattern is aligned, and each branch is indented\
3748+ \ a bit more than the corresponding pattern. That is important!"
3749+ ]
3750+
3751+
3752+noteForCaseIndentError :: D.Doc
3753+noteForCaseIndentError =
3754+ D.stack
33453755 [ D.toSimpleNote $
33463756 "Sometimes I get confused by indentation, so try to make your `case` look\
33473757 \ something like this:"
@@ -3354,8 +3764,9 @@ addNoteForCaseIndentError message =
33543764 , D.indent 8 $ D.fillSep [D.dullyellow "400"]
33553765 ]
33563766 , D.reflow $
3357− "Notice the indentation! Each pattern is aligned, and each branch is indented\
3358− \ a bit more than the corresponding pattern. That is important!"
3767+ "Notice the indentation! Patterns are aligned with each other. Same indentation.\
3768+ \ The expressions after each arrow are all indented a bit more than the patterns.\
3769+ \ That is important!"
33593770 ]
33603771
33613772
@@ -3507,23 +3918,43 @@ toIfReport source context if_ startRow startCol =
35073918 )
35083919
35093920 IfIndentElse row col ->
3510− let
3511− surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3512− region = toRegion row col
3513− in
3514− Report.Report "UNFINISHED IF" region [] $
3515− Code.toSnippet source surroundings (Just region)
3516− (
3517− D.reflow $
3518− "I was expecting to see an `else` branch after this:"
3519− ,
3520− D.stack
3521− [ D.reflow $
3522− "I know what to do when the condition is `True`, but not when it is `False`."
3523− , D.fillSep
3524− ["Add","an",D.cyan "else","branch","to","handle","that","scenario!"]
3525− ]
3526− )
3921+ case Code.nextLineStartsWithKeyword "else" source row of
3922+ Just (elseRow, elseCol) ->
3923+ let
3924+ surroundings = A.Region (A.Position startRow startCol) (A.Position elseRow elseCol)
3925+ region = toWiderRegion elseRow elseCol 4
3926+ in
3927+ Report.Report "WEIRD ELSE BRANCH" region [] $
3928+ Code.toSnippet source surroundings (Just region)
3929+ (
3930+ D.reflow $
3931+ "I was partway through an `if` expression when I got stuck here:"
3932+ ,
3933+ D.fillSep $
3934+ ["I","think","this",D.cyan "else","keyword","needs","to","be","indented","more."
3935+ ,"Try","adding","some","spaces","before","it."
3936+ ]
3937+ )
3938+
3939+ Nothing ->
3940+ let
3941+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3942+ region = toRegion row col
3943+ in
3944+ Report.Report "UNFINISHED IF" region [] $
3945+ Code.toSnippet source surroundings (Just region)
3946+ (
3947+ D.reflow $
3948+ "I was expecting to see an `else` branch after this:"
3949+ ,
3950+ D.stack
3951+ [ D.fillSep
3952+ ["I","know","what","to","do","when","the","condition","is","True,"
3953+ ,"but","what","happens","when","it","is","False?"
3954+ ,"Add","an",D.cyan "else","branch","to","handle","that","scenario!"
3955+ ]
3956+ ]
3957+ )
35273958
35283959
35293960
@@ -3556,15 +3987,22 @@ toRecordReport source context record startRow startCol =
35563987 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
35573988 region = toRegion row col
35583989 in
3559− Report.Report "UNFINISHED RECORD" region [] $
3990+ Report.Report "PROBLEM IN RECORD" region [] $
35603991 Code.toSnippet source surroundings (Just region)
35613992 (
35623993 D.reflow $
35633994 "I just started parsing a record, but I got stuck here:"
35643995 ,
3565− D.fillSep
3566− ["Records","look","like",D.dullyellow "{ x = 3, y = 4 },"
3567− ,"so","I","was","expecting","to","see","a","field","name","next."
3996+ D.stack
3997+ [ D.fillSep
3998+ ["I","was","expecting","to","see","a","record","field","defined","next,"
3999+ ,"so","I","am","looking","for","a","name","like"
4000+ ,D.dullyellow "userName","or",D.dullyellow "plantHeight" <> "."
4001+ ]
4002+ , D.toSimpleNote $
4003+ "Field names must start with a lower-case letter. After that, you can use\
4004+ \ any sequence of letters, numbers, and underscores."
4005+ , noteForRecordError
35684006 ]
35694007 )
35704008
@@ -3573,7 +4011,7 @@ toRecordReport source context record startRow startCol =
35734011 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
35744012 region = toRegion row col
35754013 in
3576− Report.Report "UNFINISHED RECORD" region [] $
4014+ Report.Report "PROBLEM IN RECORD" region [] $
35774015 Code.toSnippet source surroundings (Just region)
35784016 (
35794017 D.reflow $
@@ -3608,22 +4046,67 @@ toRecordReport source context record startRow startCol =
36084046 \ that is a reserved word. Try using a different name!"
36094047 )
36104048
4049+ Code.Other (Just ',') ->
4050+ let
4051+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4052+ region = toRegion row col
4053+ in
4054+ Report.Report "EXTRA COMMA" region [] $
4055+ Code.toSnippet source surroundings (Just region)
4056+ (
4057+ D.reflow $
4058+ "I am partway through parsing a record, but I got stuck here:"
4059+ ,
4060+ D.stack
4061+ [ D.reflow $
4062+ "I am seeing two commas in a row. This is the second one!"
4063+ , D.reflow $
4064+ "Just delete one of the commas and you should be all set!"
4065+ , noteForRecordError
4066+ ]
4067+ )
4068+
4069+ Code.Close _ '}' ->
4070+ let
4071+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4072+ region = toRegion row col
4073+ in
4074+ Report.Report "EXTRA COMMA" region [] $
4075+ Code.toSnippet source surroundings (Just region)
4076+ (
4077+ D.reflow $
4078+ "I am partway through parsing a record, but I got stuck here:"
4079+ ,
4080+ D.stack
4081+ [ D.reflow $
4082+ "Trailing commas are not allowed in records. Try deleting the comma that appears\
4083+ \ before this closing curly brace."
4084+ , noteForRecordError
4085+ ]
4086+ )
4087+
36114088 _ ->
36124089 let
36134090 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
36144091 region = toRegion row col
36154092 in
3616− Report.Report "UNFINISHED RECORD" region [] $
4093+ Report.Report "PROBLEM IN RECORD" region [] $
36174094 Code.toSnippet source surroundings (Just region)
36184095 (
36194096 D.reflow $
3620− "I am partway through parsing a record, but I got stuck after that last comma:"
4097+ "I am partway through parsing a record, but I got stuck here:"
36214098 ,
3622− addNoteForRecordError $
3623− D.reflow $
3624− "Trailing commas are not allowed in records, so I was expecting to see another\
3625− \ record field defined next. If you are done defining the record, the fix may\
3626− \ be to delete that last comma?"
4099+ D.stack
4100+ [ D.fillSep
4101+ ["I","was","expecting","to","see","another","record","field","defined","next,"
4102+ ,"so","I","am","looking","for","a","name","like"
4103+ ,D.dullyellow "userName","or",D.dullyellow "plantHeight" <> "."
4104+ ]
4105+ , D.toSimpleNote $
4106+ "Field names must start with a lower-case letter. After that, you can use\
4107+ \ any sequence of letters, numbers, and underscores."
4108+ , noteForRecordError
4109+ ]
36274110 )
36284111
36294112 RecordEquals row col ->
@@ -3631,17 +4114,19 @@ toRecordReport source context record startRow startCol =
36314114 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
36324115 region = toRegion row col
36334116 in
3634− Report.Report "UNFINISHED RECORD" region [] $
4117+ Report.Report "PROBLEM IN RECORD" region [] $
36354118 Code.toSnippet source surroundings (Just region)
36364119 (
36374120 D.reflow $
36384121 "I am partway through parsing a record, but I got stuck here:"
36394122 ,
3640− addNoteForRecordError $
3641− D.fillSep $
3642− ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
3643− ,"an","equals","sign","next.","So","try","putting","an",D.green "=","sign","here?"
3644− ]
4123+ D.stack
4124+ [ D.fillSep $
4125+ ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
4126+ ,"an","equals","sign","next.","So","try","putting","an",D.green "=","sign","here?"
4127+ ]
4128+ , noteForRecordError
4129+ ]
36454130 )
36464131
36474132 RecordExpr expr row col ->
@@ -3661,29 +4146,54 @@ toRecordReport source context record startRow startCol =
36614146 D.reflow $
36624147 "I just saw the opening curly brace of a record, but then I got stuck here:"
36634148 ,
3664− addNoteForRecordIndentError $
3665− D.fillSep $
3666− ["I","am","expecting","a","record","like",D.dullyellow "{ x = 3, y = 4 }","here."
3667− ,"Try","defining","some","fields","of","your","own?"
3668− ]
4149+ D.stack
4150+ [ D.fillSep $
4151+ ["I","am","expecting","a","record","like",D.dullyellow "{ x = 3, y = 4 }","here."
4152+ ,"Try","defining","some","fields","of","your","own?"
4153+ ]
4154+ , noteForRecordIndentError
4155+ ]
36694156 )
36704157
36714158 RecordIndentEnd row col ->
3672− let
3673− surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
3674− region = toRegion row col
3675− in
3676− Report.Report "UNFINISHED RECORD" region [] $
3677− Code.toSnippet source surroundings (Just region)
3678− (
3679− D.reflow $
3680− "I was expecting to see a closing curly brace next:"
3681− ,
3682− addNoteForRecordIndentError $
3683− D.fillSep $
3684− ["Try","putting","an",D.green "}","and","see","if","that","helps?"
3685− ]
3686− )
4159+ case Code.nextLineStartsWithCloseCurly source row of
4160+ Just (curlyRow, curlyCol) ->
4161+ let
4162+ surroundings = A.Region (A.Position startRow startCol) (A.Position curlyRow curlyCol)
4163+ region = toRegion curlyRow curlyCol
4164+ in
4165+ Report.Report "NEED MORE INDENTATION" region [] $
4166+ Code.toSnippet source surroundings (Just region)
4167+ (
4168+ D.reflow $
4169+ "I was partway through parsing a record, but I got stuck here:"
4170+ ,
4171+ D.stack
4172+ [ D.reflow $
4173+ "I need this curly brace to be indented more. Try adding some spaces before it!"
4174+ , noteForRecordError
4175+ ]
4176+ )
4177+
4178+ Nothing ->
4179+ let
4180+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
4181+ region = toRegion row col
4182+ in
4183+ Report.Report "UNFINISHED RECORD" region [] $
4184+ Code.toSnippet source surroundings (Just region)
4185+ (
4186+ D.reflow $
4187+ "I was partway through parsing a record, but I got stuck here:"
4188+ ,
4189+ D.stack
4190+ [ D.fillSep $
4191+ ["I","was","expecting","to","see","a","closing","curly","brace","next."
4192+ ,"Try","putting","a",D.green "}","next","and","see","if","that","helps?"
4193+ ]
4194+ , noteForRecordIndentError
4195+ ]
4196+ )
36874197
36884198 RecordIndentField row col ->
36894199 let
@@ -3696,11 +4206,13 @@ toRecordReport source context record startRow startCol =
36964206 D.reflow $
36974207 "I am partway through parsing a record, but I got stuck after that last comma:"
36984208 ,
3699− addNoteForRecordError $
3700− D.reflow $
3701− "Trailing commas are not allowed in records, so the fix may be to\
3702− \ delete that last comma? Or maybe you were in the middle of defining\
3703− \ an additional field?"
4209+ D.stack
4210+ [ D.reflow $
4211+ "Trailing commas are not allowed in records, so the fix may be to\
4212+ \ delete that last comma? Or maybe you were in the middle of defining\
4213+ \ an additional field?"
4214+ , noteForRecordError
4215+ ]
37044216 )
37054217
37064218 RecordIndentEquals row col ->
@@ -3715,10 +4227,12 @@ toRecordReport source context record startRow startCol =
37154227 "I am partway through parsing a record. I just saw a record\
37164228 \ field, so I was expecting to see an equals sign next:"
37174229 ,
3718− addNoteForRecordIndentError $
3719− D.fillSep $
3720− ["Try","putting","an",D.green "=","followed","by","an","expression?"
3721− ]
4230+ D.stack
4231+ [ D.fillSep $
4232+ ["Try","putting","an",D.green "=","followed","by","an","expression?"
4233+ ]
4234+ , noteForRecordIndentError
4235+ ]
37224236 )
37234237
37244238 RecordIndentExpr row col ->
@@ -3732,52 +4246,48 @@ toRecordReport source context record startRow startCol =
37324246 D.reflow $
37334247 "I am partway through parsing a record, and I was expecting to run into an expression next:"
37344248 ,
3735− addNoteForRecordIndentError $
3736− D.fillSep $
3737− ["Try","putting","something","like"
3738− ,D.dullyellow "42","or",D.dullyellow"\"hello\"","for","now?"
3739− ]
4249+ D.stack
4250+ [ D.fillSep $
4251+ ["Try","putting","something","like"
4252+ ,D.dullyellow "42","or",D.dullyellow"\"hello\"","for","now?"
4253+ ]
4254+ , noteForRecordIndentError
4255+ ]
37404256 )
37414257
37424258
3743−addNoteForRecordError :: D.Doc -> D.Doc
3744−addNoteForRecordError normalRecommendation =
4259+noteForRecordError :: D.Doc
4260+noteForRecordError =
37454261 D.stack $
3746− normalRecommendation
3747− :
37484262 [ D.toSimpleNote
37494263 "If you are trying to define a record across multiple lines, I recommend using this format:"
37504264 , D.indent 4 $ D.vcat $
3751− [ "{ name = \"Alice\""
3752− , ", age = 42"
3753− , ", height = 1.75"
4265+ [ "{ name = " <> D.dullyellow "\"Alice\""
4266+ , ", age = " <> D.dullyellow "42"
4267+ , ", height = " <> D.dullyellow "1.75"
37544268 , "}"
37554269 ]
37564270 , D.reflow $
3757− "Notice that each line starts with some indentation. Usually two or four spaces. I\
3758− \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3759− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4271+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4272+ \ This is the stylistic convention in the Elm ecosystem."
37604273 ]
37614274
37624275
3763−addNoteForRecordIndentError :: D.Doc -> D.Doc
3764−addNoteForRecordIndentError normalRecommendation =
3765− D.stack $
3766− normalRecommendation
3767− :
4276+noteForRecordIndentError :: D.Doc
4277+noteForRecordIndentError =
4278+ D.stack
37684279 [ D.toSimpleNote
37694280 "I may be confused by indentation. For example, if you are trying to define\
37704281 \ a record across multiple lines, I recommend using this format:"
37714282 , D.indent 4 $ D.vcat $
3772− [ "{ name = \"Alice\""
3773− , ", age = 42"
3774− , ", height = 1.75"
4283+ [ "{ name = " <> D.dullyellow "\"Alice\""
4284+ , ", age = " <> D.dullyellow "42"
4285+ , ", height = " <> D.dullyellow "1.75"
37754286 , "}"
37764287 ]
37774288 , D.reflow $
3778− "Notice that each line starts with some indentation. Usually two or four spaces. I\
3779− \ know this style can be jarring for people coming from C-like syntax, but folks generally\
3780− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4289+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4290+ \ This is the stylistic convention in the Elm ecosystem!"
37814291 ]
37824292
37834293
@@ -3966,15 +4476,14 @@ toListReport source context list startRow startCol =
39664476 , D.toSimpleNote
39674477 "I recommend using the following format for lists that span multiple lines:"
39684478 , D.indent 4 $ D.vcat $
3969− [ "[ \"Alice\""
3970− , ", \"Bob\""
3971− , ", \"Chuck\""
4479+ [ "[ " <> D.dullyellow "\"Alice\""
4480+ , ", " <> D.dullyellow "\"Bob\""
4481+ , ", " <> D.dullyellow "\"Chuck\""
39724482 , "]"
39734483 ]
39744484 , D.reflow $
3975− "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
3976− \ This style can be jarring for people coming from C-like syntax, but folks generally\
3977− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4485+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4486+ \ This is the stylistic convention in the Elm ecosystem."
39784487 ]
39794488 )
39804489
@@ -4027,15 +4536,14 @@ toListReport source context list startRow startCol =
40274536 "I may be confused by indentation. For example, if you are trying to define\
40284537 \ a list across multiple lines, I recommend using this format:"
40294538 , D.indent 4 $ D.vcat $
4030− [ "[ \"Alice\""
4031− , ", \"Bob\""
4032− , ", \"Chuck\""
4539+ [ "[ " <> D.dullyellow "\"Alice\""
4540+ , ", " <> D.dullyellow "\"Bob\""
4541+ , ", " <> D.dullyellow "\"Chuck\""
40334542 , "]"
40344543 ]
40354544 , D.reflow $
4036− "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4037− \ This style can be jarring for people coming from C-like syntax, but folks generally\
4038− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4545+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4546+ \ This is the stylistic convention in the Elm ecosystem."
40394547 ]
40404548 )
40414549
@@ -4059,15 +4567,14 @@ toListReport source context list startRow startCol =
40594567 "I may be confused by indentation. For example, if you are trying to define\
40604568 \ a list across multiple lines, I recommend using this format:"
40614569 , D.indent 4 $ D.vcat $
4062− [ "[ \"Alice\""
4063− , ", \"Bob\""
4064− , ", \"Chuck\""
4570+ [ "[ " <> D.dullyellow "\"Alice\""
4571+ , ", " <> D.dullyellow "\"Bob\""
4572+ , ", " <> D.dullyellow "\"Chuck\""
40654573 , "]"
40664574 ]
40674575 , D.reflow $
4068− "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4069− \ This style can be jarring for people coming from C-like syntax, but folks generally\
4070− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4576+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4577+ \ This is the stylistic convention in the Elm ecosystem."
40714578 ]
40724579 )
40734580
@@ -4088,15 +4595,14 @@ toListReport source context list startRow startCol =
40884595 , D.toSimpleNote
40894596 "I recommend using the following format for lists that span multiple lines:"
40904597 , D.indent 4 $ D.vcat $
4091− [ "[ \"Alice\""
4092− , ", \"Bob\""
4093− , ", \"Chuck\""
4598+ [ "[ " <> D.dullyellow "\"Alice\""
4599+ , ", " <> D.dullyellow "\"Bob\""
4600+ , ", " <> D.dullyellow "\"Chuck\""
40944601 , "]"
40954602 ]
40964603 , D.reflow $
4097− "Notice that nothing comes directly after a newline. Each line starts with some spaces.\
4098− \ This style can be jarring for people coming from C-like syntax, but folks generally\
4099− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
4604+ "Notice that each line starts with some indentation. Usually two or four spaces.\
4605+ \ This is the stylistic convention in the Elm ecosystem."
41004606 ]
41014607 )
41024608
@@ -4345,7 +4851,7 @@ toPatternReport source context pattern startRow startCol =
43454851 ,"((" <> D.dullyellow "x" <> "," <> D.dullyellow "y" <> ") " <> D.cyan "as" <> D.dullyellow " point" <> ")"
43464852 ,"so","you","can","refer","to","individual","parts","of","the","tuple","with"
43474853 ,D.dullyellow "x","and",D.dullyellow "y","or","you","refer","to","the","whole"
4348− ,"thing","with",D.dullyellow "point."
4854+ ,"thing","with",D.dullyellow "point" <> "."
43494855 ]
43504856 , D.reflow $
43514857 "So I was expecting to see a variable name after the `as` keyword here. Sometimes\
@@ -4537,7 +5043,7 @@ toPTupleReport source context tuple startRow startCol =
45375043 "I just saw an open parenthesis, but I got stuck here:"
45385044 ,
45395045 D.fillSep
4540− ["I","was","expecting","so","see","a","pattern","next."
5046+ ["I","was","expecting","to","see","a","pattern","next."
45415047 ,"Maybe","it","will","end","up","being","something"
45425048 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
45435049 ]
@@ -4646,7 +5152,7 @@ toPTupleReport source context tuple startRow startCol =
46465152 "I just saw an open parenthesis, but then I got stuck here:"
46475153 ,
46485154 D.fillSep
4649− ["I","was","expecting","so","see","a","pattern","next."
5155+ ["I","was","expecting","to","see","a","pattern","next."
46505156 ,"Maybe","it","will","end","up","being","something"
46515157 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "?"
46525158 ]
@@ -4665,7 +5171,7 @@ toPTupleReport source context tuple startRow startCol =
46655171 ,
46665172 D.stack
46675173 [ D.fillSep
4668− ["I","was","expecting","so","see","a","pattern","next."
5174+ ["I","was","expecting","to","see","a","pattern","next."
46695175 ,"I","am","expecting","the","final","result","to","be","something"
46705176 ,"like",D.dullyellow "(x,y)","or",D.dullyellow "(name, _)" <> "."
46715177 ]
@@ -4969,22 +5475,64 @@ toTRecordReport source context record startRow startCol =
49695475 \ that is a reserved word. Try using a different name!"
49705476 )
49715477
5478+ Code.Other (Just ',') ->
5479+ let
5480+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5481+ region = toRegion row col
5482+ in
5483+ Report.Report "EXTRA COMMA" region [] $
5484+ Code.toSnippet source surroundings (Just region)
5485+ (
5486+ D.reflow $
5487+ "I am partway through parsing a record type, but I got stuck here:"
5488+ ,
5489+ D.stack
5490+ [ D.reflow $
5491+ "I am seeing two commas in a row. This is the second one!"
5492+ , D.reflow $
5493+ "Just delete one of the commas and you should be all set!"
5494+ , noteForRecordTypeError
5495+ ]
5496+ )
5497+
5498+ Code.Close _ '}' ->
5499+ let
5500+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5501+ region = toRegion row col
5502+ in
5503+ Report.Report "EXTRA COMMA" region [] $
5504+ Code.toSnippet source surroundings (Just region)
5505+ (
5506+ D.reflow $
5507+ "I am partway through parsing a record type, but I got stuck here:"
5508+ ,
5509+ D.stack
5510+ [ D.reflow $
5511+ "Trailing commas are not allowed in record types. Try deleting the comma that\
5512+ \ appears before this closing curly brace."
5513+ , noteForRecordTypeError
5514+ ]
5515+ )
5516+
49725517 _ ->
49735518 let
49745519 surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
49755520 region = toRegion row col
49765521 in
4977− Report.Report "UNFINISHED RECORD TYPE" region [] $
5522+ Report.Report "PROBLEM IN RECORD TYPE" region [] $
49785523 Code.toSnippet source surroundings (Just region)
49795524 (
49805525 D.reflow $
4981− "I am partway through parsing a record type, but I got stuck after that last comma:"
5526+ "I am partway through parsing a record type, but I got stuck here:"
49825527 ,
4983− addNoteForRecordTypeError $
4984− D.reflow $
4985− "Trailing commas are not allowed in records, so I was expecting to see another\
4986− \ record field defined next. If you are done defining the record, the fix may\
4987− \ be to delete that last comma?"
5528+ D.stack
5529+ [ D.fillSep
5530+ ["I","was","expecting","to","see","another","record","field","defined","next,"
5531+ ,"so","I","am","looking","for","a","name","like"
5532+ ,D.dullyellow "userName","or",D.dullyellow "plantHeight" <> "."
5533+ ]
5534+ , noteForRecordTypeError
5535+ ]
49885536 )
49895537
49905538 TRecordColon row col ->
@@ -4998,11 +5546,13 @@ toTRecordReport source context record startRow startCol =
49985546 D.reflow $
49995547 "I am partway through parsing a record type, but I got stuck here:"
50005548 ,
5001− addNoteForRecordTypeError $
5002− D.fillSep $
5003− ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
5004− ,"a","colon","next.","So","try","putting","an",D.green ":","sign","here?"
5005− ]
5549+ D.stack
5550+ [ D.fillSep $
5551+ ["I","just","saw","a","field","name,","so","I","was","expecting","to","see"
5552+ ,"a","colon","next.","So","try","putting","an",D.green ":","sign","here?"
5553+ ]
5554+ , noteForRecordTypeError
5555+ ]
50065556 )
50075557
50085558 TRecordType tipe row col ->
@@ -5022,29 +5572,54 @@ toTRecordReport source context record startRow startCol =
50225572 D.reflow $
50235573 "I just saw the opening curly brace of a record type, but then I got stuck here:"
50245574 ,
5025− addNoteForRecordTypeIndentError $
5026− D.fillSep $
5027− ["I","am","expecting","a","record","like",D.dullyellow "{ name : String, age : Int }","here."
5028− ,"Try","defining","some","fields","of","your","own?"
5029− ]
5575+ D.stack
5576+ [ D.fillSep $
5577+ ["I","am","expecting","a","record","like",D.dullyellow "{ name : String, age : Int }","here."
5578+ ,"Try","defining","some","fields","of","your","own?"
5579+ ]
5580+ , noteForRecordTypeIndentError
5581+ ]
50305582 )
50315583
50325584 TRecordIndentEnd row col ->
5033− let
5034− surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5035− region = toRegion row col
5036− in
5037− Report.Report "UNFINISHED RECORD TYPE" region [] $
5038− Code.toSnippet source surroundings (Just region)
5039− (
5040− D.reflow $
5041− "I was expecting to see a closing curly brace next:"
5042− ,
5043− addNoteForRecordTypeIndentError $
5044− D.fillSep $
5045− ["Try","putting","an",D.green "}","and","see","if","that","helps?"
5046− ]
5047− )
5585+ case Code.nextLineStartsWithCloseCurly source row of
5586+ Just (curlyRow, curlyCol) ->
5587+ let
5588+ surroundings = A.Region (A.Position startRow startCol) (A.Position curlyRow curlyCol)
5589+ region = toRegion curlyRow curlyCol
5590+ in
5591+ Report.Report "NEED MORE INDENTATION" region [] $
5592+ Code.toSnippet source surroundings (Just region)
5593+ (
5594+ D.reflow $
5595+ "I was partway through parsing a record type, but I got stuck here:"
5596+ ,
5597+ D.stack
5598+ [ D.reflow $
5599+ "I need this curly brace to be indented more. Try adding some spaces before it!"
5600+ , noteForRecordTypeError
5601+ ]
5602+ )
5603+
5604+ Nothing ->
5605+ let
5606+ surroundings = A.Region (A.Position startRow startCol) (A.Position row col)
5607+ region = toRegion row col
5608+ in
5609+ Report.Report "UNFINISHED RECORD TYPE" region [] $
5610+ Code.toSnippet source surroundings (Just region)
5611+ (
5612+ D.reflow $
5613+ "I was partway through parsing a record type, but I got stuck here:"
5614+ ,
5615+ D.stack
5616+ [ D.fillSep $
5617+ ["I","was","expecting","to","see","a","closing","curly","brace","next."
5618+ ,"Try","putting","a",D.green "}","next","and","see","if","that","helps?"
5619+ ]
5620+ , noteForRecordTypeIndentError
5621+ ]
5622+ )
50485623
50495624 TRecordIndentField row col ->
50505625 let
@@ -5057,11 +5632,13 @@ toTRecordReport source context record startRow startCol =
50575632 D.reflow $
50585633 "I am partway through parsing a record type, but I got stuck after that last comma:"
50595634 ,
5060− addNoteForRecordTypeIndentError $
5061− D.reflow $
5062− "Trailing commas are not allowed in record types, so the fix may be to\
5063− \ delete that last comma? Or maybe you were in the middle of defining\
5064− \ an additional field?"
5635+ D.stack
5636+ [ D.reflow $
5637+ "Trailing commas are not allowed in record types, so the fix may be to\
5638+ \ delete that last comma? Or maybe you were in the middle of defining\
5639+ \ an additional field?"
5640+ , noteForRecordTypeIndentError
5641+ ]
50655642 )
50665643
50675644 TRecordIndentColon row col ->
@@ -5076,10 +5653,12 @@ toTRecordReport source context record startRow startCol =
50765653 "I am partway through parsing a record type. I just saw a record\
50775654 \ field, so I was expecting to see a colon next:"
50785655 ,
5079− addNoteForRecordTypeIndentError $
5080− D.fillSep $
5081− ["Try","putting","an",D.green ":","followed","by","a","type?"
5082− ]
5656+ D.stack
5657+ [ D.fillSep $
5658+ ["Try","putting","an",D.green ":","followed","by","a","type?"
5659+ ]
5660+ , noteForRecordTypeIndentError
5661+ ]
50835662 )
50845663
50855664 TRecordIndentType row col ->
@@ -5093,19 +5672,19 @@ toTRecordReport source context record startRow startCol =
50935672 D.reflow $
50945673 "I am partway through parsing a record type, and I was expecting to run into a type next:"
50955674 ,
5096− addNoteForRecordTypeIndentError $
5097− D.fillSep $
5098− ["Try","putting","something","like"
5099− ,D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5100− ]
5675+ D.stack
5676+ [ D.fillSep $
5677+ ["Try","putting","something","like"
5678+ ,D.dullyellow "Int","or",D.dullyellow "String","for","now?"
5679+ ]
5680+ , noteForRecordTypeIndentError
5681+ ]
51015682 )
51025683
51035684
5104−addNoteForRecordTypeError :: D.Doc -> D.Doc
5105−addNoteForRecordTypeError normalRecommendation =
5685+noteForRecordTypeError :: D.Doc
5686+noteForRecordTypeError =
51065687 D.stack $
5107− normalRecommendation
5108− :
51095688 [ D.toSimpleNote
51105689 "If you are trying to define a record type across multiple lines, I recommend using this format:"
51115690 , D.indent 4 $ D.vcat $
@@ -5115,17 +5694,14 @@ addNoteForRecordTypeError normalRecommendation =
51155694 , "}"
51165695 ]
51175696 , D.reflow $
5118− "Notice that each line starts with some indentation. Usually two or four spaces. I\
5119− \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5120− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5697+ "Notice that each line starts with some indentation. Usually two or four spaces.\
5698+ \ This is the stylistic convention in the Elm ecosystem."
51215699 ]
51225700
51235701
5124−addNoteForRecordTypeIndentError :: D.Doc -> D.Doc
5125−addNoteForRecordTypeIndentError normalRecommendation =
5702+noteForRecordTypeIndentError :: D.Doc
5703+noteForRecordTypeIndentError =
51265704 D.stack $
5127− normalRecommendation
5128− :
51295705 [ D.toSimpleNote
51305706 "I may be confused by indentation. For example, if you are trying to define\
51315707 \ a record type across multiple lines, I recommend using this format:"
@@ -5136,9 +5712,8 @@ addNoteForRecordTypeIndentError normalRecommendation =
51365712 , "}"
51375713 ]
51385714 , D.reflow $
5139− "Notice that each line starts with some indentation. Usually two or four spaces. I\
5140− \ know this style can be jarring for people coming from C-like syntax, but folks generally\
5141− \ report that they are used to it (and often prefer it!) after a week or two of using Elm."
5715+ "Notice that each line starts with some indentation. Usually two or four spaces.\
5716+ \ This is the stylistic convention in the Elm ecosystem."
51425717 ]
51435718
51445719
@@ -5190,7 +5765,7 @@ toTTupleReport source context tuple startRow startCol =
51905765 Code.toSnippet source surroundings (Just region)
51915766 (
51925767 D.reflow $
5193− "I was expecting to see a closing parentheses next, but I got stuck here:"
5768+ "I was expecting to see a closing parenthesis next, but I got stuck here:"
51945769 ,
51955770 D.stack
51965771 [ D.fillSep ["Try","adding","a",D.dullyellow ")","to","see","if","that","helps?"]