ufolint

Ufolint - это исходный файл Linter для разработки шрифтов в исходном коде Unified Font Object (UFO). Он был разработан для непрерывного интеграционного тестирования вклада источника НЛО в проекты шрифтов.

Приложение выполняет специфический статический анализ исходных текстовых файлов в соответствии с спецификациями НЛО V2 и V3 для проблем, которые включают:

• Поддерживается версия НЛО
• Обязательные файлы и каталоги
• Обязательные соглашения об именовании файла
• Источник определял путь к файлу и последовательность пути каталога в исходных файлах
• Действительный формат файла XML
• *.plist File Property Проверки значения значения
• *.plist File Свойства списка
• fontinfo.plist
• fontinfo.plist
• *.glif File Format Тестирование версии
• *.glif Файл.
• Изображения следуют по спецификации UFO V3+ PNG
• Источники исходных файлов импортируют в библиотеку UFOLIB с публичными методами UFOLIB

Эти тесты выполняются посредством комбинации публичных методов в библиотеке Fonttools.ufolib и дополнительных тестах, которые реализованы в приложении Ufolint. Ufolint вызывает исключения, поднятые в методах публичного чтения Ufolib для всех типов файлов _. Они возвращаются пользователям с информативными сообщениями об ошибках, которые указывают на озабоченность FilePath (ы) и код состояния выхода 1.

Установите и обновите

Ufolint может работать локально или с удаленными услугами тестирования CI.

Локальная установка и обновление

Используйте команду:

 $ pip install ufolint

Обновите на новую версию приложения с помощью команды:

 $ pip install --upgrade ufolint

Местное использование

Процесс полностью автоматизирован. Просто укажите на один или несколько источников НЛО, и это заботится об остальных. Ufolint выходит с кодом состояния 0, если все тесты проходят и выходят с кодом состояния 1, если какие -либо тесты не сняты.

 $ ufolint [UFO source path] ([UFO path 2] [UFO path3]...)

Пример

 $ ufolint Awesome-Regular.ufo Awesome-Bold.ufo

Для критических сбоев, которые предотвращают завершение дальнейшего тестирования, Ufolint выходит немедленно, а другие тесты прерваны. При всех других обстоятельствах сбои собираются по всему анализу и отображаются при завершении всех тестов.

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

Настройка Трэвиса CI

Чтобы непрерывно проверить изменения вашего источника НЛО на Трэвисе, с каждым коммитом, выдвинутым или запросом, представленным в ваш репозиторий GitHub, используйте эти первые два шага от руководства по началу работы Трэвиса:

• Шаг 1 : Войдите в Трэвис с учетной записью GitHub
• Шаг 2 : перейдите на страницу профиля Travis и включите Travis для репозитория шрифта, где вы хотели бы включить тестирование Ufelint

Затем в вашем репозитории GitHub,

• Шаг 3 : Добавьте файл на пути .travis.yml в корне репозитория GitHub, который включает в себя следующий текст:

.travis.yml

 sudo : false
language : python

env :
  - VARIANT=src/Test-Regular.ufo
  - VARIANT=src/Test-Bold.ufo
  - VARIANT=src/Test-Italic.ufo
  - VARIANT=src/Test-BoldItalic.ufo

before_script : pip install ufolint

script : " ufolint $VARIANT "

notifications :
  email : false

• Шаг 4 : Замените VARIANT=src/Test-*.ufo в файле .travis.yml на фактические пути к исходным файлам НЛО после символа = . Используйте одну линию на вариант и добавьте или вычитайте линии по мере необходимости, чтобы проверить желаемый источник НЛО каталоги в репозитории. Это должны быть относительные пути от корня вашего репозитория GIT.

Эта структура настройки Travis выполняет параллельные тесты для каждого из вариантов, указанных в поле env в файле настроек Travis. Каждый вариант будет помечен на странице тестирования Travis, как это:

• Шаг 5 : С каждым новым коммитом, выдвинутым в ваш репозиторий GitHub (или любой новый запрос на вытягивание, представленные другими). Вы можете просмотреть результаты теста на странице учетной записи Travis для репозитория.

• Необязательно : чтобы добавить значок результата тестирования Travis на страницу Repository Readme, вставьте следующую отметку в страницу Readme и измените [ACCOUNT] и [REPOSITORY] с помощью вашей учетной записи Travis и сведений о хранилище:

 [![Build Status](https://travis-ci.org/[ACCOUNT]/[REPOSITORY].svg?branch=master)](https://travis-ci.org/[ACCOUNT]/[REPOSITORY])

Благодарности

Построенный из фантастической библиотеки Ufolib Fonttools, где была выполнена большинство работ по проверке НЛО!

Лицензия

MIT Лицензия