mirror of
https://github.com/nix-community/nixvim.git
synced 2025-06-24 17:58:38 +02:00
plugins/competitest: init
Add support for competitest.nvim, a neovim plugin for Competitive Programming.
This commit is contained in:
svl
Gaétan Lepage
parent
8f9e35481f
commit
e2e7258267
3 changed files with 337 additions and 0 deletions
259
plugins/utils/competitest.nix
Normal file
259
plugins/utils/competitest.nix
Normal file
|
|
@ -0,0 +1,259 @@
|
|||
{
|
||||
lib,
|
||||
helpers,
|
||||
config,
|
||||
pkgs,
|
||||
...
|
||||
}:
|
||||
with lib;
|
||||
helpers.neovim-plugin.mkNeovimPlugin config {
|
||||
name = "competitest";
|
||||
originalName = "competitest.nvim";
|
||||
defaultPackage = pkgs.vimPlugins.competitest-nvim;
|
||||
|
||||
maintainers = [helpers.maintainers.svl];
|
||||
|
||||
settingsOptions = {
|
||||
local_config_file_name = helpers.defaultNullOpts.mkStr ".competitest.lua" ''
|
||||
You can use a different configuration for every different folder.
|
||||
See [local configuration](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#local-configuration).
|
||||
'';
|
||||
|
||||
save_current_file = helpers.defaultNullOpts.mkBool true ''
|
||||
If true save current file before running testcases.
|
||||
'';
|
||||
|
||||
save_all_files = helpers.defaultNullOpts.mkBool false ''
|
||||
If true save all the opened files before running testcases.
|
||||
'';
|
||||
|
||||
compile_directory = helpers.defaultNullOpts.mkStr "." ''
|
||||
Execution directory of compiler, relatively to current file's path.
|
||||
'';
|
||||
|
||||
compile_command =
|
||||
helpers.mkNullOrOption
|
||||
(
|
||||
with types;
|
||||
attrsOf (submodule {
|
||||
options = {
|
||||
exec = mkOption {
|
||||
type = str;
|
||||
description = "Command to execute";
|
||||
};
|
||||
args = helpers.defaultNullOpts.mkListOf types.str "[]" ''
|
||||
Arguments to the command.
|
||||
'';
|
||||
};
|
||||
})
|
||||
)
|
||||
''
|
||||
Configure the command used to compile code for every different language, see
|
||||
[here](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#customize-compile-and-run-commands).
|
||||
'';
|
||||
|
||||
running_directory = helpers.defaultNullOpts.mkStr "." ''
|
||||
Execution directory of your solutions, relatively to current file's path.
|
||||
'';
|
||||
|
||||
run_command =
|
||||
helpers.mkNullOrOption
|
||||
(
|
||||
with types;
|
||||
attrsOf (submodule {
|
||||
options = {
|
||||
exec = mkOption {
|
||||
type = str;
|
||||
description = "Command to execute.";
|
||||
};
|
||||
args = helpers.defaultNullOpts.mkListOf types.str "[]" ''
|
||||
Arguments to the command.
|
||||
'';
|
||||
};
|
||||
})
|
||||
)
|
||||
''
|
||||
Configure the command used to run your solutions for every different language, see
|
||||
[here](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#customize-compile-and-run-commands).
|
||||
'';
|
||||
|
||||
multiple_testing = helpers.defaultNullOpts.mkInt (-1) ''
|
||||
How many testcases to run at the same time
|
||||
* 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.
|
||||
* Set it to 0 if you want to run all the testcases together.
|
||||
* Set it to any positive integer to run that number of testcases contemporarily.
|
||||
'';
|
||||
|
||||
maximum_time = helpers.defaultNullOpts.mkInt 5000 ''
|
||||
Maximum time, in milliseconds, given to processes.
|
||||
If it's exceeded process will be killed.
|
||||
'';
|
||||
|
||||
output_compare_method =
|
||||
helpers.defaultNullOpts.mkNullable
|
||||
(
|
||||
with types;
|
||||
either (enum [
|
||||
"exact"
|
||||
"squish"
|
||||
])
|
||||
helpers.nixvimTypes.rawLua
|
||||
)
|
||||
"squish"
|
||||
''
|
||||
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:
|
||||
* "exact": character by character comparison.
|
||||
* "squish": compare stripping extra white spaces and newlines.
|
||||
* 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.
|
||||
'';
|
||||
|
||||
view_output_diff = helpers.defaultNullOpts.mkBool false ''
|
||||
View diff between actual output and expected output in their respective windows.
|
||||
'';
|
||||
|
||||
testcases_directory = helpers.defaultNullOpts.mkStr "." ''
|
||||
Where testcases files are located, relatively to current file's path.
|
||||
'';
|
||||
|
||||
testcases_use_single_file = helpers.defaultNullOpts.mkBool false ''
|
||||
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](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#convert-testcases).
|
||||
'';
|
||||
|
||||
testcases_auto_detect_storage = helpers.defaultNullOpts.mkBool true ''
|
||||
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`.
|
||||
'';
|
||||
|
||||
testcases_single_file_format = helpers.defaultNullOpts.mkStr "$(FNOEXT).testcases" ''
|
||||
String representing how single testcases files should be named
|
||||
(see [file-format modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#file-format-modifiers)).
|
||||
'';
|
||||
|
||||
testcases_input_file_format = helpers.defaultNullOpts.mkStr "$(FNOEXT)_input$(TCNUM).txt" ''
|
||||
String representing how testcases input files should be named
|
||||
(see [file-format modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#file-format-modifiers)).
|
||||
'';
|
||||
|
||||
testcases_output_file_format = helpers.defaultNullOpts.mkStr "$(FNOEXT)_output$(TCNUM).txt" ''
|
||||
String representing how testcases output files should be named
|
||||
(see [file-format modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#file-format-modifiers)).
|
||||
'';
|
||||
|
||||
companion_port = helpers.defaultNullOpts.mkInt 27121 ''
|
||||
Competitive companion port number.
|
||||
'';
|
||||
|
||||
receive_print_message = helpers.defaultNullOpts.mkBool true ''
|
||||
If true notify user that plugin is ready to receive testcases, problems and
|
||||
contests or that they have just been received.
|
||||
'';
|
||||
|
||||
template_file =
|
||||
helpers.mkNullOrOption
|
||||
(
|
||||
with types;
|
||||
oneOf [
|
||||
(enum [false])
|
||||
str
|
||||
(attrsOf str)
|
||||
]
|
||||
)
|
||||
''
|
||||
Templates to use when creating source files for received problems or contests.
|
||||
Can be one of the following:
|
||||
* false: do not use templates.
|
||||
* string with
|
||||
[file-format modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#file-format-modifiers):
|
||||
useful when templates for different file types have a regular file naming.
|
||||
* table with paths: table associating file extension to template file.
|
||||
'';
|
||||
|
||||
evaluate_template_modifiers = helpers.defaultNullOpts.mkBool false ''
|
||||
Whether to evaluate
|
||||
[receive modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#receive-modifiers)
|
||||
inside a template file or not.
|
||||
'';
|
||||
|
||||
date_format = helpers.defaultNullOpts.mkStr "%c" ''
|
||||
String used to format `$(DATE)` modifier (see
|
||||
[receive modifiers](https://github.com/xeluxee/competitest.nvim?tab=readme-ov-file#receive-modifiers)).
|
||||
The string should follow the formatting rules as per Lua's
|
||||
`[os.date](https://www.lua.org/pil/22.1.html)` function.
|
||||
'';
|
||||
|
||||
received_files_extension = helpers.defaultNullOpts.mkStr "cpp" ''
|
||||
Default file extension for received problems.
|
||||
'';
|
||||
|
||||
received_problems_path = helpers.defaultNullOpts.mkStr "$(CWD)/$(PROBLEM).$(FEXT)" ''
|
||||
Path where received problems (not contests) are stored.
|
||||
Can be one of the following:
|
||||
* string with receive modifiers.
|
||||
* function: function accepting two arguments, a table with task details and
|
||||
a string with preferred file extension. It should return the absolute path
|
||||
to store received problem.
|
||||
'';
|
||||
|
||||
received_problems_prompt_path = helpers.defaultNullOpts.mkBool true ''
|
||||
Whether to ask user confirmation about path where the received problem is stored or not.
|
||||
'';
|
||||
|
||||
received_contests_directory = helpers.defaultNullOpts.mkStr "$(CWD)" ''
|
||||
Directory where received contests are stored. It can be string or function,
|
||||
exactly as `received_problems_path`.
|
||||
'';
|
||||
|
||||
received_contests_problems_path = helpers.defaultNullOpts.mkStr "$(PROBLEM).$(FEXT)" ''
|
||||
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`.
|
||||
'';
|
||||
|
||||
received_contests_prompt_directory = helpers.defaultNullOpts.mkBool true ''
|
||||
Whether to ask user confirmation about the directory where received contests are stored or not.
|
||||
'';
|
||||
|
||||
received_contests_prompt_extension = helpers.defaultNullOpts.mkBool true ''
|
||||
Whether to ask user confirmation about what file extension to use when receiving a contest or not.
|
||||
'';
|
||||
|
||||
open_received_problems = helpers.defaultNullOpts.mkBool true ''
|
||||
Automatically open source files when receiving a single problem.
|
||||
'';
|
||||
|
||||
open_received_contests = helpers.defaultNullOpts.mkBool true ''
|
||||
Automatically open source files when receiving a contest.
|
||||
'';
|
||||
|
||||
replace_received_testcases = helpers.defaultNullOpts.mkBool false ''
|
||||
This option applies when receiving only testcases. If true replace existing
|
||||
testcases with received ones, otherwise ask user what to do.
|
||||
'';
|
||||
};
|
||||
|
||||
settingsExample = {
|
||||
received_problems_path = "$(HOME)/cp/$(JUDGE)/$(CONTEST)/$(PROBLEM)/main.$(FEXT)";
|
||||
template_file = "$(HOME)/cp/templates/template.$(FEXT)";
|
||||
evaluate_template_modifiers = true;
|
||||
compile_command = {
|
||||
cpp = {
|
||||
exec = "g++";
|
||||
args = [
|
||||
"-DLOCAL"
|
||||
"$(FNAME)"
|
||||
"-o"
|
||||
"$(FNOEXT)"
|
||||
"-Wall"
|
||||
"-Wextra"
|
||||
];
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue