CrNormz

<h1 align="center"> <br> <a href="https://github.com/CustomEntity/crNormz"><img src="assets/readme/logo.png" alt="logo"></a> <br> crNormz <br> </h1> <h4 align="center">The most awesome norminette made using <a href="https://crystal-lang.org" target="_blank">Crystal</a>.</h4> <p align="center"> <img alt="APM" src="https://img.shields.io/apm/l/vim-mode"> <a href="https://github.com/CustomEntity/crNormz/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/CustomEntity/crNormz?color=yellow"></a> <a href="https://discord.gg/ryTcYu26Gy"><img alt="Discord" src="https://img.shields.io/badge/discord-join--us-green"></a> <a href="https://github.com/CustomEntity/crNormz/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/CustomEntity/crNormz?color=yellow"></a> </p> <p align="center"> <a href="#project-description">Project Description</a> • <a href="#installation">Installation</a> • <a href="#how-to-use">How to use</a> • <a href="#features">Features</a> • <a href="#benchmarks">Benchmarks</a> • <a href="#credits">Credits</a> </p> <p align="center"> <img src="assets/readme/project.gif" alt="project.gif"/> </p>

Project Description

crNormz is a norm checking program developed using Crystal so that students can check for compliance with the EPITECH standard. This linter is currently the fastest, most reliable and most accurate, see <a href="#benchmarks">Benchmarks</a>

Installation

To clone and run this application, you'll need Git installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/CustomEntity/crNormz

# Go into the repository
$ cd crNormz

# Install the norminette
$ sudo ./crnormz_installer.sh

How to use

# Show help
$ crnormz -h

Usage: crnormz [-fgtlh]
    -f, --ignore-file=               Ignore file from the checker
    -g, --ignore-function=           Ignore forbidden functions
    -t, --ignore-type=               Ignore errors of a specific type
    -l, --ignore-level=              Ignore errors of a specific level (Major, Minor or Info)
    -r, --raw-output                 Enables easy parsing for applications
    -h, --help                       Show this help

# Run the norminette
$ crnormz

# Run the norminette excludind all .o files
$ crnormz -f "*.o"

# Run the norminette without checking the forbidden functions (printf and scanf)
$ crnormz -g "printf,scanf"

# Run the norminette excluding all O1 rules
$ crnormz -t "O1"

# Run the norminette excluding all info level rules
$ crnormz -l "info"

# Sort files alphabetically
$ crnormz -s

# Run the norminette without text formatting
$ crnormz -r

Features

<h3>⚠️ crNormz does not support comments and quotes at the moment</h3>

| Type | Description | State | |------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------:|:-----------------------------------------------------------:| | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> O1 | Useless file for compilation | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> O2 | Invalid .c file source code | <font style="font-size: 16px;">🔨</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> O3 | Too many functions in a file (> 5 functions) | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> O4 | File name not in <i>snake_case</i> | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> G1 | EPITECH header not found or invalid | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G2 | Functions must be separated by a single line | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G3 | Preprocessor directives must be indented according to the level of indirection | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G4 | Global variable not constant | <font style="font-size: 16px;">🔨</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G5 | Static global variables and functions | <font style="font-size: 16px;">🔨</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> G6 | Include directive should only include header .h files | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G7 | Line endings must be done in UNIX style (with \n) | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G8 | No trailing spaces must be present at the end of a line | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> G9 | No more than 1 trailing empty line must be present | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F2 | Function name not in <i>snake_case</i> | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F3 | Too many columns (> 80 columns) | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F4 | Too many lines in function (> 20 lines) | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F5 | Too many parameters in function (> 4 parameters) | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F5 | Missing 'void' parameter in case of function without arguments | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> F6 | Comments within a function | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> F7 | Nested functions | <font style="font-size: 16px;">🔨</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> L1 | Multiple assignments on the same line | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> L2 | Bad indentation | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> L3 | Missing space after a keyword | <font style="font-size: 16px;">🔨</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> L4 | Misplaced bracket | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/minor.png" width="16" vertical-align="middle"/> L6 | Line jumps | <font style="color: green; font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> V1 | The type names defined with typedef should end with _t | <font style="font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> V1 | All identifier names should be according to the <i>snake_case</i> convention | <font style="font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> V1 | The names of macros should be written in UPPER_CASE | <font style="font-size: 16px;">✓</font> | | <img src="assets/readme/major.png" width="16" vertical-align="middle"/> V1 | The content of enums should be written in UPPER_CASE | <font style="font-size: 16px;">✓</font> | | <im