UP | HOME

Table of Contents

Module: yalms.dev

Classes

Class: Global

Fields
  • __yalms_dev (DevManager)

Class: DevOpts

Fields
  • dir? (string) Scratch storage
  • plugins (table<string,) DevPluginOpts> Key = plugin name, Value = { path, opts }

Class: DevPluginOpts

Fields
  • path (string) Absolute path to watch
  • root? (string) Root of the plugin's source code
  • opts? (table) Options to pass to plugin.setup() on file change

Class: DevPluginRt (extends DevPluginOpts)

Fields
  • title (string)
  • scratch_path? (string)
  • scratches? (string[]) Additional scratch names (relative to plugin dir)

Class: DevManagerOpts

Fields
  • dir (string)
  • plugins (table<string,) DevPluginOpts> Key = plugin name, Value = { path, opts }

Class: DevManagerRt (extends DevManagerOpts)

Fields
  • plugins (table<string,) DevPluginRt> Key = plugin name, Value = { path, opts }
  • _config_path (string) Path to persist scratches config

Class: DevManager

Fields
  • _opts (DevManagerRt)
  • _watchers (table<string,) any>
  • _watch_config_s (table<string,) DevPluginOpts>

Class: DevScratchesPickerConfig (extends snacks.picker.Config)

Fields
  • level (integer) Current depth level: 1 = plugins, 2 = plugin's scratches
  • current_plugin (string?) The plugin name when level == 2

Class: DevScratchesPicker (extends snacks.Picker)

Fields
  • opts (DevScratchesPickerConfig)

Class: DevScratchesPickerItem

Fields
  • name (string) Display name (plugin name or scratch name)
  • file (string) File path to open
  • ft (string)
  • is_default (boolean) Whether this is the default scratch
  • plugin_name (string) Parent plugin name

Functions

setup(opts)

yalms.dev.setup

Parameters
  • opts (DevOpts|true, optional)

reload()

yalms.dev.reload

new(opts)

DevManager:new

Parameters
  • opts (DevManagerOpts)

_loadconfig()

DevManager:_load_config

Load scratches config from JSON

_saveconfig()

DevManager:_save_config

Save scratches config to JSON

list()

DevManager:list

Returns
  • table<string, DevPluginRt>

openscratch(pluginname, scratchname)

DevManager:open_scratch

Open a specific scratch by plugin name and scratch name

Parameters
  • plugin_name (string)
  • scratch_name (string)

_scratchdir(pluginname)

DevManager:_scratch_dir

Get the directory for additional scratches for a plugin

Parameters
  • plugin_name (string)
Returns
  • string

_scratchpath(pluginname, scratchname)

DevManager:_scratch_path

Get the full path for an additional scratch

Parameters
  • plugin_name (string)
  • scratch_name (string)
Returns
  • string

listscratches(pluginname)

DevManager:list_scratches

List all scratches for a plugin (including default scratchpath)

Parameters
  • plugin_name (string)
Returns
  • {name: string, file: string, isdefault: boolean}[]

addscratch(pluginname, scratchname)

DevManager:add_scratch

Add a new scratch for a plugin

Parameters
  • plugin_name (string)
  • scratch_name (string)
Returns
  • boolean success
  • string|nil err

removescratch(pluginname, scratchname)

DevManager:remove_scratch

Remove a scratch for a plugin (cannot remove default scratchpath)

Parameters
  • plugin_name (string)
  • scratch_name (string)
Returns
  • boolean success
  • string|nil err

renamescratch(pluginname, oldname, newname)

DevManager:rename_scratch

Rename a scratch for a plugin

Parameters
  • plugin_name (string)
  • old_name (string)
  • new_name (string)
Returns
  • boolean success
  • string|nil err