NormEZ

NormEZ copied to clipboard

Coding-style checker for Epitech students. This program analyzes your C and Haskell source files for Epitech C coding-style and Epitech Haskell coding-style violations.

[French] Moulinette de norme pour les étudiants d'Epitech. Cette norminette cherche des erreurs de norme C Epitech et de norme Haskell Epitech dans vos fichers de code source C et Haskell.

Table of contents

• Getting started
  • Requirements
  • How to use NormEZ?
• Options
• Features
• To-do
• Bugs
  • Known issues
  • Report a bug
• Getting involved
  • Share
  • Contribute
  • Contributors

Getting started

Requirements

• Ruby

Installing Ruby on Fedora (Epitech's 2017 dump)

sudo dnf install ruby

How to use NormEZ?

1. Clone the repository:

   git clone https://github.com/ronanboiteau/NormEZ
   

2. Run make install to install NormEZ or make uninstall to uninstall it
3. Run NormEZ:

   normez
   

4. NormEZ will recursively search for .c and .h files to analyze in your current directory.
5. You can also pass specific files to check as argument:

   normez src/*.c src/*.h
   

Options

• -u or --no-update: don't check for NormEZ updates
• -f or --ignore-files: ignore forbidden files
• -m or --ignore-functions: ignore forbidden functions
• -i or --ignore-all: ignore forbidden files & forbidden functions (same as -fm)
• -c or --colorless: disable all styling on output

Features

Coding-style violations checked by NormEZ.

= major infraction
= minor infraction

C

Lines with too many columns (> 80).
Forbidden files: every regular file that does not match Makefile, *.c or *.h (ex: *.o, *.gch, bsq, ...) & that is not mentioned in a .gitignore file located in your current working directory.
[Not exhaustive] Too broad filenames (ex: string.c, algo.c, my_algorithm.c, ...).
Missing or corrupted header in sources files (.c), headers (.h) & Makefiles.
Functions that contain more than 20 lines.
Several semicolon-separated assignments on the same line.
[Not exhaustive] Forbidden functions (printf(), dprintf(), atoi(), memcpy(), scanf(), strlen()...).
Trailing space(s) and/or tabulation(s) at the end of a line.
Filenames that don't respect the snake_case naming convention.
Condition and assignment on the same line.
Directory names that don't respect the snake_case naming convention.
Too many functions in file (> 5).
Functions with no parameters that don't take void as argument in their declaration.
Functions with too many arguments (> 4).
Space(s) in indentation.
Missing space after keyword.
Misplaced pointer symbol(s).
Macros used for constants.
Macros containing multiple assignments.
Too many else if statements.
Misplaced comments.
Missing space after comma.
Missing space around binary or ternary operator (=, ==, !=, <=, >=, &&, ||, +=, -=, *=, /=, %=, &=, ^=, |=, |, ^, >>, <<, >>=, <<=).
Extra space after unary operators (!, sizeof, ++, --).
Forbidden keyword (goto).
Functions must be separated by one and only one empty line in .c files.

Haskell

Lines with too many columns (> 80).
Functions that contain more than 10 lines.
Filenames that don't respect the UpperCamelCase naming convention.
Imbedded if blocks.
Mutable variables used.
Missing type signatures.
Useless do.
[Not exhaustive] Guards that should be pattern matching.

To-do

Coding-style violations NOT YET checked by NormEZ.

= major infraction
= minor infraction

C

Typedef not ending with _t.
Identifiers that don't respect the snake_case naming convention.
Macros, global constants or enums that don't respect the SNAKE_CASE convention (uppercase snake_case).
Function prototypes, typedefs, global variables, macros or static inline functions in .c source files.
Single-letter identifiers shouldn't be named l (lowercase L) or o to avoid confusions. Nested conditonal branchings (depth > 2).
Header files not protected against double inclusion
Wrong indentation level in .c and .h files.
Wrong indentation level in pre-processor directives.
Extra space between function name and opening parenthesis.
Misplaced curly brackets.
Multiple variables declared on the same line.
Variable not declared at the beginning of function.
Missing empty line after variable declarations.
Extra empty lines in function.

Haskell

Naming identifiers according to the lowerCamelCase convention.
Forbidden language extentions.
Contents of delivery folder

Bugs

Known issues

• NormEZ doesn't make the difference between strings/comments & code. Examples: a commented forbidden function will be flagged, as well as a commented ; (multiple assignments on the same line), etc.
• The check for functions containing more than 20 lines doesn't work yet with the new coding style v3.1. See related issue.
• For Haskell, the check of guards that should be expressed as pattern matching is not very accurate, it flags guards that use only direct comparisons (or ==)

Report a bug

If you found a bug that isn't listed above in as a known issue, feel free to create a GitHub issue.

Getting involved

Share

• Enjoying NormEZ? Leave it a star to show your support :)
• And share the link to this repository with your friends at Epitech!

Contribute

You want to add awesome features to NormEZ? Here's how:

1. Fork NormEZ
2. Commit & push a new feature to the forked repository
3. Open a pull request so I can merge your work into this repository :)

Contributors

Here is the list of NormEZ's contributors. Thanks to everyone who helped developing this project!