Skip to content

Commit 8d4232f

Browse files
VLanvinfacebook-github-bot
authored andcommitted
Make errors point to GitHub docs
Summary: Created a public shortened URL https://fb.me/eqwalizer_errors pointing to docs/reference/errors.md on GitHub. Errors are modified to point to https://fb.me/eqwalizer_errors#error_name, which makes it much easier to introduce new errors (no need to create a new short URL). Reviewed By: ilya-klyuchnikov Differential Revision: D40638135 fbshipit-source-id: 45b429f36873987ba81ec0c131fde1d1e28ca7b1
1 parent fc7977c commit 8d4232f

File tree

7 files changed

+176
-176
lines changed

7 files changed

+176
-176
lines changed

eqwalizer/src/main/scala/com/whatsapp/eqwalizer/tc/TcDiagnostics.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ object TcDiagnostics {
1919
val pos: Pos
2020
val msg: String
2121
def explanation: Option[String] = None
22-
def errorName: String // stable identifier for the class of error, to be used in fburls and metrics
23-
def fburl: String = s"https://fburl.com/eqwalizer_$errorName"
22+
def errorName: String // stable identifier for the class of error, to be used in metrics
23+
def docURL: String = s"https://fb.me/eqwalizer_errors#$errorName"
2424
def erroneousExpr: Option[Expr]
2525
}
2626
case class ExpectedSubtype(pos: Pos, expr: Expr, expected: Type, got: Type)(implicit pipelineContext: PipelineContext)

