proffapt/code-runner: Implementation of code-runner in bash for compiling code files and executing them with one and only command · GitHub

execute code files with ease
Explore the docs »

Report Bug · Request Feature

1. About The Project
   • Why this Code Runner?
2. Getting Started
   • Installation
   • Uninstallation
3. Usage
   • Examples
4. Integrating with vscode
5. Integrating with vim
6. Contact
7. Acknowledgments
8. Miscelleneous

This is a script, which compiles the code file and run it for you and delete other junk files if created during the process of compilation, all this with one command for all the languages supported by it. No more remembering different arguments for different compilers to compile, execut and debug the code.

• Can detect correct version of python with 90% accuracy.
• Has inbuilt debugger support.
• Custom made keybindings for vim and vscode.
• Robust code, deals with all possible cases.
  • Can execute files with spaces in their names.
  • Can execute from any location.
• Automatically cleans executable files by default.
• Highest number of languages supported compared to its alternatives.

(back to top)

To install and configure the project on your system locally, use suitable method:

• Using curl
• Using brew

1. Copy and run the following command to install the run binary on your system.

   curl https://raw.githubusercontent.com/proffapt/code-runner/main/.setup/install.sh | bash

2. Run the code

   run my_code.c

   OR

   run ~/path/to/my_code.c

brew tap proffapt/brewtap
brew install code-runner

(back to top)

To uninstall the tool from your system execute the following command, depending upon your installation

• Using curl
• Using brew

curl https://raw.githubusercontent.com/proffapt/code-runner/main/.setup/uninstall.sh | bash

brew uninstall code-runner

(back to top)

(back to top)

• Compilation and Execution

  

• Debugging

  

• Python

  

(back to top)

Create custom keybindings for vscode to use this script more conveniently in vscode, you can copy my keybindings from vscode-keybindings into your keybindings.json

• alt+space

  • If there is no instance of terminal: Spawns a new terminal > shifts the focus to it.
  • If the instance already exists and focus is on editor pane: Focuses the terminal.
  • If the focus is on terminal: Focuses the editor pane keeping the terminal at it's place.

• cmd+contextmenu -- use twice for execution

  • If there is no terminal instance: Spawns a new terminal > shifts focus to it(DOESN"T EXECUTE THE CODE, press again to execute the code).
  • If instance exists and focus is on editor pane: Shifts focus to terminal(DOESN"T EXECUTE THE CODE, press again to execute the code).
  • If the focus is on terminal: Executes the code.

  ^ NOTE: Code execution is also possible even if the code file is not directly inside the folder opened in vscode.

Stores previous execution history, as there is no new terminal created everytime, it's created only when not present else uses the same terminal

(back to top)

Create custom keybindings for {Neo}vim to use this script more conveniently in {Neo}vim, you can copy my keybindings from the following files to your vim configuration file.

• For .{n}vimrc type configs
• For lua type configs

• rr

  • In NORMAL mode: Saves the file > creates a new floaterm buffer > shifts focus to it > runs the code(CLOSE the buffer with any key after completion of execution).

Doesn't store previous execution history, as there is a new buffer created everytime

• ff

  • In NORMAL mode with no existing floaterm buffer: Saves the file > creates a new floaterm buffer > shifts focus to it > runs the code.
  • In NORMAL mode with existing floaterm buffer but focus on code buffer: Saves the file > shifts focus to floaterm buffer > runs the code.
  • In NORMAL mode with existing floaterm buffer and focus on flaoterm buffer: Hides the floaterm buffer > focuses on the working file's buffer.
  • In TERMINAL mode: Hides active floaterm buffer > focuses on the working file's buffer.

Stores previous execution history, as there is no new buffer created everytime, it's created only when not present else uses the same buffer

(back to top)

📫 Arpit Bhardwaj ( aka proffapt ) -

(back to top)

• Choose an Open Source License
• Img Shields
• Bash filename manipulation

(back to top)

Do consider looking at other paradigms of this documentation

• Change-logs
• License used
• Code Of Conduct
• How to contribute?

(back to top)