exporterapi

type DiffType int

type ExportOptions struct {
	// Editor type
	EditorType pluginapi.EditorType
	// Optional, existing base keymap for specific editor
	Base io.Reader
	// TODO(xinnjie): export api level enum is not a good idea
	DiffType DiffType
	// file path for the keymap config
	FilePath string
}

type ExportReport struct {
	// The diff between the base and the exported keymap.
	Diff string

	// SkipActions reports actions that were not exported and why.
	SkipActions []pluginapi.ExportSkipAction
}

type Exporter interface {
	// Export converts a KeymapSetting and writes it to a destination stream.
	// It returns a report detailing any issues encountered during the conversion.
	Export(
		ctx context.Context,
		destination io.Writer,
		setting keymap.Keymap,
		opts ExportOptions,
	) (*ExportReport, error)
}