mango

README

Introduction

'mango' is a Command Line Interface(CLI) based task parser and tester for popular online judge 'Codeforces'. It supports the regular contest and gym. All of the functionalities of this CLI works for only C++ language.

Screenshots

Download

Head over to the release page to download the latest mango that is compatible with your system and os.

Installation

We have to setup the mango globally so that we can run commands from anywhere through the Command Prompt or Terminal.

Windows:

1. Keep 'mango.exe' in any folder you prefer
2. Add the folder path from step 1 to System Variable Path. (How to add path in System Var? See here: https://www.architectryan.com/2018/03/17/add-to-the-path-on-windows-10/)
3. Open Command Prompt and run mango version to test if everything works fine.

Mac:

1. Keep 'mango' executable file at /usr/local/bin folder
2. Change the permission of the file by chmod +x mango command.
3. Open Terminal and run mango version to test if everything works fine.

Linux:
May be similar to mac. Didn't try in linux.

Configuration

1. Set default programs(like Sublime Text, VS Code, Code Blocks etc.) to open .cpp & .json files. (How to change default programs in windows? See here: https://www.digitaltrends.com/computing/how-to-change-file-associations/)
2. Open command prompt and run 'mango configure'. It will open config.json file. Or in windows, go to AppData>Roaming>mango, you'll find the config.json file there. Now configure as you prefer. But DO NOT CHANGE the OJ and Host property. The config.json file looks like the following..

{
 "Workspace": 		"C:/Users/SkMonir/Desktop/Contest",
 "CompilationCommand":  "g++",
 "CompilationArgs": 	"-std=c++17",
 "CurrentContestId": 	"1520",
 "OJ": 			"codeforces",
 "Host": 		"https://codeforces.com",
 "TemplatePath": 	"C:/Users/SkMonir/Desktop/Contest/template.cpp",
 "Author": 		"skmonir"
}

1. Set 'Workspace' as the full path of the folder where all of the contest sources and testcases will be stored
2. Set 'TemplatePath' as the full path of your template file. If you ommit TemplatePath, a default template will be created for the source file.
3. Set 'Author' as your username/handle or anything name you prefer. It will be used in your template.
4. We don't necessarily need to set 'CurrentContestId' from here. See the Available Commands section to know how it is set.
5. Enjoy!

NOTE: DO NOT USE any variable as configuration value. For example, do not use ~/contest, rather use /home/user/contest for directory path.

Workspace Structure:

workspace
├── codeforces
│   └── 1521
│       ├── src
│       │   ├── A.cpp
│       │   ├── B.cpp
│       │   │
│       │   │
│       │   └── E.cpp
│       ├── testcase
│       │   ├── A.json
│       │   ├── B.json
│       │   │
│       │   │
│       │   └── E.json

Command Format

mango <command> <argument>

=> Only configure, version and help commands don't need any argument.
=> For other comamnds, the argument format is <contest_id><problem_id>. But both <contest_id>and <problem_id> are optional for corresponding command.

Available Commands as example

All of the commands can be run from Command Prompt or Terminal.

1. mango setc 1521: sets current working contest ID

2. mango configure: opens the config.json file to update & save configuration

3. mango parse 1521: command 1 + parses samples of all the problems for specified contest ID

4. mango parse 1521A: command 1 + parses samples of Problem A for specified contest ID

5. mango source 1521A: creates source file of Problem A for specified contest ID

6. mango source A: creates source file of Problem A for current working contest ID

7. mango open 1521: opens all the source files in the default editor for specified contest ID

8. mango open 1521A: opens source file of Problem A in the default editor for specified contest ID

9. mango open A: opens source file of Problem A in the default editor for current working contest ID

10. mango create 1521: combination of commands (1, 3, 7) for specified contest ID

11. mango create 1521A: combination of commands (1, 4, 6, 8) for Problem A

12. mango compile 1521A: compiles source file of Problem A for specified contest ID

13. mango compile A: compiles source file of Problem A for current working contest ID

14. mango test 1521A: command 12 + tests Problem A for specified contest ID

15. mango test A: command 13 + tests Problem A for current working contest ID

16. mango version: shows the current mango version

17. mango help: shows help docs

NOTE: The source and testcase filenames are CASE SENSITIVE in Mac and Linux. The filenames are parsed from Codeforces problem name labels(such as A, B, F1, F2 etc.). So BE CAREFULL when using the problem ID in commands, it should be as same as the filename.

Configure mango with Sublime Text [for Sublime Text users only]

Apart from running our program in command prompt in windows, we can also directly test our program from Sublime Text through the custom build system. To configure the sublime build system in Windows, please follow the instructions below..

1. From Sublime Text menubar, go to Tools > Build System > New Build System. It will open a file.
2. Delete the content from the file and copy & paste the following code.

{
  "file_regex": "^(..[^:]*):([0-9]+):?([0-9]+)?:? (.*)$",
  "working_dir": "${file_path}",
  "selector": "source.c, source.cc, source.c++, source.cpp",

  "variants":
  [
  	{
  		"name": "RunOnCmdPrompt",
  		"shell_cmd": "g++ -O2 -static -std=gnu++17 \"${file}\" -o \"${file_base_name}\" && start cmd /k \"${file_base_name} & pause & exit\""
  	},
  	{
  		"name": "RunOnMangoTester",
  		"shell_cmd": "start cmd /k mango test \"${file_base_name}\" & pause & exit\""
  	}
  ]
}

1. Press Ctrl+S to save the file. Give it a name like cpp_custom_build.sublime-build and save.
2. Go to Tools > Build System. We will find our custom build name(i.e cpp_custom_build) in the list. Select the build name.
3. Now create a problem or contest by 'mango create' command and write the code.
4. To test our code from mango, we have to select our build variant only for once. Go to Tools > Build With (Shortcut CtrlShiftB), a pop-up will appear on top-center of the screen. Select cpp_custom_build - RunOnMangoTester from the pop-up. Now for every test, just go to Tools > Build and a console will open with the test result.
5. To run our program from Command Prompt for custom testing, we need to change our build variant like the previous step. But in this case we will select cpp_custom_build - RunOnCmdPrompt from the pop-up. Now go to Tools > Build to run the program and it will open a console where we can give input and see output for the program.