Module url-open.modules.options

Provide options for the plugin

Functions

apply_user_options (user_opts) Apply user options
validate_opts (opts) Validate options

Tables

DEFAULT_OPTIONS Default options


Functions

apply_user_options (user_opts)
Apply user options

Parameters:

  • user_opts table : User options

Returns:

    table: Merged options

See also:

validate_opts (opts)
Validate options

Parameters:

  • opts table : Options to validate

Returns:

    table|nil: Validated options

See also:

Tables

DEFAULT_OPTIONS
Default options

Fields:

  • open_app string : The app to open the url with
  • open_only_when_cursor_on_url boolean : Open url only when cursor on url
  • highlight_url : Highlight url options
    • all_urls table : Highlight all urls options
    • cursor_move table : Highlight url when cursor move options
    • all_urls.enabled boolean : Enable highlight all_urls options
    • all_urls.fg string : Highlight foreground color
    • all_urls.bg string : Highlight background color
    • all_urls.underline boolean : enable underline
    • cursor_move.enabled boolean : Enable highlight cursor_move options
    • cursor_move.fg string : Highlight foreground color
    • cursor_move.bg string : Highlight background color
    • cursor_move.underline boolean : enable underline
  • deep_pattern boolean : Enable deep pattern
  • extra_patterns table : A list of extra patterns to open url
generated by LDoc 1.5.0 Last updated 2023-11-17 07:26:28