Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pluginapi

package

Go to main page

Versions in this module

v0

v0.8.0

Dec 6, 2025

Changes in this version

+ type ActionExportResult struct

+ Action string

+ Exported []keybinding.Keybinding

+ Reason string

+ Requested []keybinding.Keybinding

+ type ExportedReport struct

+ Actions []ActionExportResult

type PluginExportReport

+ ExportedReport ExportedReport

v0.7.2

Dec 4, 2025

Changes in this version

type PluginExportOption

+ TargetPlatform platform.Platform

type PluginImportOption

+ SourcePlatform platform.Platform

v0.7.1

Nov 26, 2025

Changes in this version

+ var ErrActionNotSupported = errors.New("action not supported")

+ var ErrNotSupported = errors.New("not supported")

+ type ConfigDetectOptions struct

+ Sandbox bool

+ type EditorSupportOnlyOneKeybindingPerActionError struct

+ SkipKeybinding *keybinding.Keybinding

+ func (e *EditorSupportOnlyOneKeybindingPerActionError) Error() string

+ type EditorType string

+ const EditorTypeBasekeymap

+ const EditorTypeClion

+ const EditorTypeCursor

+ const EditorTypeGoLand

+ const EditorTypeHelix

+ const EditorTypeIntelliJ

+ const EditorTypeIntelliJCommunity

+ const EditorTypePhpStorm

+ const EditorTypePyCharm

+ const EditorTypeRubyMine

+ const EditorTypeRustRover

+ const EditorTypeUnknown

+ const EditorTypeVSCode

+ const EditorTypeVim

+ const EditorTypeWebStorm

+ const EditorTypeWindsurf

+ const EditorTypeWindsurfNext

+ const EditorTypeXcode

+ const EditorTypeZed

+ func (e EditorType) AppName() string

+ type ExportSkipAction struct

+ Action string

+ Error error

+ type ExportSkipReport struct

+ SkipActions []ExportSkipAction

+ type ImportSkipAction struct

+ EditorSpecificAction string

+ Error error

+ type ImportSkipReport struct

+ SkipActions []ImportSkipAction

+ type Plugin interface

+ ConfigDetect func(opts ConfigDetectOptions) (paths []string, installed bool, err error)

+ EditorType func() EditorType

+ Exporter func() (PluginExporter, error)

+ Importer func() (PluginImporter, error)

+ type PluginExportOption struct

+ ExistingConfig io.Reader

+ type PluginExportReport struct

+ BaseEditorConfig any

+ Diff *string

+ ExportEditorConfig any

+ SkipReport ExportSkipReport

+ type PluginExporter interface

+ Export func(ctx context.Context, destination io.Writer, setting keymap.Keymap, ...) (*PluginExportReport, error)

+ type PluginImportOption struct

+ type PluginImportReport struct

+ SkipReport ImportSkipReport

+ type PluginImportResult struct

+ Keymap keymap.Keymap

+ Report PluginImportReport

+ type PluginImporter interface

+ Import func(ctx context.Context, source io.Reader, opts PluginImportOption) (PluginImportResult, error)

+ type UnsupportedExportActionError struct

+ Note string

+ func (e *UnsupportedExportActionError) Error() string