WIP Error and documentation overhaul #289
Conversation
|
🆒 👍 after this PR, can we deprecate constructors for some of the other exceptions and template error that do not use line number and start position? |
| } | ||
|
|
||
| private static String formatArgumentNumber(int argumentNumber) { | ||
| switch (argumentNumber){ |
There was a problem hiding this comment.
this is not very i18nable, but in any case, you can do this for all numbers by just looking at the last digit of the int and using "st" if 1, "nd" if 2, "rd" if 3 and "th" for all other values.
| @@ -11,6 +11,8 @@ | |||
|
|
|||
| String value() default ""; | |||
|
|
|||
| JinjavaParam input(); | |||
There was a problem hiding this comment.
while you're in here, can you add a required attribute to JinjavaParam? @williamspiro wanted one.
There was a problem hiding this comment.
Labeled all filter/exp tests with this new boolean value.
Codecov Report
@@ Coverage Diff @@
## master #289 +/- ##
===========================================
- Coverage 72.28% 71.49% -0.8%
- Complexity 1497 1507 +10
===========================================
Files 234 237 +3
Lines 4648 4760 +112
Branches 739 750 +11
===========================================
+ Hits 3360 3403 +43
- Misses 1033 1093 +60
- Partials 255 264 +9
Continue to review full report at Codecov.
|
This is a work in progress attempt to make error messaging consistent and improve documentation. On the documentation side I have split the
inputinto a filter/expression test from the arguments for that filter/test. When the input is invalid (for example passing a string into a numeric function), we throw aInvalidInputException. When an argument is invalid we throw anInvalidArgumentException. If the number of arguments do not match the required number of arguments for the function, we throw anTemplateSyntaxException.For invalid inputs and arguments, we specify one of the
InvalidReasonenum values and allow the exceptions to automatically handle building a consistent error message. For example, getting the absolute value of a string'test'|abswould result inthrow new InvalidInputException(interpreter, this, InvalidReason.NUMBER_FORMAT, object.toString());. The exception will automatically craft a nice error message:Invalid input in 'abs': input with value 'test' must be a number.For an invalid argument like (
10|add('test')), we also pass in the argument number:throw new InvalidArgumentException(interpreter, this, InvalidReason.NUMBER_FORMAT, 0, arg[0]);which will automatically craft a message:Invalid argument in 'add': 1st argument with value 'test' must be a number.