Публикация вашего пакета в npm не ограничивается одной командной строкой «опубликовать npm», есть и другие шаги, которые вы должны выполнить, прежде чем выпустить свой продукт для других разработчиков. Но есть ли способ оптимизировать это в одной командной строке? Да!
Aux4 — это генератор CLI (интерфейса командной строки) с открытым исходным кодом, удобный для использования в вашем проекте. Он генерирует CLI из простого файла JSON.
Структура JSON проста, это объект со списком профилей. Каждый профиль имеет имя и список команд. Основной профиль — это место, где aux4 начнет перечислять ваши команды.
Установить aux4
Aux4 — это пакет npm, вы можете легко установить его:
Создайте файл .aux4
Вы можете создать файл .aux4 в корне вашего проекта.
Выполнять
Для выполнения просто используйте команду aux4 из корневой папки вашего проекта или любой подпапки. Результат будет npm publishing.
Добавьте реальные шаги
Допустим, первый шаг, который вы хотите сделать, это выполнить тесты, изменить версию в файле package.json, после этого собрать пакет, создать тег в git и, наконец, опубликовать в npm, и. отправка ваших изменений в репозиторий. Вот шаги:
- контрольная работа
- определить версию npm
- строить
- git-тег
- публиковать нпм
- git push
В этом посте я просто показываю, что вы можете сделать, но должны адаптироваться к реальности вашего проекта и выполнять необходимые шаги.
Что это за строки?
Я собираюсь описать каждую строчку, чтобы было понятнее.
нпм-тест
выполнить тесты.
патч версии npm
увеличить патч текущей версии, определенный в вашем файле package.json. например: если ваша текущая версия 1.0.1, она будет увеличиваться до 1.0.2.
npm запустить сборку
он построит ваш проект, если вы определили его в сценариях. Вы можете сделать это по-разному, это просто демонстрация.
json:кошка package.json
cat package.json выведет содержимое файла на вывод консоли. Префикс json: преобразует строку JSON в объект JSON.
set:versionNumber=${response.version}
В aux4 ${response} — это вывод предыдущей строки, в данном случае, как в предыдущей строке мы преобразовали JSON в объект, мы можем получить доступ к его свойствам.
Здесь это установка переменной versionNumber с версией пакета. Структура set:variable=value.
тег git -a ${номер_версии} -m ‘${номер_версии}’
Создайте метку в репозитории с той же версией.
git push — следующие теги
Отправьте в репозиторий git только теги.
публиковать npm ./сборка
Опубликуйте пакет в npm.
rm -rf сборка (необязательно)
Удаляет папку build. Это не нужно, но может быть полезно.
git push
Отправляет ваши изменения в репозиторий git.
echo ${versionNumber} успешно выпущен
Отображает 1.0.2 released successfully на выходе.
Добавьте документацию к вашей команде
Aux4 позволяет документировать ваши команды, поэтому другие люди, использующие его, могут легко понять, какова цель ваших команд. Для этого вам просто нужно добавить раздел справки к вашей команде.
Документация отображается при выполнении команды aux4.
Добавить параметр
Вы можете добавить параметр, если не хотите каждый раз выпускать patch. Так что в параметре вы можете указать, какой тип версии вы выпускаете.
Переменные имеют три атрибута:
name: имя переменнойtext: документация переменнойdefault: значение по умолчанию, если переменная не определена.
версия npm ${версия}
Использование переменной для указания типа версии.
Документация
Исполнение
Вывод
aux4 — отличный инструмент для оптимизации вашего времени, упрощения и документирования ваших сценариев, а также облегчения обмена ими с вашей командой.
Основное преимущество использования aux4 позволяет всей вашей команде не забыть ни одного важного шага при выполнении какой-либо задачи. поделившись своим персональным проектным инструментом с вашей командой.
Комментарий
Ваше мнение имеет значение, что вы думаете о aux4? Собираетесь ли вы использовать его в своем проекте? Пожалуйста, поделитесь своими мыслями в разделе комментариев.
