motet-a / yan

[DEPRECATED] Yet another norminette

Deprecated 🙃

The EPITECH style guide got a major update promoting more modern practices as of October 2017. Feel free to contact me or to open an issue if you are interested in updating or reusing this project.

---

Work in progress

Yan stands for "Yet another norminette". This is a C brace style checker written in Python designed for the EPITECH style.

But unlike the "official" one, this style checker is not a bunch of crappy regex getting so easily confused. Yan is based on a carefully designed tokenizer and an authentic hand-written recursive descent parser.

However, Yan does not handle macros and preprocessor directives (except #include).

What does it check?

A lot of rules of the EPITECH style are checked. I don't want to list all the checks here, it's a pain to describe and to read. Here is a short summary.

A few rules are not implemented yet, and a few rules are not implementable (they must be checked by a human).

A notable feature of this program is its ability to check the most of the rules relative to the indentation.

Forbiden statements like for and switch are not implemented in the parser. If you use one, it leads to a syntax error.

Other features

<stdarg.h> and va_arg() are supported. « Calls » to function-like macros with a type as argument are supported, ellipsis (...) is supported.

typedef is (partially) supported. If Yan fails to analyze a header containing a type important in your program (say t_my_type), you can add this comment before your first use of t_my_type:

/*
** yan typedef t_my_type
*/

If Yan crashes on a part of your code, you can indicate it to ignore the problematic part:

/*
** yan parser off
*/

...some C++ stuff to skip...

/*
** yan parser on
*/

Some features of C99 are implemented (e.g. designated initializers).

Download

Clone the whole repository or fetch yan.py only:

wget https://raw.githubusercontent.com/motet-a/yan/master/yan.py
chmod +x yan.py

Check

If PSU_2015_my_printf/ is the directory of your repository, simply run yan PSU_2015_my_printf/.

If you have header files in a separate directory and the paths in your #include statements are not relative, Yan can't find the headers. You have to specify manually which directories contains headers with the -I option.

If you have a Makefile, Yan can automatically find which directory contains headers in some cases.

Run the tests

To run all the tests, use ./test.sh.

You can run the unit tests with ./test.py or python3 -m unittest test.py.

The script test_on_real_projects.sh fetches a few Git repositories of EPITECH projects and checks their sources with Yan.

TODO

Not so much work.

Macros are not implemented, #defines are ignored. If you use a macro, it should look like a function call or an identifier, otherwise it leads to a syntax error.

Structure and unions are not entirely implemented. Bit fields are not implemented.

yan's Issues

Option to exclude files/directories

There should be an option to exclude directories or files during analysis. Something like --exclude tests/ or maybe a .yanignore file listing all files & directories to ignore in a given directory.

For example: I don't want to analyse my tests directory when I type yan.py ..

Add parsable JSON output

To easily integrate this program.

This style checker is out of date

I'm just informing you that this norminette is currently out of date. There is a new coding style imposed for C projects since the start of the 2022 unix & c pool. You can check the latest version of the new coding style here: https://intra.epitech.eu/file/public/technical-documentations/epitech_coding_style.pdf

I'm not asking you to redo this norminette, I'm just here to tell you it is outdated. (maybe a mention in README.md would be useful?)

Skip code between `#ifdef __cplusplus` and `#endif`

Currently, Yan is unable to parse the headers of the liblapin.

Norm for headers

Currently Yan checks for too long lines & trailing white-spaces in Headers. As far as I know, the official norminette is not checking those rules for the headers.

I think there should be an option like --no-header-check to ignore norm rules on headers, or yan should definitely ignore norm on headers.

Or maybe, yan could check if headers are valid & respecting the header spec :

/*
** {{file}} for {{project}} in {{path}}
** 
** Made by {{user}}
** Login   <{{login}}@epitech.net>
** 
** Started on  {{day}} {{month}} {{day}} {{hour}}:{{minute}}:{{second}} {{year}} {{user}}
** Last update {{day}} {{month}} {{day}} {{hour}}:{{minute}}:{{second}} {{year}} {{user}}
*/

Big memory leak with --json

There should be circular references somewhere.

Please don't use --json while this bug is not fixed.