eqwalizer/src/main/scala/com/whatsapp/eqwalizer/util/ELPDiagnostics.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ object ELPDiagnostics {
7979
Error(
8080
te.pos,
8181
te.msg,
82-
te.fburl,
82+
te.docURL,
8383
te.errorName,
8484
explanation = te.explanation,
8585
shownExpression = te.erroneousExpr.map(Show.show),

eqwalizer/test_projects/_cli/opaque.elp.json

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
},
88
"lineAndCol": null,
99
"message": "Expected: sets:set({'ok', 'ok'})\nGot : sets:set({'ok', 'error'})",
10-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
10+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
1111
"code": "expected_subtype",
1212
"expressionOrNull": "X",
1313
"explanationOrNull": " sets:set({'ok', 'error'}) is not a subtype of sets:set({'ok', 'ok'})\n because\n at tuple index 2:\n {'ok', 'error'} is not a subtype of {'ok', 'ok'}\n because\n 'error' is not a subtype of 'ok'"
@@ -19,7 +19,7 @@
1919
},
2020
"lineAndCol": null,
2121
"message": "Expected: 'ok'\nGot : term()",
22-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
22+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
2323
"code": "expected_subtype",
2424
"expressionOrNull": "X",
2525
"explanationOrNull": null
@@ -31,7 +31,7 @@
3131
},
3232
"lineAndCol": null,
3333
"message": "Expected: 'ok'\nGot : #D{term() => term()}",
34-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
34+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
3535
"code": "expected_subtype",
3636
"expressionOrNull": "X",
3737
"explanationOrNull": null
@@ -43,7 +43,7 @@
4343
},
4444
"lineAndCol": null,
4545
"message": "Expected: tuple()\nGot : misc:o()",
46-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
46+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
4747
"code": "expected_subtype",
4848
"expressionOrNull": "X",
4949
"explanationOrNull": null
@@ -55,7 +55,7 @@
5555
},
5656
"lineAndCol": null,
5757
"message": "Expected: none()\nGot : misc:o()",
58-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
58+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
5959
"code": "expected_subtype",
6060
"expressionOrNull": "X2",
6161
"explanationOrNull": null
@@ -67,7 +67,7 @@
6767
},
6868
"lineAndCol": null,
6969
"message": "Expected: tuple()\nGot : misc:o()",
70-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
70+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
7171
"code": "expected_subtype",
7272
"expressionOrNull": "Res",
7373
"explanationOrNull": null
@@ -79,7 +79,7 @@
7979
},
8080
"lineAndCol": null,
8181
"message": "Expected: {'ok'}\nGot : term()",
82-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
82+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
8383
"code": "expected_subtype",
8484
"expressionOrNull": "X",
8585
"explanationOrNull": null
@@ -91,7 +91,7 @@
9191
},
9292
"lineAndCol": null,
9393
"message": "Expected: 'true'\nGot : boolean()",
94-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
94+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
9595
"code": "expected_subtype",
9696
"expressionOrNull": "_ =:= _",
9797
"explanationOrNull": null
@@ -103,7 +103,7 @@
103103
},
104104
"lineAndCol": null,
105105
"message": "Expected: {'ok'} | 'a'\nGot : misc:o() | 'a'",
106-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
106+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
107107
"code": "expected_subtype",
108108
"expressionOrNull": "X",
109109
"explanationOrNull": " misc:o() | 'a' is not a subtype of {'ok'} | 'a'\n because\n misc:o() is not a subtype of {'ok'} | 'a'\n because\n misc:o() is not a subtype of {'ok'}"
@@ -115,7 +115,7 @@
115115
},
116116
"lineAndCol": null,
117117
"message": "Expected: misc:o()\nGot : misc:o() | 'a'",
118-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
118+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
119119
"code": "expected_subtype",
120120
"expressionOrNull": "X",
121121
"explanationOrNull": " misc:o() | 'a' is not a subtype of misc:o()\n because\n 'a' is not a subtype of misc:o()"
@@ -127,7 +127,7 @@
127127
},
128128
"lineAndCol": null,
129129
"message": "Expected: misc:o()\nGot : misc:o() | 'a'",
130-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
130+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
131131
"code": "expected_subtype",
132132
"expressionOrNull": "X",
133133
"explanationOrNull": " misc:o() | 'a' is not a subtype of misc:o()\n because\n 'a' is not a subtype of misc:o()"
@@ -139,7 +139,7 @@
139139
},
140140
"lineAndCol": null,
141141
"message": "T. Type vars in aliases are not allowed in function parameter position.",
142-
"uri": "https://fburl.com/eqwalizer_type_var_in_parameter_position",
142+
"uri": "https://fb.me/eqwalizer_errors#type_var_in_parameter_position",
143143
"code": "type_var_in_parameter_position",
144144
"expressionOrNull": null,
145145
"explanationOrNull": null
@@ -151,7 +151,7 @@
151151
},
152152
"lineAndCol": null,
153153
"message": "use_contra_neg/1 references type with invalid definition: contravariant/1",
154-
"uri": "https://fburl.com/eqwalizer_reference_to_invalid_type",
154+
"uri": "https://fb.me/eqwalizer_errors#reference_to_invalid_type",
155155
"code": "reference_to_invalid_type",
156156
"expressionOrNull": null,
157157
"explanationOrNull": null
@@ -163,7 +163,7 @@
163163
},
164164
"lineAndCol": null,
165165
"message": "Expected: {'ok'}\nGot : misc:o()",
166-
"uri": "https://fburl.com/eqwalizer_expected_subtype",
166+
"uri": "https://fb.me/eqwalizer_errors#expected_subtype",
167167
"code": "expected_subtype",
168168
"expressionOrNull": "X",
169169
"explanationOrNull": null
@@ -175,7 +175,7 @@
175175
},
176176
"lineAndCol": null,
177177
"message": "Expected fun type with arity 0\nGot: misc:int_result_o()",
178-
"uri": "https://fburl.com/eqwalizer_expected_fun_type",
178+
"uri": "https://fb.me/eqwalizer_errors#expected_fun_type",
179179
"code": "expected_fun_type",
180180
"expressionOrNull": "F",
181181
"explanationOrNull": null
@@ -187,7 +187,7 @@
187187
},
188188
"lineAndCol": null,
189189
"message": "Expected fun type with arity 0\nGot: misc:int_result_o()",
190-
"uri": "https://fburl.com/eqwalizer_expected_fun_type",
190+
"uri": "https://fb.me/eqwalizer_errors#expected_fun_type",
191191
"code": "expected_fun_type",
192192
"expressionOrNull": "F",
193193
"explanationOrNull": null
@@ -199,7 +199,7 @@
199199
},
200200
"lineAndCol": null,
201201
"message": "_T: Type variable is unbound.",
202-
"uri": "https://fburl.com/eqwalizer_unbound_type_var",
202+
"uri": "https://fb.me/eqwalizer_errors#unbound_type_var",
203203
"code": "unbound_type_var",
204204
"expressionOrNull": null,
205205
"explanationOrNull": null
@@ -211,7 +211,7 @@
211211
},
212212
"lineAndCol": null,
213213
"message": "o_trans_invalid/0 references type with invalid definition: invalid/0",
214-
"uri": "https://fburl.com/eqwalizer_reference_to_invalid_type",
214+
"uri": "https://fb.me/eqwalizer_errors#reference_to_invalid_type",
215215
"code": "reference_to_invalid_type",
216216
"expressionOrNull": null,
217217
"explanationOrNull": null

0 commit comments

Comments
 (0)