Litros
Library Tracker for OneScript

Назначение

Litros - трэкер библиотек OneScript на GitHub:

• Показывает информацию об использовании библиотеки (пакета) в других проектах OneScript на GitHub
• Генерирует бэйджик о количестве использований для вставки в markdown файлы

Сайт

litrosbadges.ru

Установка

opm install litros

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

Для работы библиотеки litros требуется сгенерировать персональный токен доступа GitHub (Personal Access Token) с областью прав public_repo (только чтение публичных репозиториев).

Библиотека

OneScript

#Использовать litros

Сканер = Новый СканерИспользованийПакета("ТокенГитхаб");
РезультатПоиска = Сканер.НайтиРепозитории("ИмяПакета"); // Имя пакета, которое определено через инструкцию #Использовать

OneScript + Autumn

Передайте GitHub токен одним из двух способов:

• через переменную окружения litros.ТокенGitHub=ВАШ-ТОКЕН
• или в файл autumn-properties.json (создайте его в корне проекта, если отсутствует) в секцию litros:

{
    "litros": {
        "ТокенGitHub": "ВАШ-ТОКЕН"
    }
}

Пример использования в коде

#Использовать litros

&Пластилин 
Перем СканерИспользованийПакета;

&Желудь
Процедура ПриСозданииОбъекта()

КонецПроцедуры

Процедура ПолезнаяНагрузка() Экспорт
    РезультатПоиска = СканерИспользованийПакета.НайтиРепозитории("ИмяПакета"); // Имя пакета, которое определено через инструкцию #Использовать
КонецПроцедуры

Публичный интерфейс

Класс СканерИспользованийПакета

НайтиРепозитории

// Выполняет поиск репозиториев GitHub, в исходном коде которых
// обнаружено подключение указанного пакета OneScript.
//
// Параметры:
//   ИмяПакета - Строка - Имя анализируемого пакета
//
// Возвращаемое значение:
//   Структура - Результат выполнения поиска со следующими полями:
//     * Данные - Массив из Структура - Список уникальных репозиториев, в которых найдено использование пакета:
//       ** Идентификатор - Строка - Глобальный идентификатор GitHub
//       ** URL           - Строка - URL репозитория
//       ** ПолноеИмя     - Строка - Полное имя репозитория (owner/name)
//       ** Владелец      - Строка - Логин владельца
//       ** ЭтоФорк       - Булево - Признак форка
//     * Успех     - Булево - Признак отсутствия ошибок при выполнении запроса к GitHub API.
//     * Завершено - Булево - Признак полного завершения поиска.
//                            Ложь означает, что поиск временно приостановлен и будет продолжен
//                            при следующем вызове метода.
//     * Сообщение - Строка - Диагностическое сообщение.
Функция НайтиРепозитории(ИмяПакета) Экспорт

web приложение

1. Подготовка каталога

Создайте отдельную папку для web-приложения

2. Настройка конфигурации

Внутри созданной папки создайте файл настроек autumn-properties.json:

{
    "litros": {
        "ТокенGitHub": "ВАШ-ТОКЕН",
        "ИнтервалОбработкиОчереди": 60,
        "ИнтервалПроверкиАктуальности": 300,
        "СрокАктуальностиПакета": 86400,
        "СрокАктуальностиРепозитория": 604800
    }
}

Токен GitHub можно передать и через переменную окружения: litros.ТокенGitHub=ВАШ-ТОКЕН.

3. Запуск приложения

Перейдите в каталог приложения и выполните команду:

litros run -p 3333

Параметры запуска:

• -p или --port - порт, на котором будет запущено приложение

4. Доступ к приложению

После запуска web приложение будет доступно по адресу: http://127.0.0.1:3333