Документация

Ниже представлена справочная информация по API этого модуля.

GitStats(dataPath)

Параметры:

• String dataPath: путь к файлу данных.

Возвращает:

• GitStats экземпляр GitStats.

getConfig(callback)

Получает объект конфигурации из файла (~/.git-stats-config.js).

Параметры:

• Function callback: функция обратного вызова.

Возвращает:

• Object|Undefined если обратный вызов не предоставлен, будет возвращён объект конфигурации.

initConfig(input, callback)

Инициализирует поле конфигурации (this.config).

Параметры:

• Object|String input: путь к пользовательскому файлу конфигурации git-stats или объект конфигурации.
• Function callback: функция обратного вызова.

record(data, callback)

Записывает новый коммит.

Параметры:

• Object data: данные коммита, содержащие:
  • date (String|Date): объект даты или строка в формате, который можно проанализировать.
  • url (String): удалённый URL репозитория.
  • hash (String): хэш коммита.
  • _data (Object): если это поле предоставлено, оно должно быть содержимым файла данных git-stats в виде объекта. Оно будет изменено в памяти и затем возвращено.
  • save (Boolean): если false, результат не будет сохранён в файле.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

removeCommit

Удаляет определённый коммит из истории.

Параметры:

• Object data: данные коммита, содержащие:
  • date (String|Date): объект даты или строка в формате, который можно проанализировать. Если не предоставлено, хэш объекта будет искаться во всех датах.
  • hash (String): хеш коммита.
  • _data (Object): если это поле предоставлено, оно должно быть содержимым файла данных git-stats в виде объекта. Оно будет изменено в памяти и затем возвращено.
  • save (Boolean): если false, результат не будет сохранён в файле.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

get(callback)

Получает статистику git.

Параметры:

• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

save(stats, callback)

Сохраняет предоставленные статистические данные.

Параметры:

• Object stats: статистические данные для сохранения.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

iterateDays(data, callback)

Перебирает дни, вызывая функцию обратного вызова на каждый день.

Параметры:

• Object data: объект, содержащий следующие поля:
  • start (Moment): объект даты Moment, представляющий дату начала (по умолчанию: год назад).
  • end (Moment): объект даты Moment, представляющий конечную дату (по умолчанию: сейчас).
  • format (String): формат даты (по умолчанию: «MMM D, YYYY»).
• Function callback: вызываемая функция обратного вызова с текущим днём, отформатированным (тип: строка), и объектом даты Moment.

Возвращает:

• GitStats экземпляр GitStats.

graph(data, callback)

Создаёт объект со статистикой за предоставленный период (по умолчанию: последний год).

Параметры:

• Object data: объект, переданный методу iterateDays.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

calendar(data, callback)

Создает данные календаря за предоставленный период (по умолчанию: прошлый год).

Параметры:

• Object data: объект, переданный методу graph.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

ansiCalendar(options, callback)

Создаёт календарь вкладов ANSI.

Параметры:

• Object options: объект, переданный методу calendar.
• Function callback: функция обратного вызова.

Возвращает:

• GitStats экземпляр GitStats.

authors(options, callback)

Создаёт массив авторов репозитория git.

Параметры:

• String|Object options: путь репо или объект, содержащий следующие поля:
• repo (String): путь репо.