Add a new user/beginner friendly errors system #505

NiumXp · 2024-07-01T00:52:34Z

Hi, this is one of my drafts (maybe 7 months ago) focused on beginners (and quality of life) that I wrote for norminette when @matthieu42Network was accepting my PRs, I'm not sure if he's still available, but recently it seems like new people became collaborators, this made me happy and willing to continue with contributions.

New errors formatting

To use the new format is not necessary a new configuration, just run your norminette:

(.venv) niumxp@DESKTOP-LRN507C:~/oss/norminette$ cat -A test.c
#define exit 42$
$
int^IMain(void) {$
^Ireturn exit;$
}$
(.venv) niumxp@DESKTOP-LRN507C:~/oss/norminette$ norminette test.c
test.c:1:1 INVALID_HEADER Missing or invalid 42 header
test.c:1:9 MACRO_NAME_CAPITAL
     1 | #define exit 42
       |         ^^^^ Macro name must be capitalized
test.c:3:5 FORBIDDEN_CHAR_NAME
     3 | int Main(void) {
       |     ^^^^ user defined identifiers should contain only lowercase characters, digits or '_'
test.c:3:16 BRACE_NEWLINE
     3 | int Main(void) {
       |                ^ Expected newline before brace
test.c:4:12 RETURN_PARENTHESIS
     4 |     return exit;
       |            ^^^^ Return value must be in parenthesis

I added a red color to the errors:

This reverts commit a88f7fb, since it broke tests and flake8.

… classmethod

…rmatter the new style with colors and arrows

xtrm-en · 2024-09-11T21:55:16Z

Subjective nit, this should probably have a bit more padding for readability's sake. Other than that, looks pretty amazing :)

otto-mata

Overall a very good new feature, the norminette would really benefit from its addition!
Some changes are still necessary in my opinion, but please you are absolutely free to discuss your choices!

Bests,
tblochet

otto-mata · 2025-02-04T17:29:30Z

norminette/errors.py

 class HumanizedErrorsFormatter(_formatter):
+    def __str__(self) -> str:
+        output = ''
+        for file in self.files:
+            for error in file.errors:
+                highlight = error.highlights[0]
+                # Location
+                output += f"\x1b[;97m{file.path}:{highlight.lineno}:{highlight.column}\x1b[0m"
+                output += ' ' + error.name
+                if not highlight.length:
+                    output += ' ' + error.text
+                if highlight.length:
+                    # Line
+                    output += f"\n {highlight.lineno:>5} | {file[highlight.lineno,].translated}"
+                    # Arrow
+                    output += "\n       | " + ' ' * (highlight.column - 1)
+                    output += f"\x1b[0;91m{'^' * (highlight.length or 0)} {highlight.hint or error.text}\x1b[0m"
+                output += '\n'
+        return output
+
+
+class ShortErrorsFormatter(_formatter):


It might be a better idea to create another _formatter class, rather than modifying the existing default class.
maybe class CompilerLikeErrorsFormatter

otto-mata · 2025-02-04T17:30:38Z

norminette/file.py

+            # if len(item) == 2:
+            #     lineno, column = item
+            #     return self._line_to_index[lineno + column]


Unnecessary comments

otto-mata · 2025-02-04T17:44:35Z

tests/rules/samples/test_comments.out

See last comment, potentially breaking change

otto-mata · 2025-02-04T17:44:44Z

tests/rules/samples/check_preprocessor_indent.out

@@ -151,6 +151,7 @@ Error: TOO_MANY_WS          (line:   7, col:   1):	Extra whitespaces for indent
 Error: TAB_REPLACE_SPACE    (line:   7, col:   2):	Found tab when expecting space
 Error: TOO_MANY_WS          (line:   9, col:   1):	Extra whitespaces for indent level
 Error: MACRO_NAME_CAPITAL   (line:   9, col:  10):	Macro name must be capitalized
+Error: SPC_BEFORE_NL        (line:  26, col:   2):	Space before newline


This is a potentially breaking change, it should be in a separate PR

otto-mata · 2025-02-04T17:47:53Z

norminette/rules/check_expression_statement.py

-                    context.new_error("RETURN_PARENTHESIS", context.peek_token(tmp))
+                    token = context.peek_token(tmp)
+                    error = Error.from_name("RETURN_PARENTHESIS")
+                    error.add_highlight(token)
+                    context.errors.add(error)


It might be better to do a complete refacto on this,
There are about 145 more context.new_error() still being used.
Maybe in another PR ?

otto-mata · 2025-02-04T17:48:31Z

tests/test_errors.py

@@ -11,7 +11,8 @@
 from norminette.registry import Registry
 from norminette.errors import JSONErrorsFormatter
 from norminette.errors import Error, Errors, Highlight as H
-from norminette.errors import HumanizedErrorsFormatter
+from norminette.errors import ShortErrorsFormatter
+# from norminette.errors import HumanizedErrorsFormatter


Unnecessary comment

NiumXp added 7 commits June 30, 2024 20:33

revert(a88f7fb): "add colors to the norminette (42School#492)"

b7605e6

This reverts commit a88f7fb, since it broke tests and flake8.

add to Error.add_highlight support Token and add Highlight.from_token…

bede5c4

… classmethod

add to ShortErrorsFormatter holds the old style and HumanizedErrorsFo…

e8f552e

…rmatter the new style with colors and arrows

add a proper way to check line lenght, trailing and empty line spaces

da9ea56

add some examples of how to use new highlight code errors system

4d4375c

fix all broken tests due to new highlight code errors

d2c2d71

fix flake8 errors

1e86fbf

otto-mata suggested changes Feb 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a new user/beginner friendly errors system #505

Add a new user/beginner friendly errors system #505

NiumXp commented Jul 1, 2024

xtrm-en commented Sep 11, 2024

otto-mata left a comment

otto-mata Feb 4, 2025

otto-mata Feb 4, 2025

otto-mata Feb 4, 2025

otto-mata Feb 4, 2025

otto-mata Feb 4, 2025

otto-mata Feb 4, 2025

Add a new user/beginner friendly errors system #505

Are you sure you want to change the base?

Add a new user/beginner friendly errors system #505

Conversation

NiumXp commented Jul 1, 2024

New errors formatting

xtrm-en commented Sep 11, 2024

otto-mata left a comment

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment

otto-mata Feb 4, 2025

Choose a reason for hiding this comment