agentleFS
neoclideneoclide/coc.nvim/AGENTS.md

coc.nvim

AGENTS.md25k starsChanged 3 years agoMITView on GitHub

coc.nvim is a language client framework for Vim and Neovim. It provides LSP integration, extension APIs, completion, diagnostics, workspace management and plugin infrastructure. This project is performance-sensitive and must maintain compatibility with existing Vim/Neovim users. Maintain compatibility with: Be careful with: Every created resource should have a clear cleanup path. Before editing: Do not remove existing code only because it looks unused.

We split this AGENTS.md into the rules it gives an agent

12 rules. About 0 are common, 6 are distinctive, and 6 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Avoid any unless unavoidable.

    line 33
  2. Distinctive:

    Prefer existing utility functions over introducing new helpers.

    line 34
  3. Distinctive:

    Every created resource should have a clear cleanup path.

    line 49
  4. Distinctive:

    Do not remove existing code only because it looks unused.

    line 67
  5. Distinctive:

    remove compatibility code without proof

    line 76
  6. Distinctive:

    When add new feature and introduce break changes, add the change to history.md.

    line 80
  7. Very specific:

    Update doc/coc.txt after vim interface change.

    line 81
  8. Very specific:

    Update doc/coc-api.txt after API change.

    line 82
  9. Very specific:

    Update doc/coc-config.txt after coc.nvim configuration change.

    line 83
  10. Very specific:

    Check that public coc.nvim APIs remain stable and properly typed.

    line 88
  11. Distinctive:

    Check Vim and Neovim behavior, buffer switching, cancellation, disposal, and asynchronous race conditions.

    line 89
  12. Very specific:

    Use node scripts/test/cli.mjs <path_to_file> for run specific test file.

    line 95

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md

Project Overview

coc.nvim is a language client framework for Vim and Neovim. It provides LSP integration, extension APIs, completion, diagnostics, workspace management and plugin infrastructure.

This project is performance-sensitive and must maintain compatibility with existing Vim/Neovim users.


Compatibility Requirements

Maintain compatibility with:

  • Vim 9+ and neovim
  • Existing coc.nvim extensions
  • Existing user configurations

Avoid:

  • breaking public APIs
  • changing extension behavior unintentionally
  • changing configuration semantics

TypeScript Rules

  • Use strict TypeScript.
  • Avoid any unless unavoidable.
  • Prefer existing utility functions over introducing new helpers.

Async and Resource Management

Be careful with:

  • promises
  • event listeners
  • timers
  • child processes
  • RPC channels
  • Vim/Neovim lifecycle

Every created resource should have a clear cleanup path.

Check:

  • error handling
  • cancellation
  • process shutdown
  • disposal behavior

Git Rules

Before editing:

  • inspect git history when behavior is unclear
  • understand why existing code exists

Do not remove existing code only because it looks unused.


Forbidden Actions

Do not:

  • change public APIs without discussion
  • remove compatibility code without proof

Add documentation

  • When add new feature and introduce break changes, add the change to history.md.
  • Update doc/coc.txt after vim interface change.
  • Update doc/coc-api.txt after API change.
  • Update doc/coc-config.txt after coc.nvim configuration change.

Code Review Rules

  • Report only consequential correctness, compatibility, lifecycle, concurrency, and performance issues.
  • Check that public coc.nvim APIs remain stable and properly typed.
  • Check Vim and Neovim behavior, buffer switching, cancellation, disposal, and asynchronous race conditions.
  • Ignore formatting and lint issues already covered by CI.

Testing

  • Jest is not used by this project, never invoke Jest.
  • Use node scripts/test/cli.mjs <path_to_file> for run specific test file.

Download now (ZIP)

Trending

Quiet since August.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 2 mentionsSep 2026: 0 mentionsOct 2026: 0 mentionsNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the neoclide/coc.nvim repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about neoclide/coc.nvim

The biggest 5 of 76 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 76

Talked about on GitHub, Stack Overflow, YouTube, Hacker News, the web and Bluesky (76 times).

On GitHub · 28

23 more on GitHub

On Stack Overflow · 20

15 more on Stack Overflow

On YouTube · 15

10 more on YouTube

On the web · 3

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.