При создании плагина сниппета Laravel для текстового редактора Atom я подумал, что было бы полезно создать удобную для человека документацию для всех фрагментов, содержащихся в моем плагине Atom. Этот пост представляет собой краткое руководство, демонстрирующее, как анализировать файлы CSON и создавать документацию для вашего плагина Atom.
Фрагменты Atom используют CSON (CoffeeScript-Object-Notation), который является достаточно читаемым форматом, но я хотел объединить все фрагменты в сгенерированный, удобочитаемый документ разметки.
Вы можете увидеть скрипт docs.js в моем плагине Larasnippets:
Этот сценарий определяет объект Snippet, а затем просматривает все .cson файлы. Модуль cson анализирует каждый файл сниппета в Object, который затем помещается в массив объектов сниппета. Наконец, я использовал lodash для создания шаблонов блока документации и циклического просмотра фрагментов.
Вы можете ознакомиться с примером вывода уценки, сгенерированного из скрипта Node.js.
Первоначально опубликовано на bitpress.io 14 февраля 2017 г.
