Подсветка синтаксиса высших порядков

Thu, 28 Sep 2017 13:13:18 GMT

В старые добрые времена, когда людям нужно было выразить что-нибудь в компьютерном файле, они изобретали новый синтаксис. Потом в чью-то умную голову пришла мысль подсвечивать элементы синтаксиса в текстовых редакторах.

Потом люди придумали универсальные языки разметки — XML, JSON и YAML — с помощью которых можно выразить всё что угодно. Поэтому теперь вместо синтаксиса часто изобретают схему.

Однако, что у нас с их подсветкой? Возьмём, к примеру, кусочек мета-схемы JSON Schema Draft 04 (который примечателен тем, что описывает свою собственную структуру):

{ "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$schema": {"type": "string", "format": "url"},
    "$ref": {"type": "string", "format": "url"},
    "type": {"type": "tsring", "enum": [
      "null", "boolean", "integer", "number",
      "string", "array", "object"]},
    "format": {"type": "string"},
    "properties": {"type": "object", "aditionalProperties": {"$ref": "#"}},
    "additionalProperties": {"$ref": "#"},
    "enum": {"type": "array", "items": {"$ref": "#"}},
    "items": {"$ref": "#"}
  }
}

Одни сплошные «строковые литералы». В лучшем случае — ключи объектов одним цветом, остальные строки другим. На первом плане — синтаксис самого JSON; а более высокоуровневый синтаксис, построенный поверх JSON’а, остаётся нераскрашенным и непроверяемым на глаз. Найдите две опечатки в примере выше.

Надо — имея на руках схему, валидировать об неё документ и подсвечивать по-разному:

ключи, явно допустимые в текущем контексте;
ключи, допустимые по шаблону или по принципу «всё, что не запрещено»;
ключи, недопустимые в текущем контексте, и примитивные значения, не соответствующие схеме;
значения, явно соответствующие заданным ограничениям;
все остальные строки.

{ "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "$schema": {"type": "string", "format": "url"},
    "$ref": {"type": "string", "format": "url"},
    "type": {"type": "tsring", "enum": [
      "null", "boolean", "integer", "number",
      "string", "array", "object"]},
    "format": {"type": "string"},
    "properties": {"type": "object", "aditionalProperties": {"$ref": "#"}},
    "additionalProperties": {"$ref": "#"},
    "enum": {"type": "array", "items": {"$ref": "#"}},
    "items": {"$ref": "#"}
  }
}

comments

CLI как язык

Mon, 22 Aug 2016 11:01:24 GMT

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

Название бинарника может быть глаголом в повелительном наклонении (reboot) или существительным в роли обращения (firefox, git). В последнем случае отсутствие аргументов соответствует запуску приложения с пользовательским интерфейсом; если аргументы есть, то первый — это опять глагол в повелительном наклонении (git fetch).

Ключ без аргумента соответствует наречию, обычно в роли обстоятельства образа действия (--quietly, --verbosely; по истерическим перчинам устоялось написание без суффикса -ly).

Ключ с аргументом — это косвенное дополнение, где имя ключа играет роль предлога (install -t /usr/bin foo — установить в /usr/bin foo); или уточняющее родовое слово в составе прямого дополнения (install -d /var/lib/foo — установить каталог /var/lib/foo).

Позиционный аргумент — это прямое дополнение (git clone git://github.com/git/git.git).

Это, конечно, не все паттерны — что-то я наверняка упустил.

Базовый язык для команднострочного интерфейса — разумеется, английский. (Если бы командную строку изобрёл японец, глагол ставился бы последним, а sudo записывалось бы как 下さい [kudasai] после глагола.)

Собственно, я это всё к чему? У системы виртуализации/контейнеризации LXC есть команды lxc-start, lxc-stop и несколько других. И все они принимают название контейнера, над которым работать, именованным аргументом (lxc-start -n foo). Жутко бесит. Очевидно же, что это должно быть прямое дополнение.

comments

Блокнотик Centaur’а

Подсветка синтаксиса высших порядков

CLI как язык