[{"result":{"data":[{"id":"9ee7c54a-368c-4997-91c4-821cc55e8a54","title":"feat!: neovim-style single command","text":"feat!: neovim-style single command","type":"breaking-change","createdAt":"2023-07-27T02:18:56.046Z","breakingChange":{"id":16,"postId":"9ee7c54a-368c-4997-91c4-821cc55e8a54","pluginId":582,"externalUrl":"https://github.com/xeluxee/competitest.nvim/commit/254a81b0617284d41b0a5f72a8b7fb6ffb73d0a0","sha":"254a81b0617284d41b0a5f72a8b7fb6ffb73d0a0","plugin":{"id":582,"owner":"xeluxee","name":"competitest.nvim","type":"github","source":"awesome-neovim","category":"competitive-programming","link":"https://github.com/xeluxee/competitest.nvim","shortDescription":"CompetiTest.nvim is a Neovim plugin for Competitive Programming: it can manage and check testcases, download problems and contests from online judges and much more","createdAt":"2023-03-22T19:35:21.676Z","readme":"# CompetiTest.nvim\n\n

\n\n![Neovim](https://img.shields.io/badge/NeoVim-0.5+-%2357A143.svg?&style=for-the-badge&logo=neovim)\n![Lua](https://img.shields.io/badge/Lua-%232C2D72.svg?style=for-the-badge&logo=lua)\n![License](https://img.shields.io/github/license/xeluxee/competitest.nvim?style=for-the-badge&logo=gnu)\n\n## Competitive Programming with Neovim made Easy\n\n\n![competitest_popup_ui](https://user-images.githubusercontent.com/88047141/149839002-280069e5-0c71-4aec-8e39-4443a1c44f5c.png)\n*CompetiTest's popup UI*\n\n![competitest_split_ui](https://user-images.githubusercontent.com/88047141/183751179-e07e2a4d-e2eb-468b-ba34-bb737cba4557.png)\n*CompetiTest's split UI*\n

\n\n`competitest.nvim` is a testcase manager and checker. It saves you time in competitive programming contests by automating common tasks related to testcase management. It can compile, run and test your solutions across all the available testcases, displaying results in a nice interactive user interface.\n\n## Features\n- Multiple languages supported: it works out of the box with C, C++, Rust, Java and Python, but other languages can be [configured](#customize-compile-and-run-commands)\n- Flexible. No strict file-naming rules, optional fixed folder structure. You can choose where to put the source code file, the testcases, the received problems and contests, where to execute your programs and much more\n- Configurable (see [Configuration](#configuration)). You can even configure [every folder individually](#local-configuration)\n- Testcases can be stored in a single file or in multiple text files, see [usage notes](#usage-notes)\n- Easily [add](#add-or-edit-a-testcase), [edit](#add-or-edit-a-testcase) and [delete](#remove-a-testcase) testcases\n- [Run](#run-testcases) your program across all the testcases, showing results and execution data in a nice interactive UI\n- [Download](#receive-testcases-problems-and-contests) testcases, problems and contests automatically from competitive programming platforms\n- [Templates](#templates-for-received-problems-and-contests) for received problems and contests\n- View diff between actual and expected output\n- [Customizable interface](#customize-ui-layout) that resizes automatically when Neovim window is resized\n- Integration with [statusline and winbar](#statusline-and-winbar-integration)\n- Customizable [highlight groups](#highlights)\n\n## Installation\n**NOTE:** this plugins requires Neovim ≥ 0.5\n\nInstall with `vim-plug`:\n``` vim\nPlug 'MunifTanjim/nui.nvim' \" it's a dependency\nPlug 'xeluxee/competitest.nvim'\n```\n\nInstall with `packer.nvim`:\n``` lua\nuse {\n\t'xeluxee/competitest.nvim',\n\trequires = 'MunifTanjim/nui.nvim',\n\tconfig = function() require('competitest').setup() end\n}\n```\n\nInstall with `lazy.nvim`:\n``` lua\n{\n\t'xeluxee/competitest.nvim',\n\tdependencies = 'MunifTanjim/nui.nvim',\n\tconfig = function() require('competitest').setup() end,\n}\n```\n\nIf you are using another package manager note that this plugin depends on [`nui.nvim`](https://github.com/MunifTanjim/nui.nvim), hence it should be installed as a dependency.\n\n## Usage\nTo load this plugin call `setup()`:\n``` lua\nrequire('competitest').setup() -- to use default configuration\n```\n``` lua\nrequire('competitest').setup { -- to customize settings\n\t-- put here configuration\n}\n```\nTo see all the available settings see [configuration](#configuration).\n\n### Usage notes\n- Your programs must read from `stdin` and print to `stdout`. If `stderr` is used its content will be displayed\n- A testcase is made by an input and an output (containing the correct answer)\n- Input is necessary for a testcase to be considered, while an output hasn't to be provided necessarily\n- Testcases can be stored in multiple text files or in a single [msgpack](https://msgpack.org/) encoded file\n\t- You can choose how to store them with `testcases_use_single_file` boolean option in in [configuration](#configuration). By default it's false, so multiple files are used\n\t- Storage method can be automatically detected when option `testcases_auto_detect_storage` is true\n\t- If you want to change the way already existing testcases are stored see [conversion](#convert-testcases)\n\n#### Storing testcases in multiple text files\n- To store testcases in multiple text files set `testcases_use_single_file` to false\n- Files naming shall follow a rule to be recognized. Let's say your file is called `task-A.cpp`. If using the default configuration testcases associated with that file will be named `task-A_input0.txt`, `task-A_output0.txt`, `task-A_input1.txt`, `task-A_output1.txt` and so on. The counting starts from 0\n- Of course files naming can be configured: see `testcases_input_file_format` and `testcases_output_file_format` in [configuration](#configuration)\n- Testcases files can be put in the same folder of the source code file, but you can customize their path (see `testcases_directory` in [configuration](#configuration))\n\n#### Storing testcases in a single file\n- To store testcases in a single file set `testcases_use_single_file` to true\n- Testcases file naming shall follow a rule to be recognized. Let's say your file is called `task-A.cpp`. If using the default configuration testcases file will be named `task-A.testcases`\n- Of course single file naming can be configured: see `testcases_single_file_format` in [configuration](#configuration)\n- Testcases file can be put in the same folder of the source code file, but you can customize its path (see `testcases_directory` in [configuration](#configuration))\n\nAnyway you can forget about these rules if you use `:CompetiTest add_testcase` and `:CompetiTest edit_testcase`, that handle these things for you.\n\nWhen launching the following commands make sure the focused buffer is the one containing the source code file.\n\n### Add or Edit a testcase\nLaunch `:CompetiTest add_testcase` to add a new testcase.\\\nLaunch `:CompetiTest edit_testcase` to edit an existing testcase. If you want to specify testcase number directly in the command line you can use `:CompetiTest edit_testcase x`, where `x` is a number representing the testcase you want to edit.\n\nTo jump between input and output windows press either ``, ``, or ``. To save and close testcase editor press `` or `:wq`.\n\nOf course these keybindings can be customized: see `editor_ui` ➤ `normal_mode_mappings` and `editor_ui` ➤ `insert_mode_mappings` in [configuration](#configuration)\n\n### Remove a testcase\nLaunch `:CompetiTest delete_testcase`. If you want to specify testcase number directly in the command line you can use `:CompetiTest delete_testcase x`, where `x` is a number representing the testcase you want to remove.\n\n### Convert testcases\nTestcases can be stored in multiple text files or in a single [msgpack](https://msgpack.org/) encoded file.\\\nLaunch `:CompetiTest convert` to change testcases storage method: you can convert a single file into multiple files or vice versa.\nOne of the following arguments is needed:\n- `singlefile_to_files`: convert a single file into multiple text files\n- `files_to_singlefile`: convert multiple text files into a single file\n- `auto`: if there's a single file convert it into multiple files, otherwise convert multiple files into a single file\n\n**NOTE:** this command only converts already existing testcases files without changing CompetiTest configuration. To choose the storage method to use you have to [configure](#configuration) `testcases_use_single_file` option, that is false by default. Anyway storage method can be automatically detected when option `testcases_auto_detect_storage` is true.\n\n### Run testcases\nLaunch `:CompetiTest run`. CompetiTest's interface will appear and you'll be able to view details about a testcase by moving the cursor over its entry. You can close the UI by pressing `q`, `Q` or `:q`.\\\nIf you're using a compiled language and you don't want to recompile your program launch `:CompetiTest run_no_compile`.\\\nIf you have previously closed the UI and you want to re-open it without re-executing testcases or recompiling launch `:CompetiTest show_ui`.\n\n#### Control processes\n- Run again a testcase by pressing `R`\n- Run again all testcases by pressing ``\n- Kill the process associated with a testcase by pressing `K`\n- Kill all the processes associated with testcases by pressing ``\n\n#### View details\n- View input in a bigger window by pressing `i` or `I`\n- View expected output in a bigger window by pressing `a` or `A`\n- View stdout in a bigger window by pressing `o` or `O`\n- View stderr in a bigger window by pressing `e` or `E`\n- Toggle diff view between actual and expected output by pressing `d` or `D`\n\nOf course all these keybindings can be customized: see `runner_ui` ➤ `mappings` in [configuration](#configuration)\n\n### Receive testcases, problems and contests\n**NOTE:** to get this feature working you need to install [competitive-companion](https://github.com/jmerle/competitive-companion) extension in your browser.\n\nThanks to its integration with [competitive-companion](https://github.com/jmerle/competitive-companion), CompetiTest can download contents from competitive programming platforms:\n- Download only testcases with `:CompetiTest receive testcases`\n- Download a problem with `:CompetiTest receive problem` (source file is automatically created along with testcases)\n- Download an entire contest with `:CompetiTest receive contest` (make sure to be on the homepage of the contest, not of a single problem)\n\nAfter launching one of these commands click on the green plus button in your browser to start downloading.\\\nFor further customization see receive options in [configuration](#configuration).\n\n#### Customize folder structure\nBy default CompetiTest stores received problems and contests in current working directory. You can change this behavior through the options `received_problems_path`, `received_contests_directory` and `received_contests_problems_path`. See [receive modifiers](#receive-modifiers) for further details.\\\nHere are some tips:\n- Fixed directory for received problems (not contests):\n\t``` lua\n\treceived_problems_path = \"$(HOME)/Competitive Programming/$(JUDGE)/$(CONTEST)/$(PROBLEM).$(FEXT)\"\n\t```\n- Fixed directory for received contests:\n\t``` lua\n\treceived_contests_directory = \"$(HOME)/Competitive Programming/$(JUDGE)/$(CONTEST)\"\n\t```\n- Put every problem of a contest in a different directory:\n\t``` lua\n\treceived_contests_problems_path = \"$(PROBLEM)/main.$(FEXT)\"\n\t```\n- Example of file naming for Java contests:\n\t``` lua\n\treceived_contests_problems_path = \"$(PROBLEM)/$(JAVA_MAIN_CLASS).$(FEXT)\"\n\t```\n- Simplified file names, it works with Java and any other language because the modifier `$(JAVA_TASK_CLASS)` is generated from problem name removing all non-alphabetic and non-numeric characters, including spaces and punctuation:\n\t``` lua\n\treceived_contests_problems_path = \"$(JAVA_TASK_CLASS).$(FEXT)\"\n\t```\n\n#### Templates for received problems and contests\nWhen downloading a problem or a contest, source code templates can be configured for different file types. See `template_file` option in [configuration](#configuration).\\\n[Receive modifiers](#receive-modifiers) can be used inside template files to insert details about received problems. To enable this feature set `evaluate_template_modifiers` to `true`. Template example for C++:\n``` cpp\n// Problem: $(PROBLEM)\n// Contest: $(CONTEST)\n// Judge: $(JUDGE)\n// URL: $(URL)\n// Memory Limit: $(MEMLIM)\n// Time Limit: $(TIMELIM)\n// Start: $(DATE)\n\n#include \nusing namespace std;\nint main() {\n\tcout << \"This is a template file\" << endl;\n\tcerr << \"Problem name is $(PROBLEM)\" << endl;\n\treturn 0;\n}\n```\n\n## Configuration\n### Full configuration\nHere you can find CompetiTest default configuration\n``` lua\nrequire('competitest').setup {\n\tlocal_config_file_name = \".competitest.lua\",\n\n\tfloating_border = \"rounded\",\n\tfloating_border_highlight = \"FloatBorder\",\n\tpicker_ui = {\n\t\twidth = 0.2,\n\t\theight = 0.3,\n\t\tmappings = {\n\t\t\tfocus_next = { \"j\", \"\", \"\" },\n\t\t\tfocus_prev = { \"k\", \"\", \"\" },\n\t\t\tclose = { \"\", \"\", \"q\", \"Q\" },\n\t\t\tsubmit = { \"\" },\n\t\t},\n\t},\n\teditor_ui = {\n\t\tpopup_width = 0.4,\n\t\tpopup_height = 0.6,\n\t\tshow_nu = true,\n\t\tshow_rnu = false,\n\t\tnormal_mode_mappings = {\n\t\t\tswitch_window = { \"\", \"\", \"\" },\n\t\t\tsave_and_close = \"\",\n\t\t\tcancel = { \"q\", \"Q\" },\n\t\t},\n\t\tinsert_mode_mappings = {\n\t\t\tswitch_window = { \"\", \"\", \"\" },\n\t\t\tsave_and_close = \"\",\n\t\t\tcancel = \"\",\n\t\t},\n\t},\n\trunner_ui = {\n\t\tinterface = \"popup\",\n\t\tselector_show_nu = false,\n\t\tselector_show_rnu = false,\n\t\tshow_nu = true,\n\t\tshow_rnu = false,\n\t\tmappings = {\n\t\t\trun_again = \"R\",\n\t\t\trun_all_again = \"\",\n\t\t\tkill = \"K\",\n\t\t\tkill_all = \"\",\n\t\t\tview_input = { \"i\", \"I\" },\n\t\t\tview_output = { \"a\", \"A\" },\n\t\t\tview_stdout = { \"o\", \"O\" },\n\t\t\tview_stderr = { \"e\", \"E\" },\n\t\t\ttoggle_diff = { \"d\", \"D\" },\n\t\t\tclose = { \"q\", \"Q\" },\n\t\t},\n\t\tviewer = {\n\t\t\twidth = 0.5,\n\t\t\theight = 0.5,\n\t\t\tshow_nu = true,\n\t\t\tshow_rnu = false,\n\t\t\tclose_mappings = { \"q\", \"Q\" },\n\t\t},\n\t},\n\tpopup_ui = {\n\t\ttotal_width = 0.8,\n\t\ttotal_height = 0.8,\n\t\tlayout = {\n\t\t\t{ 4, \"tc\" },\n\t\t\t{ 5, { { 1, \"so\" }, { 1, \"si\" } } },\n\t\t\t{ 5, { { 1, \"eo\" }, { 1, \"se\" } } },\n\t\t},\n\t},\n\tsplit_ui = {\n\t\tposition = \"right\",\n\t\trelative_to_editor = true,\n\t\ttotal_width = 0.3,\n\t\tvertical_layout = {\n\t\t\t{ 1, \"tc\" },\n\t\t\t{ 1, { { 1, \"so\" }, { 1, \"eo\" } } },\n\t\t\t{ 1, { { 1, \"si\" }, { 1, \"se\" } } },\n\t\t},\n\t\ttotal_height = 0.4,\n\t\thorizontal_layout = {\n\t\t\t{ 2, \"tc\" },\n\t\t\t{ 3, { { 1, \"so\" }, { 1, \"si\" } } },\n\t\t\t{ 3, { { 1, \"eo\" }, { 1, \"se\" } } },\n\t\t},\n\t},\n\n\tsave_current_file = true,\n\tsave_all_files = false,\n\tcompile_directory = \".\",\n\tcompile_command = {\n\t\tc = { exec = \"gcc\", args = { \"-Wall\", \"$(FNAME)\", \"-o\", \"$(FNOEXT)\" } },\n\t\tcpp = { exec = \"g++\", args = { \"-Wall\", \"$(FNAME)\", \"-o\", \"$(FNOEXT)\" } },\n\t\trust = { exec = \"rustc\", args = { \"$(FNAME)\" } },\n\t\tjava = { exec = \"javac\", args = { \"$(FNAME)\" } },\n\t},\n\trunning_directory = \".\",\n\trun_command = {\n\t\tc = { exec = \"./$(FNOEXT)\" },\n\t\tcpp = { exec = \"./$(FNOEXT)\" },\n\t\trust = { exec = \"./$(FNOEXT)\" },\n\t\tpython = { exec = \"python\", args = { \"$(FNAME)\" } },\n\t\tjava = { exec = \"java\", args = { \"$(FNOEXT)\" } },\n\t},\n\tmultiple_testing = -1,\n\tmaximum_time = 5000,\n\toutput_compare_method = \"squish\",\n\tview_output_diff = false,\n\n\ttestcases_directory = \".\",\n\ttestcases_use_single_file = false,\n\ttestcases_auto_detect_storage = true,\n\ttestcases_single_file_format = \"$(FNOEXT).testcases\",\n\ttestcases_input_file_format = \"$(FNOEXT)_input$(TCNUM).txt\",\n\ttestcases_output_file_format = \"$(FNOEXT)_output$(TCNUM).txt\",\n\n\tcompanion_port = 27121,\n\treceive_print_message = true,\n\ttemplate_file = false,\n\tevaluate_template_modifiers = false,\n\tdate_format = \"%c\",\n\treceived_files_extension = \"cpp\",\n\treceived_problems_path = \"$(CWD)/$(PROBLEM).$(FEXT)\",\n\treceived_problems_prompt_path = true,\n\treceived_contests_directory = \"$(CWD)\",\n\treceived_contests_problems_path = \"$(PROBLEM).$(FEXT)\",\n\treceived_contests_prompt_directory = true,\n\treceived_contests_prompt_extension = true,\n\topen_received_problems = true,\n\topen_received_contests = true,\n\treplace_received_testcases = false,\n}\n```\n\n#### Explanation\n- `local_config_file_name`: you can use a different configuration for every different folder. See [local configuration](#local-configuration)\n- `floating_border`: for details see [here](https://github.com/MunifTanjim/nui.nvim/tree/main/lua/nui/popup#borderstyle)\n- `floating_border_highlight`: the highlight group used for popups border\n- `picker_ui`: settings related to the testcase picker\n\t- `width`: a value from 0 to 1, representing the ratio between picker width and Neovim width\n\t- `height`: a value from 0 to 1, representing the ratio between picker height and Neovim height\n\t- `mappings`: keyboard mappings to interact with picker\n- `editor_ui`: settings related to the testcase editor\n\t- `popup_width`: a value from 0 to 1, representing the ratio between editor width and Neovim width\n\t- `popup_height`: a value from 0 to 1, representing the ratio between editor height and Neovim height\n\t- `show_nu`: whether to show line numbers or not\n\t- `show_rnu`: whether to show relative line numbers or not\n\t- `switch_window`: keyboard mappings to switch between input window and output window\n\t- `save_and_close`: keyboard mappings to save testcase content\n\t- `cancel`: keyboard mappings to quit testcase editor without saving\n- `runner_ui`: settings related to testcase runner user interface\n\t- `interface`: interface used to display testcases data. Can be `popup` (floating windows) or `split` (normal windows). Associated settings can be found in `popup_ui` and `split_ui`\n\t- `selector_show_nu`: whether to show line numbers or not in testcase selector\n\t- `selector_show_rnu`: whether to show relative line numbers or not in testcase selector\n\t- `show_nu`: whether to show line numbers or not in details windows\n\t- `show_rnu`: whether to show relative line numbers or not in details windows\n\t- `mappings`: keyboard mappings used in testcase selector window\n\t\t- `run_again`: keymaps to run again a testcase\n\t\t- `run_all_again`: keymaps to run again all testcases\n\t\t- `kill`: keymaps to kill a testcase\n\t\t- `kill_all`: keymaps to kill all testcases\n\t\t- `view_input`: keymaps to view input (stdin) in a bigger window\n\t\t- `view_output`: keymaps to view expected output in a bigger window\n\t\t- `view_stdout`: keymaps to view programs's output (stdout) in a bigger window\n\t\t- `view_stderr`: keymaps to view programs's errors (stderr) in a bigger window\n\t\t- `toggle_diff`: keymaps to toggle diff view between actual and expected output\n\t\t- `close`: keymaps to close runner user interface\n\t- `viewer`: keyboard mappings used in [viewer window](#view-details)\n\t\t- `width`: a value from 0 to 1, representing the ratio between viewer window width and Neovim width\n\t\t- `height`: a value from 0 to 1, representing the ratio between viewer window height and Neovim height\n\t\t- `show_nu`: whether to show line numbers or not in viewer window\n\t\t- `show_rnu`: whether to show relative line numbers or not in viewer window\n\t\t- `close_mappings`: keymaps to close viewer window\n- `popup_ui`: settings related to testcase runner popup interface\n\t- `total_width`: a value from 0 to 1, representing the ratio between total interface width and Neovim width\n\t- `total_height`: a value from 0 to 1, representing the ratio between total interface height and Neovim height\n\t- `layout`: a table describing popup UI layout. For further details see [here](#customize-ui-layout)\n- `split_ui`: settings related to testcase runner split interface\n\t- `position`: can be `top`, `bottom`, `left` or `right`\n\t- `relative_to_editor`: whether to open split UI relatively to entire editor or to local window\n\t- `total_width`: a value from 0 to 1, representing the ratio between total **vertical** split width and relative window width\n\t- `vertical_layout`: a table describing vertical split UI layout. For further details see [here](#customize-ui-layout)\n\t- `total_height`: a value from 0 to 1, representing the ratio between total **horizontal** split height and relative window height\n\t- `horizontal_layout`: a table describing horizontal split UI layout. For further details see [here](#customize-ui-layout)\n- `save_current_file`: if true save current file before running testcases\n- `save_all_files`: if true save all the opened files before running testcases\n- `compile_directory`: execution directory of compiler, relatively to current file's path\n- `compile_command`: configure the command used to compile code for every different language, see [here](#customize-compile-and-run-commands)\n- `running_directory`: execution directory of your solutions, relatively to current file's path\n- `run_command`: configure the command used to run your solutions for every different language, see [here](#customize-compile-and-run-commands)\n- `multiple_testing`: how many testcases to run at the same time\n\t- set it to `-1` to make the most of the amount of available parallelism. Often the number of testcases run at the same time coincides with the number of CPUs\n\t- set it to `0` if you want to run all the testcases together\n\t- set it to any positive integer to run that number of testcases contemporarily\n- `maximum_time`: maximum time, in milliseconds, given to processes. If it's exceeded process will be killed\n- `output_compare_method`: how given output (stdout) and expected output should be compared. It can be a string, representing the method to use, or a custom function. Available options follows:\n\t- `\"exact\"`: character by character comparison\n\t- `\"squish\"`: compare stripping extra white spaces and newlines\n\t- custom function: you can use a function accepting two arguments, two strings representing output and expected output. It should return true if the given output is acceptable, false otherwise. Example:\n\t\t``` lua\n\t\trequire('competitest').setup {\n\t\t\toutput_compare_method = function(output, expected_output)\n\t\t\t\tif output == expected_output then\n\t\t\t\t\treturn true\n\t\t\t\telse\n\t\t\t\t\treturn false\n\t\t\t\tend\n\t\t\tend\n\t\t}\n\t\t```\n- `view_output_diff`: view diff between actual output and expected output in their respective windows\n- `testcases_directory`: where testcases files are located, relatively to current file's path\n- `testcases_use_single_file`: if true testcases will be stored in a single file instead of using multiple text files. If you want to change the way already existing testcases are stored see [conversion](#convert-testcases)\n- `testcases_auto_detect_storage`: if true testcases storage method will be detected automatically. When both text files and single file are available, testcases will be loaded according to the preference specified in `testcases_use_single_file`\n- `testcases_single_file_format`: string representing how single testcases files should be named (see [file-format modifiers](#file-format-modifiers))\n- `testcases_input_file_format`: string representing how testcases input files should be named (see [file-format modifiers](#file-format-modifiers))\n- `testcases_output_file_format`: string representing how testcases output files should be named (see [file-format modifiers](#file-format-modifiers))\n- `companion_port`: competitive companion port number\n- `receive_print_message`: if true notify user that plugin is ready to receive testcases, problems and contests or that they have just been received\n- `template_file`: templates to use when creating source files for received problems or contests. Can be one of the following:\n\t- `false`: do not use templates\n\t- string with [file-format modifiers](#file-format-modifiers): useful when templates for different file types have a regular file naming\n\t\t``` lua\n\t\ttemplate_file = \"~/path/to/template.$(FEXT)\"\n\t\t```\n\t- table with paths: table associating file extension to template file\n\t\t``` lua\n\t\ttemplate_file = {\n\t\t\tc = \"~/path/to/file.c\",\n\t\t\tcpp = \"~/path/to/file.cpp\",\n\t\t\tpy = \"~/path/to/file.py\",\n\t\t}\n\t\t```\n- `evaluate_template_modifiers`: whether to evaluate [receive modifiers](#receive-modifiers) inside a template file or not\n- `date_format`: string used to format `$(DATE)` modifier (see [receive modifiers](#receive-modifiers)). The string should follow the formatting rules as per Lua's [`os.date`](https://www.lua.org/pil/22.1.html) function. For example, to get `06-07-2023 15:24:32` set it to `%d-%m-%Y %H:%M:%S`\n- `received_files_extension`: default file extension for received problems\n- `received_problems_path`: path where received problems (not contests) are stored. Can be one of the following:\n\t- string with [receive modifiers](#receive-modifiers)\n\t- function: function accepting two arguments, a table with [task details](https://github.com/jmerle/competitive-companion/#the-format) and a string with preferred file extension. It should return the absolute path to store received problem. Example:\n\t\t``` lua\n\t\treceived_problems_path = function(task, file_extension)\n\t\t\tlocal hyphen = string.find(task.group, \" - \")\n\t\t\tlocal judge, contest\n\t\t\tif not hyphen then\n\t\t\t\tjudge = task.group\n\t\t\t\tcontest = \"unknown_contest\"\n\t\t\telse\n\t\t\t\tjudge = string.sub(task.group, 1, hyphen - 1)\n\t\t\t\tcontest = string.sub(task.group, hyphen + 3)\n\t\t\tend\n\t\t\treturn string.format(\"%s/Competitive Programming/%s/%s/%s.%s\", vim.loop.os_homedir(), judge, contest, task.name, file_extension)\n\t\tend\n\t\t```\n- `received_problems_prompt_path`: whether to ask user confirmation about path where the received problem is stored or not\n- `received_contests_directory`: directory where received contests are stored. It can be string or function, exactly as `received_problems_path`\n- `received_contests_problems_path`: relative path from contest root directory, each problem of a received contest is stored following this option. It can be string or function, exactly as `received_problems_path`\n- `received_contests_prompt_directory`: whether to ask user confirmation about the directory where received contests are stored or not\n- `received_contests_prompt_extension`: whether to ask user confirmation about what file extension to use when receiving a contest or not\n- `open_received_problems`: automatically open source files when receiving a single problem\n- `open_received_contests`: automatically open source files when receiving a contest\n- `replace_received_testcases`: this option applies when receiving only testcases. If true replace existing testcases with received ones, otherwise ask user what to do\n\n### Local configuration\nYou can use a different configuration for every different folder by creating a file called `.competitest.lua` (this name can be changed configuring the option `local_config_file_name`). It will affect every file contained in that folder and in subfolders. A table containing valid options must be returned, see the following example.\n``` lua\n-- .competitest.lua content\nreturn {\n\tmultiple_testing = 3,\n\tmaximum_time = 2500,\n\ttestcases_input_file_format = \"in_$(TCNUM).txt\",\n\ttestcases_output_file_format = \"ans_$(TCNUM).txt\",\n\ttestcases_single_file_format = \"$(FNOEXT).tc\",\n}\n```\n\n### Available modifiers\nModifiers are substrings that will be replaced by another string, depending on the modifier and the context. They're used to tweak some options.\n\n#### File-format modifiers\nYou can use them to [define commands](#customize-compile-and-run-commands) or to customize testcases files naming through options `testcases_single_file_format`, `testcases_input_file_format` and `testcases_output_file_format`.\n\n| Modifier | Meaning |\n| -------- | ------- |\n| `$()` | insert a dollar |\n| `$(HOME)` | user home directory |\n| `$(FNAME)` | file name |\n| `$(FNOEXT)` | file name without extension |\n| `$(FEXT)` | file extension |\n| `$(FABSPATH)` | absolute path of current file |\n| `$(ABSDIR)` | absolute path of folder that contains file |\n| `$(TCNUM)` | testcase number |\n\n#### Receive modifiers\nYou can use them to customize the options `received_problems_path`, `received_contests_directory`, `received_contests_problems_path` and to [insert problem details inside template files](#templates-for-received-problems-and-contests). See also [tips for customizing folder structure for received problems and contests](#customize-folder-structure).\n\n| Modifier | Meaning |\n| -------- | ------- |\n| `$()` | insert a dollar |\n| `$(HOME)` | user home directory |\n| `$(CWD)` | current working directory |\n| `$(FEXT)` | preferred file extension |\n| `$(PROBLEM)` | problem name, `name` field |\n| `$(GROUP)` | judge and contest name, `group` field |\n| `$(JUDGE)` | judge name (first part of `group`, before hyphen) |\n| `$(CONTEST)` | contest name (second part of `group`, after hyphen) |\n| `$(URL)` | problem url, `url` field |\n| `$(MEMLIM)` | available memory, `memoryLimit` field |\n| `$(TIMELIM)` | time limit, `timeLimit` field |\n| `$(JAVA_MAIN_CLASS)` | almost always \"Main\", `mainClass` field |\n| `$(JAVA_TASK_CLASS)` | classname-friendly version of problem name, `taskClass` field |\n| `$(DATE)` | current date and time (based on [`date_format`](#explanation)), it can be used only inside [template files](#templates-for-received-problems-and-contests) |\n\nFields are referred to [received tasks](https://github.com/jmerle/competitive-companion/#the-format).\n\n### Customize compile and run commands\nLanguages as C, C++, Rust, Java and Python are supported by default.\\\nOf course you can customize commands used for compiling and for running your programs. You can also add languages that aren't supported by default.\n``` lua\nrequire('competitest').setup {\n\tcompile_command = {\n\t\tcpp = { exec = 'g++', args = {'$(FNAME)', '-o', '$(FNOEXT)'} },\n\t\tsome_lang = { exec = 'some_compiler', args = {'$(FNAME)'} },\n\t},\n\trun_command = {\n\t\tcpp = { exec = './$(FNOEXT)' },\n\t\tsome_lang = { exec = 'some_interpreter', args = {'$(FNAME)'} },\n\t},\n}\n```\nSee [file-format modifiers](#file-format-modifiers) to better understand how dollar notation works.\n\n**NOTE:** if your language isn't compiled you can ignore `compile_command` section.\n\nFeel free to open a PR or an issue if you think it's worth adding a new language among default ones.\n\n### Customize UI layout\nYou can customize testcase runner user interface by defining windows positions and sizes trough a table describing a layout. This is possible both for popup and split UI.\n\nEvery window is identified by a string representing its name and a number representing the proportion between its size and the sizes of other windows. To define a window use a lua table made by a number and a string. An example is `{ 1.5, \"tc\" }`.\\\nWindows can be named as follows:\n- `tc` for testcases selector\n- `si` for standard input\n- `so` for standard output\n- `se` for standard error\n- `eo` for expected output\n\nA layout is a list made by windows or layouts (recursively defined). To define a layout use a lua table containing a list of windows or layouts.\n\n\n\n\n\n

Sample code	Result
\n\n``` lua\nlayout = {\n { 2, \"tc\" },\n { 3, {\n { 1, \"so\" },\n { 1, \"si\" },\n } },\n { 3, {\n { 1, \"eo\" },\n { 1, \"se\" },\n } },\n}\n```\n	\n\n![layout1](https://user-images.githubusercontent.com/88047141/183749940-b720e9b2-557d-460c-99d0-99a2a03a81bd.png)\n
\n\n``` lua\nlayout = {\n { 1, {\n { 1, \"so\" },\n { 1, {\n { 1, \"tc\" },\n { 1, \"se\" },\n } },\n } },\n { 1, {\n { 1, \"eo\" },\n { 1, \"si\" },\n } },\n}\n```\n	\n\n![layout2](https://user-images.githubusercontent.com/88047141/183750135-6dbd39ac-2fd4-4c10-be5f-034c1966929f.png)\n

\n\n## Statusline and winbar integration\nWhen using split UI windows name can be displayed in statusline or in winbar. In each CompetiTest buffer there's a local variable called `competitest_title`, that is a string representing window name. You can get its value using `nvim_buf_get_var(buffer_number, 'competitest_title')`.\\\nSee the [second screenshot](#competitive-programming-with-neovim-made-easy) for an example statusline used with split UI.\n\n## Highlights\nYou can customize CompetiTest highlight groups. Their default values are:\n``` vim\nhi CompetiTestRunning cterm=bold gui=bold\nhi CompetiTestDone cterm=none gui=none\nhi CompetiTestCorrect ctermfg=green guifg=#00ff00\nhi CompetiTestWarning ctermfg=yellow guifg=orange\nhi CompetiTestWrong ctermfg=red guifg=#ff0000\n```\n\n## Roadmap\n- [x] Manage testcases\n\t- [x] Add testcases\n\t- [x] Edit testcases\n\t- [x] Delete testcases\n\t- [x] Store testcases in a single file\n\t- [x] Store testcases in multiple text files\n\t- [x] Convert single file into multiple text files and vice versa\n- [x] Run testcases\n\t- [x] Support many programming languages\n\t- [x] Handle compilation if needed\n\t- [x] Run multiple testcases at the same time\n\t\t- [x] Run again processes\n\t\t- [x] Kill processes\n\t- [x] Display results and execution data in a popup UI\n\t- [x] Display results and execution data in a split window UI\n- [ ] Handle interactive tasks\n- [x] Configure every folder individually\n- [x] Integration with [competitive-companion](https://github.com/jmerle/competitive-companion)\n\t- [x] Download testcases\n\t- [x] Download problems\n\t- [x] Download contests\n\t- [x] Customizable folder structure for downloaded problems and contests\n- [x] Templates for files created when receiving problems or contests\n- [ ] Integration with tools to submit solutions ([api-client](https://github.com/online-judge-tools/api-client) or [cpbooster](https://github.com/searleser97/cpbooster))\n- [ ] Write Vim docs\n- [x] Customizable highlights\n- [x] Resizable UI\n\n## Contributing\nIf you have any suggestion to give or if you encounter any trouble don't hesitate to open a new issue.\\\nPull Requests are welcome! 🎉\n\n## License\nGNU Lesser General Public License version 3 (LGPL v3) or, at your option, any later version\n\nCopyright © 2021-2023 [xeluxee](https://github.com/xeluxee)\n\nCompetiTest.nvim is free software: you can redistribute it and/or modify\nit under the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nCompetiTest.nvim is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU Lesser General Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with CompetiTest.nvim. If not, see .\n","dotfyleShieldAddedAt":null,"stars":270,"lastSyncedAt":"2023-12-01T02:26:01.034Z","addedLastWeek":0}}}]}}]