Epitech Banana (v4) Coding Style Helper

• Easily install epiclang & banana-coding-style-checker (see here)
• Remove duplicate errors¹
  • Pipe current command: make 2>&1 | cs2
  • cs2 run <command>
• Finds your build system² and builds it automatically
• Ignores all errors from files in your .gitignore
• CI friendly (GitHub Actions here)

There are multiple ways to use cs2.

cs2

Only running cs2 will automatically find your build system, recompile your project by using epiclang and banana.

Warning: your project must need to support changing environment variables like CC to use epiclang.

Enable parallelism with -j

cs2 -j
cs2 -j2 # You can specify the amount of threads like that

If in your Makefile, you're compiling other Makefiles (typically make -C lib/my) that are needed for your final linkage, make sure that you use the .NOTPARALLEL rule to run them in order.

Don't ignore .gitignore errors (--no-ignore)

cs2 --no-ignore

CI mode with --ci

(Only GitHub is supported for now)

cs2 --ci=github

• GNU Makefile

To be supported in the future (or send a PR to make it work :-)):

• CMake (in the future)

epiclang main.c 2>&1 | cs2
cs2 run epiclang main.c

Both of these commands will run epiclang main.c and format the error output with cs2.

Mark the usage of 2>&1 for piping into cs2 which is necessary.

Requirements:

• Rust
• Cargo
• clang (>= 20)
• CMake
• LLVM
• llvm-libs

Use the install.sh script:

curl -s https://raw.githubusercontent.com/hugoarnal/cs2/main/install.sh | sh

You can also clone the repo directly to /usr/local/share/cs2 then run compile.sh:

git clone https://github.com/hugoarnal/cs2.git /tmp/cs2-cs2
sudo mkdir -p /usr/local/share/cs2
/tmp/cs2-cs2/compile.sh
sudo mv /tmp/cs2-cs2 /usr/local/share/cs2/cs2

After installing cs2, you can install epiclang package and banana plugin with:

cs2 install

You can update the packages with:

cs2 update

Only need to update a single package? Use cs2 install/update --package:

cs2 install --package banana
cs2 update --package banana

Parallelism is supported to install banana faster:

See Flags section of Build system to know more about -j flags.

cs2 install --package banana -j
cs2 update --package banana -j

Force rebuild/copy (force build even with if there is no update) (cs2 update only):

cs2 update --package banana --force