Better instructions for writing a plugin with a custom formatter

Open
#74 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
vim
Domain
documentation

Research direction

Start by reading the existing vim-codefmt documentation and the plugin's formatter integration points. Document how to write a lightweight plugin for a custom formatter, including the required interface and a working usage example. Done means a newcomer can follow the instructions to create and use such a plugin.

Written by the indexing model from the issue text.

Description

Maybe I've missed it, but it's not obvious to me how to write a plugin that plays nice with vim-codefmt. We have a custom code formatter at work, and I'd really like to write a lightweight internal plugin that uses codefmt to do the heavy interface lifting.

Any tips?

Dominant language
Vim Script
Stars
1.1k
Forks
102
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from google/vim-codefmt

All issues in google/vim-codefmt

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.