google / google/vim-codefmt

Better instructions for writing a plugin with a custom formatter

Open
#74 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Vim Script
Stars
1.1k
Forks
102
PR merge metrics
No merged PRs in 30d

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?

Contributor guide

Open the contributing guide

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.