GitGud

Гитгуд

Введение

Gitgud-это репозиторий с открытым исходным кодом, предназначенный для того, чтобы предоставить начинающим и опытным разработчикам платформу для изучения и улучшения своих навыков GIT. Репозиторий построен с целью предоставления интерактивного опыта обучения для разработчиков всех уровней квалификации. Независимо от того, начинаете ли вы только работу с GIT или хотите улучшить свои существующие навыки, Gitgud предоставляет обширный набор ресурсов и инструментов, которые могут помочь вам освоить GIT. Gitgud позволяет легко визуализировать и полностью использовать GIT в ваших проектах. Он создается с использованием чернил, которая обеспечивает тот же опыт построения пользовательского интерфейса на основе компонентов, который реагирует, но в интерфейсе командной строки (CLI).

Требования

• Установить хотя бы GIT версии 2.24.3
• Установить NPM
• Мы не рекомендуем использовать iTerm2 для Gitgud из -за проблем с видом. Гипер или терминал по умолчанию - хорошие альтернативы.

---

Установка

 $ npm install --global gitgud

---

Это установит пакет во всем мире

Использование

 $ GitGud

• Перейдите к любому проекту, который имеет в нем каталог GIT, и запустите команду «Gitgud». Это загрузит интерфейс Gitgud в окно вашего терминала

• Пользовательский интерфейс Gitgud состоит из: неустойчивых изменений, поставленных изменений, кнопок и кнопок функциональности GIT ветви

• Перейдите по пользовательскому интерфейсу с помощью кнопки «вкладка» или клавиш со стрелками влево/правый

• Нажмите кнопку «Ввод/возврат», чтобы выбрать/нажать опцию

• На протяжении всего приложения вы можете нажать кнопку «ESC» (Escape), чтобы вернуться назад

• Вы можете выйти из приложения, запустив Ctrl + C

---

Функциональность

• Смены сцены

  • Вы можете выбрать STAGE/UNSTAGE (all files) чтобы переместить все файлы между изменениями этапа и изменениями.
  • Если вы нажмете на него, как только он переместит все файлы из раздела «Unsted Lears» в пользовательском интерфейсе в «Изменения на сцене». Если вы нажмете его снова, это отменит «поставленные изменения» и перенесет файлы обратно в «Unsted Change» и так далее.
  • У вас также есть возможность поставить/нести отдельные файлы, перемещаясь по ним с помощью клавиш вверх/вниз.
  • Нажмите «ESC», чтобы выйти из меню «Изменения сцены».

• Совершить изменения

  • Он побудит вас ввести «сообщение о коммите», которое не требует от вас обертывания ввода в кавычки. После вступления и отправки сообщения о коммите, оно запустит коммит и вернет вас в главное меню.
  • Нажмите «ESC», чтобы выйти из изменений коммита.

• Протолкнуть поэтапные изменения

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

• Оформление филиала

  • Он отобразит список всех филиалов в проекте. Ветви не выбираются, они там, чтобы помочь вам увидеть, какие локальные ветви доступны для переключения.
  • Вам предложено войти в филиал для оформления заказа. Если вы войдете в филиал, которой не существует, она создаст новую.
  • Если у вас есть неостановленные изменения, будет показана ошибка, и она прервет операцию оформления заказа, заявив вам, что у вас есть неостановленные изменения и совершать или спрятать изменения перед переключением ветвей. Вы можете нажать «ESC», чтобы вернуться назад и спрятать/совершить изменения, прежде чем попытаться снова зарекомендовать себя

• Удалить ветвь

  • Он будет отображать список ветвей, которые не выбираются, они там, чтобы помочь вам увидеть, какие локальные филиалы доступны.
  • Вам предложено войти в название ветви, и если ветвь существует, она удалит/удалит его и вернет вас в главное меню. Если ветвь не существует, то она бросит ошибку.
  • Нажмите «ESC», чтобы выйти из удаления ветви

• Доступ к полному дереву журнала

  • Это сделает все бревенчатое дерево, наложенное на графический интерфейс Gitgud.
  • Нажмите «ESC», чтобы выйти из дерева журнала

---

Стиль

Gitgud позволяет пользователям настраивать как внешний вид приложения, редактируя «StyleFile».

Чтобы получить доступ к «stylefile» глобально установленного Gitgud, вам сначала нужно будет выяснить, где NPM сохраняет ваши глобально установленные файлы. Для этого запустите следующую команду:

 npm root -g

Это вернет местоположение ваших глобально установленных пакетов NPM.

На Mac вы должны увидеть что -то вроде этого: /usr/local/lib/node_modules

В Windows вы можете получить это: *c: users you appdata roaming npm node_modules

Перейдите к тому, где хранятся ваши глобальные пакеты, откройте папку Gitgud, а затем откройте файл StyleFile в редакторе (команда: nano styleFile.js откроет его в большинстве систем Mac/Linux).

Когда вы откроете файл, он будет выглядеть так:

• showLogo :

  • По умолчанию это установлено на false , но если вы хотите иметь логотип Gitgud поверх вашего графического интерфейса, вы можете изменить это на true .

• defaultColor :

  • Это цвет для основных текстовых блоков по всему приложению.

• accentColor :

  • Это цвет для границ приложения, а также некоторые текстовые заголовки по всему приложению.

• gitTreeColor :

  • Это цвет для шрифта git tree на протяжении всего приложения.

• appResize :

  • Это позволяет приложению быть отзывчивым, что позволяет пользователям изменять размер их консоли Windows без перезапуска приложения. Это может снизить производительность для некоторых пользователей.

• showFlag :

  • Позволяет пользователю выбрать, следует ли отображать выходные теги GIT с помощью поставленных/неуверенных файлов.
  • Установить на false по умолчанию.
  • Смотрите здесь для получения дополнительной информации о выводах GIT

---

Часто задаваемые вопросы

---

Внося

Gitgud - это полностью проект с открытым исходным кодом, и взносы приветствуются!

При отправке запроса на привлечение, пожалуйста, четко объясните добавленную вами функцию, или исправленную вами ошибку.

Впервые участники также приветствуются! Есть некоторые проблемы, отмеченные good first issue . Это может быть хорошим местом для начинающих!

Спасибо Joseph Garrone за то, что он дал нам название пакета NPM.