barrett/cp.nvim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix(docs): update for new features

Browse source
This commit is contained in:
Barrett Ruth 2025-10-23 20:40:59 -04:00
parent 60e5aabd99
commit f45926c094
2 changed files with 163 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -2,22 +2,28 @@
**The definitive competitive programming environment for Neovim** **The definitive competitive programming environment for Neovim**
Scrape problems, run tests, and debug solutions across multiple platforms with zero configuration. Scrape problems, run tests, and debug solutions across multiple platforms with
zero configuration.
https://github.com/user-attachments/assets/50b19481-8e6d-47b4-bebc-15e16c61a9c9 https://github.com/user-attachments/assets/50b19481-8e6d-47b4-bebc-15e16c61a9c9
## Features ## Features
- **Multi-platform support**: AtCoder, Codeforces, CSES with consistent interface - **Multi-platform support**: AtCoder, Codeforces, CSES with consistent
interface
- **Automatic problem setup**: Scrape test cases and metadata in seconds - **Automatic problem setup**: Scrape test cases and metadata in seconds
- **Rich test output**: 256 color ANSI support for compiler errors and program output - **Dual view modes**: Lightweight I/O view for quick feedback, full panel for
detailed analysis
- **Rich test output**: 256 color ANSI support for compiler errors and program
output
- **Language agnostic**: Works with any language - **Language agnostic**: Works with any language
- **Diff viewer**: Compare expected vs actual output with 3 diff modes - **Diff viewer**: Compare expected vs actual output with 3 diff modes
## Optional Dependencies ## Optional Dependencies
- [uv](https://docs.astral.sh/uv/) for problem scraping - [uv](https://docs.astral.sh/uv/) for problem scraping
- GNU [time](https://www.gnu.org/software/time/) and [timeout](https://www.gnu.org/software/coreutils/manual/html_node/timeout-invocation.html) - GNU [time](https://www.gnu.org/software/time/) and
[timeout](https://www.gnu.org/software/coreutils/manual/html_node/timeout-invocation.html)
## Quick Start ## Quick Start
@ -32,10 +38,11 @@ cp.nvim follows a simple principle: **solve locally, submit remotely**.
:CP codeforces 1848 :CP codeforces 1848
``` ```
3. **Code and test** with instant feedback and rich diffs 3. **Code and test** with instant feedback
``` ```
:CP run :CP run " Quick verdict summary in splits
:CP panel " Detailed analysis with diffs
``` ```
4. **Navigate between problems** 4. **Navigate between problems**
@ -54,7 +61,9 @@ cp.nvim follows a simple principle: **solve locally, submit remotely**.
:help cp.nvim :help cp.nvim
``` ```
See [my config](https://github.com/barrett-ruth/dots/blob/main/nvim/lua/plugins/cp.lua) for a relatively advanced setup. See
[my config](https://github.com/barrett-ruth/dots/blob/main/nvim/lua/plugins/cp.lua)
for a relatively advanced setup.
## Similar Projects ## Similar Projects

208
doc/cp.nvim.txt
View file

@ -4,7 +4,7 @@ Author: Barrett Ruth <br.barrettruth@gmail.com>
License: Same terms as Vim itself (see |license|) License: Same terms as Vim itself (see |license|)
============================================================================== ==============================================================================
INTRODUCTION *cp.nvim* INTRODUCTION *cp.nvim*
cp.nvim is a competitive programming plugin that automates problem setup, cp.nvim is a competitive programming plugin that automates problem setup,
compilation, and testing workflow for online judges. compilation, and testing workflow for online judges.
@ -12,16 +12,16 @@ compilation, and testing workflow for online judges.
Supported platforms (for now!): AtCoder, Codeforces, CSES Supported platforms (for now!): AtCoder, Codeforces, CSES
============================================================================== ==============================================================================
REQUIREMENTS *cp-requirements* REQUIREMENTS *cp-requirements*
- Neovim 0.10.0+ - Neovim 0.10.0+
- Unix-like operating system - Unix-like operating system
- uv package manager (https://docs.astral.sh/uv/) - uv package manager (https://docs.astral.sh/uv/)
============================================================================== ==============================================================================
COMMANDS *cp-commands* COMMANDS *cp-commands*
:CP *:CP* :CP *:CP*
cp.nvim uses a single :CP command with intelligent argument parsing: cp.nvim uses a single :CP command with intelligent argument parsing:
Setup Commands ~ Setup Commands ~
@ -38,14 +38,23 @@ COMMANDS *cp-commands*
Example: > Example: >
:CP atcoder abc324 :CP atcoder abc324
< <
Action Commands ~ View Commands ~
:CP run Toggle run panel for individual test cases. :CP run [n] Run tests in I/O view (see |cp-io-view|).
Shows per-test results with redesigned Lightweight split showing test verdicts.
layout for efficient comparison. Without [n]: runs all tests, shows verdict summary
With [n]: runs test n, shows detailed output
:CP debug Examples: >
Same as above but with the debug mode configured :CP run " All tests, verdict list
settings. :CP run 3 " Test 3 detail
<
:CP panel [n] Open full-screen test panel (see |cp-panel|).
Aggregate table with diff modes for detailed analysis.
Optional [n] focuses on specific test.
Example: >
:CP panel " All tests with diffs
:CP panel 2 " Focus on test 2
<
:CP debug [n] Same as :CP panel but uses debug build configuration.
:CP pick Launch configured picker for interactive :CP pick Launch configured picker for interactive
platform/contest selection. platform/contest selection.
@ -84,7 +93,7 @@ COMMANDS *cp-commands*
Exit with q. Exit with q.
Template Variables ~ Template Variables ~
*cp-template-vars* *cp-template-vars*
Command templates support variable substitution using {variable} syntax: Command templates support variable substitution using {variable} syntax:
• {source} Source file path (e.g. "abc324a.cpp") • {source} Source file path (e.g. "abc324a.cpp")
@ -97,7 +106,7 @@ Template Variables ~
< <
============================================================================== ==============================================================================
CONFIGURATION *cp-config* CONFIGURATION *cp-config*
Here's an example configuration with lazy.nvim: Here's an example configuration with lazy.nvim:
>lua >lua
@ -145,8 +154,8 @@ Here's an example configuration with lazy.nvim:
open_url = true, open_url = true,
debug = false, debug = false,
ui = { ui = {
ansi = true,
panel = { panel = {
ansi = true,
diff_mode = 'vim', diff_mode = 'vim',
max_output_lines = 50, max_output_lines = 50,
}, },
@ -197,7 +206,7 @@ run CSES problems with Rust using the single schema:
}, },
} }
< <
*cp.Config* *cp.Config*
Fields: ~ Fields: ~
{languages} (table<string,|CpLanguage|>) Global language registry. {languages} (table<string,|CpLanguage|>) Global language registry.
Each language provides an {extension} and {commands}. Each language provides an {extension} and {commands}.
@ -214,19 +223,19 @@ run CSES problems with Rust using the single schema:
{open_url} (boolean) Open the contest & problem url in the browser {open_url} (boolean) Open the contest & problem url in the browser
when the contest is first opened. when the contest is first opened.
*CpPlatform* *CpPlatform*
Fields: ~ Fields: ~
{enabled_languages} (string[]) Language ids enabled on this platform. {enabled_languages} (string[]) Language ids enabled on this platform.
{default_language} (string) One of {enabled_languages}. {default_language} (string) One of {enabled_languages}.
{overrides} (table<string,|CpPlatformOverrides|>, optional) {overrides} (table<string,|CpPlatformOverrides|>, optional)
Per-language overrides of {extension} and/or {commands}. Per-language overrides of {extension} and/or {commands}.
*CpLanguage* *CpLanguage*
Fields: ~ Fields: ~
{extension} (string) File extension without leading dot. {extension} (string) File extension without leading dot.
{commands} (|CpLangCommands|) Command templates. {commands} (|CpLangCommands|) Command templates.
*CpLangCommands* *CpLangCommands*
Fields: ~ Fields: ~
{build} (string[], optional) For compiled languages. {build} (string[], optional) For compiled languages.
Must include {source} and {binary}. Must include {source} and {binary}.
@ -236,25 +245,25 @@ run CSES problems with Rust using the single schema:
{debug} (string[], optional) Debug variant; same token rules {debug} (string[], optional) Debug variant; same token rules
as {build} (compiled) or {run} (interpreted). as {build} (compiled) or {run} (interpreted).
*CpUI* *CpUI*
Fields: ~ Fields: ~
{ansi} (boolean, default: true) Enable ANSI color parsing
and highlighting in both I/O view and panel.
{panel} (|PanelConfig|) Test panel behavior configuration. {panel} (|PanelConfig|) Test panel behavior configuration.
{diff} (|DiffConfig|) Diff backend configuration. {diff} (|DiffConfig|) Diff backend configuration.
{picker} (string|nil) 'telescope', 'fzf-lua', or nil. {picker} (string|nil) 'telescope', 'fzf-lua', or nil.
*cp.PanelConfig* *cp.PanelConfig*
Fields: ~ Fields: ~
{ansi} (boolean, default: true) Enable ANSI color parsing
and highlighting.
{diff_mode} (string, default: "none") Diff backend: "none", {diff_mode} (string, default: "none") Diff backend: "none",
"vim", or "git". "vim", or "git".
{max_output_lines} (number, default: 50) Maximum lines of test output. {max_output_lines} (number, default: 50) Maximum lines of test output.
*cp.DiffConfig* *cp.DiffConfig*
Fields: ~ Fields: ~
{git} (|cp.DiffGitConfig|) Git diff backend configuration. {git} (|cp.DiffGitConfig|) Git diff backend configuration.
*cp.DiffGitConfig* *cp.DiffGitConfig*
Fields: ~ Fields: ~
{args} (string[]) Command-line arguments for git diff. {args} (string[]) Command-line arguments for git diff.
Default: { 'diff', '--no-index', '--word-diff=plain', Default: { 'diff', '--no-index', '--word-diff=plain',
@ -264,40 +273,56 @@ run CSES problems with Rust using the single schema:
• --word-diff-regex=.: Split on every character • --word-diff-regex=.: Split on every character
• --no-prefix: Remove a/ b/ prefixes from output • --no-prefix: Remove a/ b/ prefixes from output
*cp.Hooks* *cp.Hooks*
Fields: ~ Fields: ~
{before_run} (function, optional) Called before test panel opens. {before_run} (function, optional) Called before test panel opens.
function(state: cp.State) function(state: cp.State)
{before_debug} (function, optional) Called before debug build/run. {before_debug} (function, optional) Called before debug build/run.
function(state: cp.State) function(state: cp.State)
{setup_code} (function, optional) Called after source file is opened. {setup_code} (function, optional) Called after source file is opened.
function(state: cp.State) function(state: cp.State)
{setup_io_input} (function, optional) Called when I/O input buffer created.
function(bufnr: integer, state: cp.State)
Default: helpers.clearcol (removes line numbers/columns)
{setup_io_output} (function, optional) Called when I/O output buffer created.
function(bufnr: integer, state: cp.State)
Default: helpers.clearcol (removes line numbers/columns)
Hook functions receive the cp.nvim state object (cp.State). See the state Hook functions receive the cp.nvim state object (|cp.State|). See
module documentation (lua/cp/state.lua) for available methods and fields. |lua/cp/state.lua| for available methods and fields.
Example usage in hook: The I/O buffer hooks are called once when the buffers are first created
during problem setup. Use these to customize buffer appearance (e.g.,
remove line numbers, set custom options). Access helpers via:
>lua
local helpers = require('cp').helpers
<
Example usage:
>lua >lua
hooks = { hooks = {
setup_code = function(state) setup_code = function(state)
print("Setting up " .. state.get_base_name()) print("Setting up " .. state.get_base_name())
print("Source file: " .. state.get_source_file()) print("Source file: " .. state.get_source_file())
end,
setup_io_input = function(bufnr, state)
-- Custom setup for input buffer
vim.api.nvim_set_option_value('number', false, { buf = bufnr })
end end
} }
< <
============================================================================== ==============================================================================
WORKFLOW *cp-workflow* WORKFLOW *cp-workflow*
For the sake of consistency and simplicity, cp.nvim extracts contest/problem For the sake of consistency and simplicity, cp.nvim extracts contest/problem
identifiers from URLs. This means that, for example, CodeForces/AtCoder identifiers from URLs. This means that, for example, CodeForces/AtCoder
contests are configured by their round id rather than round number. See below. contests are configured by their round id rather than round number. See below.
============================================================================== ==============================================================================
PLATFORM-SPECIFIC USAGE *cp-platforms* PLATFORM-SPECIFIC USAGE *cp-platforms*
AtCoder ~ AtCoder ~
*cp-atcoder* *cp-atcoder*
URL format: URL format:
https://atcoder.jp/contests/{contest_id}/tasks/{contest_id}_{problem_id} https://atcoder.jp/contests/{contest_id}/tasks/{contest_id}_{problem_id}
@ -305,14 +330,14 @@ Usage examples: >
:CP atcoder abc324 " Set up atcoder.jp/contests/abc324 :CP atcoder abc324 " Set up atcoder.jp/contests/abc324
Codeforces ~ Codeforces ~
*cp-codeforces* *cp-codeforces*
URL format: https://codeforces.com/contest/{contest_id}/problem/{problem_id} URL format: https://codeforces.com/contest/{contest_id}/problem/{problem_id}
Usage examples: > Usage examples: >
:CP codeforces 1934 " Set up codeforces.com/contest/1934 :CP codeforces 1934 " Set up codeforces.com/contest/1934
CSES ~ CSES ~
*cp-cses* *cp-cses*
URL format: https://cses.fi/problemset/task/{problem_id} URL format: https://cses.fi/problemset/task/{problem_id}
Usage examples: > Usage examples: >
@ -320,7 +345,7 @@ Usage examples: >
============================================================================== ==============================================================================
COMPLETE WORKFLOW EXAMPLE *cp-example* COMPLETE WORKFLOW EXAMPLE *cp-example*
Example: Setting up and solving AtCoder contest ABC324 Example: Setting up and solving AtCoder contest ABC324
@ -333,8 +358,9 @@ Example: Setting up and solving AtCoder contest ABC324
3. Code your solution, then test: > 3. Code your solution, then test: >
:CP run :CP run
< Navigate with j/k, run specific tests with <enter> < View test verdicts in I/O splits. For detailed analysis:
Exit test panel with q or :CP run when done :CP panel
< Navigate tests with <c-n>/<c-p>, exit with q
4. Move to next problem: > 4. Move to next problem: >
:CP next :CP next
@ -350,28 +376,68 @@ Example: Setting up and solving AtCoder contest ABC324
7. Submit solutions on AtCoder website 7. Submit solutions on AtCoder website
============================================================================== ==============================================================================
PICKER INTEGRATION *cp-picker* I/O VIEW *cp-io-view*
The I/O view provides the main view aggregate view into test input and
program output. Used time/memory per test case are appended to the output.
The |cp-panel| offers more fine-grained analysis into each test case.
Access the I/O view with :CP run [n]
Layout ~
The I/O view appears as 30% width splits on the right side: >
┌──────────────────────────┬──────────────────────────┐
│ │ Output │
│ │ Test 1: AC (42ms, 8MB) │
│ │ Test 2: AC (38ms, 8MB) │
│ Solution Code │ Test 3: WA (45ms, 8MB) │
│ │ Test 4: AC (51ms, 9MB) │
│ ├──────────────────────────┤
│ │ Input │
│ │ 5 3 │
│ │ 1 2 3 4 5 │
│ │ 2 1 │
│ │ 10 20 │
└──────────────────────────┴──────────────────────────┘
<
Usage ~
:CP run Run all tests
:CP run 3 Run test 3
Buffer Customization ~
Use the setup_io_input and setup_io_output hooks (see |cp.Hooks|) to customize
buffer appearance. By default, line numbers and columns are removed via
helpers.clearcol (see |cp-helpers|).
==============================================================================
PICKER INTEGRATION *cp-picker*
When picker integration is enabled in configuration, cp.nvim provides interactive When picker integration is enabled in configuration, cp.nvim provides interactive
platform and contest selection using telescope.nvim or fzf-lua. platform and contest selection using telescope.nvim or fzf-lua.
:CP pick *:CP-pick* :CP pick *:CP-pick*
Launch configured picker for interactive problem selection. Launch configured picker for interactive problem selection.
Control Flow: Select Platform → Contest → Code! Control Flow: Select Platform → Contest → Code!
Requires picker = 'telescope' or picker = 'fzf-lua' in configuration. Requires picker = 'telescope' or picker = 'fzf-lua' in configuration.
Requires corresponding plugin (telescope.nvim or fzf-lua) to be installed. Requires corresponding plugin (telescope.nvim or fzf-lua) to be installed.
PICKER KEYMAPS *cp-picker-keys* PICKER KEYMAPS *cp-picker-keys*
<c-r> Force refresh/update contest list. <c-r> Force refresh/update contest list.
Useful when contest lists are outdated or incomplete Useful when contest lists are outdated or incomplete
============================================================================== ==============================================================================
PANEL *cp-run* PANEL *cp-panel*
The panel provides individual test case debugging. Problem time/memory The panel provides full-screen test analysis with diff modes for detailed
limit constraints are in columns Time/Mem respectively. Used time/memory are debugging. Problem time/memory limit constraints are in columns Time/Mem
in columns Runtime/RSS respectively. respectively. Used time/memory are in columns Runtime/RSS respectively.
Access with :CP panel or :CP debug (uses debug build configuration).
Interface ~ Interface ~
@ -409,7 +475,7 @@ Test cases use competitive programming terminology with color highlighting:
< <
============================================================================== ==============================================================================
INTERACTIVE MODE *cp-interact* INTERACTIVE MODE *cp-interact*
Run interactive problems manually or with an orchestrator. :CP interact is Run interactive problems manually or with an orchestrator. :CP interact is
available for interactive problems. Test cases are ignored in interactive mode available for interactive problems. Test cases are ignored in interactive mode
@ -436,7 +502,7 @@ Keymaps ~
<c-q> Close the terminal and restore the previous layout. <c-q> Close the terminal and restore the previous layout.
============================================================================== ==============================================================================
ANSI COLORS AND HIGHLIGHTING *cp-ansi* ANSI COLORS AND HIGHLIGHTING *cp-ansi*
cp.nvim provides comprehensive ANSI color support and highlighting for cp.nvim provides comprehensive ANSI color support and highlighting for
compiler output, program stderr, and diff visualization. compiler output, program stderr, and diff visualization.
@ -459,7 +525,7 @@ alter your config as follows:
< <
============================================================================== ==============================================================================
HIGHLIGHT GROUPS *cp-highlights* HIGHLIGHT GROUPS *cp-highlights*
Test Status Groups ~ Test Status Groups ~
@ -485,13 +551,13 @@ adapt to your colorscheme:
DiffDelete Highlights removed text in git diffs DiffDelete Highlights removed text in git diffs
============================================================================== ==============================================================================
TERMINAL COLOR INTEGRATION *cp-terminal-colors* TERMINAL COLOR INTEGRATION *cp-terminal-colors*
ANSI colors automatically use the terminal's color palette through Neovim's ANSI colors automatically use the terminal's color palette through Neovim's
vim.g.terminal_color_* variables. vim.g.terminal_color_* variables.
============================================================================== ==============================================================================
HIGHLIGHT CUSTOMIZATION *cp-highlight-custom* HIGHLIGHT CUSTOMIZATION *cp-highlight-custom*
Customize highlight groups after your colorscheme loads: Customize highlight groups after your colorscheme loads:
>lua >lua
@ -502,12 +568,33 @@ Customize highlight groups after your colorscheme loads:
}) })
============================================================================== ==============================================================================
PANEL KEYMAPS *cp-test-keys* HELPERS *cp-helpers*
The helpers module provides utility functions for buffer customization.
Access via:
>lua
local helpers = require('cp').helpers
<
Functions ~
helpers.clearcol({bufnr}) *helpers.clearcol*
Remove line numbers, columns, and signs from buffer.
Sets:
• number = false
• relativenumber = false
• signcolumn = 'no'
• statuscolumn = ''
Parameters: ~
{bufnr} (integer) Buffer handle
==============================================================================
PANEL KEYMAPS *cp-panel-keys*
<c-n> Navigate to next test case <c-n> Navigate to next test case
<c-p> Navigate to previous test case <c-p> Navigate to previous test case
t Cycle through diff modes: none → git → vim t Cycle through diff modes: none → git → vim
q Exit run panel and restore layout q Exit panel and restore layout
<c-q> Exit interactive terminal and restore layout <c-q> Exit interactive terminal and restore layout
Diff Modes ~ Diff Modes ~
@ -528,7 +615,7 @@ execution pipeline, but with isolated input/output for
precise failure analysis. precise failure analysis.
============================================================================== ==============================================================================
FILE STRUCTURE *cp-files* FILE STRUCTURE *cp-files*
cp.nvim creates the following file structure upon problem setup: > cp.nvim creates the following file structure upon problem setup: >
@ -537,11 +624,10 @@ cp.nvim creates the following file structure upon problem setup: >
{problem_id}.run " Compiled binary {problem_id}.run " Compiled binary
io/ io/
{problem_id}.n.cpin " nth test input {problem_id}.n.cpin " nth test input
{problem_id}.n.cpout " nth program output {problem_id}.n.cpout " nth test expected output
{problem_id}.expected " Expected output
< <
============================================================================== ==============================================================================
HEALTH CHECK *cp-health* HEALTH CHECK *cp-health*
Run |:checkhealth| cp to verify your setup. Run |:checkhealth| cp to verify your setup.