Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 5.09 KB

README.md

File metadata and controls

94 lines (65 loc) · 5.09 KB
Raw

cpbooster · GPLv3 license npm version npm

Competitive Programming Booster 🡲 https://searleser97.github.io/cpbooster/

About

cpbooster is a cross-platform CLI tool designed to boost competitive programmer's speed during contests by automating various routine tasks like compiling and testing, debugging, cloning testcases, loading template, etc. The console command suits any coding environment (i.e. VSCode, Jetbrains IDEs, Vim, Emacs, Geany, Sublime Text, ...) and it’s very easy to use. Vim / NeoVim users can install cpbooster.vim plugin to boost their speed even more.

Using NeoVim:

video-demo-min

For Installation and Setup Instructions Visit cpbooster Website

https://searleser97.github.io/cpbooster/

Features

  1. cpbooster comes with a short alias command called cpb to avoid writing the long command each time

  2. Automatically clone sample testcases files with corresponding source code files with template loaded into a desired directory

    • cpb clone waits for competitive companion plugin to send parsed data for each problem

  3. Test your code against sample testcases quickly

    • cpb test mycode.cpp test your program against all available test cases
    • cpb test mycode.cpp -t 1 test your program against the test case with the given id
    • cpb test /some/path/mycode.cpp test a program that is not located in your current location

    Supported results:

    • AC (Accepted)
    • WA (Wrong Answer) Shows differences between accepted output and your output beautifully
    • TLE (Time Limit Exceeded)
    • RTE (Runtime Error)
    • CE (Compilation Error)

  4. Run code with your own debugging flags easily

    • cpb test mycode.cpp -d to use keyboard as input
    • cpb test mycode.cpp -t 2 -d to use a test case file as input
    • cpb test /some/path/mycode.cpp -d debug a program that is not located in your current location

  5. Submit your code from the terminal really quickly.

    • cpb submit mycode.cpp submits your file to the corresponding judge.

  6. open your preferred editor in the contest directory immediately after cloning it. See Editors

  7. Create source files with corresponding template loaded

    • cpb create a.py creates single file with corresponding template loaded based on file extension
    • cpb create {a..n}.cpp creates multiple consecutive files from "a.cpp" to "n.cpp"
    • cpb create {a...n}.cpp same as previous command (Any amount of dots greater than 1 work)
    • cpb create {a-n}.cpp same as previous command (Single dash also works)
    • cpb create /some/path/a.cpp creates "a.cpp" in the specified path instead of current location
    • cpb create /some/path/{a-n}.cpp creates "a.cpp ... n.cpp" in the specified path instead of current location

  8. Vim plugin cpbooster.vim boosts your speed even more

  9. Flat File Structure. See Why Flat File Structure

How to Contribute

  1. Fork this repository and clone it locally: git clone https://github.com/{yourUsername}/cpbooster
  2. cd (change directory) to cpbooster repo directory
  3. Install dependencies: run npm install
  4. Install cpbooster from source: npm run install:dev
  5. Make code changes

Before making a Pull Request

  1. Lint your code and fix possible linting errors: npm run lint
  2. Verify all tests pass: npm t

Recommended VSCode extensions

Future Updates (work not started yet)

  • add --here option to cpb clone to clone testcases in current directory
  • Add Memory Limit Exceeded Veredict (using gnu-time as /usr/bin/time -f '%M' ./program, can't use ps due to lack of precision. See https://stackoverflow.com/a/131346/13079132)
  • Add the possibility to test interactive problems
  • Add Stress tests (using brute force solution and tests generator)
  • Add the possibility to test current file using test cases of another file (test --as <filename>)
  • Add the possibility to debug current file using test cases of another file (test --as <filename> -d)
  • Fully support windows CMD.
  • Add support for NODE_ENV in compile/debug command for debugging purposes.

Final Notes

  • I am open to feature requests.
  • Pull Requests are also welcome.

License

cpbooster is licensed under the GNU General Public License v3.0