Class Neovim::Plugin::DSL
In: lib/neovim/plugin/dsl.rb
Parent: BasicObject

The DSL exposed in +Neovim.plugin+ blocks.

@api public

Methods

autocmd   command   function   new  

Public Class methods

Public Instance methods

Register an nvim autocmd. See +:h autocmd+.

@param event [String] The event type. See +:h autocmd-events+ @param options [Hash] Autocmd options. @param &block [Proc, nil] The body of the autocmd.

@option options [String] :pattern The buffer name pattern.

  See +:h autocmd-patterns+.

@option options [String] :eval An nvim expression. Gets evaluated and

  passed as an argument to the block.

Register an nvim command. See +:h command+.

@param name [String] The name of the command. @param options [Hash] Command options. @param &block [Proc, nil] The body of the command.

@option options [Integer] :nargs The number of arguments to accept. See

  +:h command-nargs+.

@option options [String, Boolean] :range The range argument.

  See +:h command-range+.

@option options [Integer] :count The default count argument.

  See +:h command-count+.

@option options [Boolean] :bang Whether the command can take a +!+

  modifier. See +:h command-bang+.

@option options [Boolean] :register Whether the command can accept a

  register name. See +:h command-register+.

@option options [Boolean] :complete Set the completion attributes of

  the command. See +:h command-completion+.

@option options [String] :eval An nvim expression. Gets evaluated and

  passed as an argument to the block.

@option options [Boolean] :sync (false) Whether nvim should receive

  the return value of the block.

Register an nvim function. See +:h function+.

@param name [String] The name of the function. @param options [Hash] Function options. @param &block [Proc, nil] The body of the function.

@option options [String, Boolean] :range The range argument.

  See +:h command-range+.

@option options [String] :eval An nvim expression. Gets evaluated and

  passed as an argument to the block.

@option options [Boolean] :sync (false) Whether nvim should receive

  the return value of the block.

[Validate]