Git-commit-plugin Для Vscode Плагин, автоматически генерирующий стандартную информацию о фиксации git.

Visual Studio Code

первоначальное намерение

В компании ведь каждый подчиняется по желаниюgit-commit, что приводит к странному стилю подачи, и написанная информация не ясна. Я не знаю, является ли эта отправка исправлением.bugШерстяная ткань? Все еще добавляя новые функции, или просто изменяя некоторые файлы конфигурации, или рефакторинг некоторого плохого кода. Вы можете полагаться только на собственные догадки.Даже если вы отправляете информацию сами, вы можете не знать, для чего конкретно предназначена отправка из-за долгого времени.Вы можете только перейти к записи отправки, чтобы пролистать код.Если дела пойдут таким образом, это не способствует итерации продукта. , и дляbugпозиционирование.

зачем писать этот плагин

По этой причине мы начали искать более канонический формат отправки,AngularкомандаAngular Team Commit SpecificationВ поле нашего зрения формат выглядит следующим образом:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Четкое представление сообщения, которое заставляет нас чувствовать, что это то, что мы ищем! Для этого начинаем поискIDEНет соответствующих плагинов, которые можно использовать, к счастью, бэкэндJavaиспользуется командойIDEAЕсть готовые плагины, которые можно использовать напрямую, и наша фронтенд-команда использует их единообразно.Vscode, Я видел несколько плагинов, но ни один из них не соответствовал нашим требованиям.Чтобы не задерживать команду фронтенда, я подумал написать плагин, отвечающий требованиям для использования командой.

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

  1. Сначала нам нужно пойтиVscodeПоиск на рынке плагинов git-commit-pluginи установите его.

2. После установки можно использовать комбинацию клавишCommand + Shift + Pвызыватькомандная строкаи введите командуshow git commit templateили нажмитеgitМаленькая иконка на панели плагинов активирует интерфейс плагина.open.gif3. В соответствии со значением, которое должно быть выражено вашим текущим представлением, выберите соответствующийtypeвведите, чтобы написатьcommitИнформацияedit.gif

Эпилог

При написании плагинов я тоже наступил на много ям.Официальная документация сайта для того, чтобы найтиAPIПосмотрите также, чтобы увидеть это, но окончательное решение проблемы стоит. Если вы считаете, что этот проект вам поможет, не давайте руку скупой ✨Проэктнажмитеstar✨, Ваше поощрение - самая большая поддержка для автора! ОбнаружитьbugИли, если у вас есть какие-либо моменты, которые вы хотите улучшить, вы также можете упомянуть об этом в рамках проекта.issue😘.

Обновлено 30 марта 2020 г.

Сообщество воспитало много хорошегоissue, также упомянул многихPR, с ремонтомbugДа, есть также некоторые функции, которые я надеюсь добавить в этот раз.0.0.4Обновление версии реализовано и решено!

обновить содержимое

✨Подвиг

  • GitCommitPlugin.ShowEmoji: Можно ли настроить поддержку или нетEmojiпрефикс, по умолчаниюtrue 
    GitCommitPlugin.ShowEmoji:true
  • GitCommitPlugin.CustomCommitType: поддерживает пользовательскиеCommit Typeпрефикс, по умолчаниюnull 
    GitCommitPlugin.CustomCommitType:[
  "customTypeName"
]
  • GitCommitPlugin.MaxSubjectWords: поддержка модификацииSubjectМаксимальное количество символов, по умолчанию20 
    GitCommitPlugin.MaxSubjectWords:20

🐞 Исправление ошибок

Обновлено 22 сентября 2020 г.

✨Подвиг

  • GitCommitPlugin.CustomCommitType: поддерживает пользовательскиеCommit Typeпрефикс, по умолчаниюnull 
    GitCommitPlugin.CustomCommitType:[
  "customTypeName"
]  or [
 {
     "label": "customTypeName",
     "detail": "customTypeDetail"
 }
]

🐞 Исправление ошибок

Категории