hs.spoons

Сопоставление нескольких горячих клавиш в соответствии с таблицей определений

• def — таблица, содержащая определения функций для горячих клавиш, поддерживаемых Spoon. Каждый ключ — это имя горячей клавиши, а его значение — функция, которая будет вызвана при нажатии горячей клавиши.
• map — таблица, содержащая определения горячих клавиш и необязательное сообщение, которое будет отображено с помощью hs.alert(), когда горячая клавиша была нажата, как это поддерживается в bindHotkeys в API Spoon. Не все записи в def должны быть привязаны, но если у каких-либо ключей в map нет определения, будет сгенерирована ошибка.

• Ничего

Проверка, установлен ли данный Spoon.

• name — имя Spoon для проверки.

• Если Spoon установлен, возвращает таблицу с информацией о Spoon, как возвращается list(). Возвращает nil, если Spoon не установлен.

Проверка, загружен ли данный Spoon.

• name — имя Spoon для проверки.

• true если Spoon загружен, nil в противном случае.

Возвращает список установленных/загруженных Spoon

• onlyLoaded — возвращать только загруженные Spoons (пропускает те, которые установлены, но не загружены). По умолчанию false

• Таблица со списком установленных/загруженных Spoon (в зависимости от значения onlyLoaded). Каждая запись — таблица со следующими записями:
  • name — имя Spoon
  • loaded — логическое значение, указывающее, загружен ли Spoon (true) или только установлен (false)
  • version — номер версии Spoon. Доступен только для загруженных Spoon.

Создаёт шаблон нового Spoon

• name: имя нового spoon без расширения .spoon
• basedir: (необязательно) каталог, в котором следует создать шаблон. По умолчанию ~/.hammerspoon/Spoons
• metadata: (необязательно) таблица, содержащая значения метаданных, которые следует вставить в шаблон. Предоставленные значения объединяются со значениями по умолчанию. По умолчанию: { version = "0.1", author = "Your Name <your@email.org>", homepage = "https://github.com/Hammerspoon/Spoons", license = "MIT - https://opensource.org/licenses/MIT", download_url = "https://github.com/Hammerspoon/Spoons/raw/master/Spoons/"..name..".spoon.zip" }
• template: (необязательно) абсолютный путь к шаблону для использования для файла init.lua нового Spoon. По умолчанию — файл templates/init.tpl входящий в комплект Hammerspoon.

• Полный путь к каталогу, где был создан шаблон, или nil в случае ошибки.

Возвращает полный путь к объекту в каталоге spoon, заданный его частичным путем.

• partial — путь к файлу относительно каталога Spoon. Например, images/img1.png будет ссылаться на файл в каталоге images Spoon.

• Абсолютный путь к файлу. Примечание: проверки существования или других проверок пути не выполняется.

Возвращает путь к текущему spoon.

• n — (необязательно) уровень стека, для которого нужно получить путь. По умолчанию 2, что вернёт путь spoon, вызвавшего scriptPath()

• Строка с путём, из которого был загружен вызывающий код.

Декларативное загрузка и настройка Spoon

• name — имя Spoon для загрузки (без расширения .spoon).
• arg — если предоставлено, может использоваться для задания конфигурации Spoon. Признаются следующие ключи (все необязательны):
  • config — таблица, содержащая переменные, которые нужно сохранить в объекте Spoon для его настройки. Например, config = { answer = 42 } приведет к тому, что spoon.<LoadedSpoon>.answer будет установлено в 42.
  • hotkeys — таблица, содержащая привязки горячих клавиш. Если предоставлено, оно будет передано как есть методу Spoon bindHotkeys(). Специальная строка "default" может быть использована для использования переменной Spoon defaultHotkeys, если она существует.
  • fn — функция, которая будет вызвана с объектом свежезагруженного Spoon в качестве первого аргумента.
  • loglevel — если у Spoon есть переменная logger, её метод setLogLevel() будет вызван со значением этого параметра.
  • start — если true, вызовите метод Spoon start() после конфигурирования всего остального.
• noerror — если true, не записывайте ошибку, если Spoon не установлен, просто верните nil.

• true если spoon был загружен, nil в противном случае