changelog-editor

1.2.2 • Public • Published

Редактор ChangeLog Yaml

Предполагается, что в вашем проекте есть файл changelog.yaml, из которого в каком-либо представлении (например окно 'О программе') отображается история изменений вашей программы. Данное решение позволяет из командной строки запускать визуальный редактор этого файла.

Как использовать?

Установить зависимость:

yarn add changelog-editor --dev
npm install changelog-editor --save-dev

Прописать в файле package.json скрипт:

{
  "scripts": {
    "changelog": "changelog-editor",
    "changelog:testing": "changelog-editor --testing"
  }
}

Скрипт changelog:testing не обязательно прописывать. Здесь --testing опция для запуска приложения в режиме тестирования клиентской части редактора истории изменений (см. testing environment из Sencha ExtJS). Нужен для отладки данного приложения на production пользователей.

Создать файл changelogeditor.json:

{
  "file": "packages/local/pir-app/resources/changelog.yaml"
}

В файле указать местоположение файла истории изменений.

Теперь по следующей команде будет запускаться редактор истории изменений и автоматически открывать нужный файл:

yarn changelog
npm run changelog

Не забывайте после изменений сохранять файл (кнопка Сохранить). Автосохранение пока не реализовано.

Readme

Keywords

none

Package Sidebar

Install

npm i changelog-editor

Weekly Downloads

1

Version

1.2.2

License

ISC

Unpacked Size

14.6 MB

Total Files

753

Last publish

Collaborators

  • khusamov