ufolint

UfoLint adalah linter file sumber untuk pengembangan jenis huruf di kode sumber Unified Font Object (UFO). Ini dirancang untuk pengujian integrasi berkelanjutan dari kontribusi sumber UFO untuk proyek typeface.

Aplikasi ini melakukan analisis statis spesifik versi UFO dari file teks sumber terhadap spesifikasi UFO V2 dan V3 untuk masalah yang meliputi:

• Versi UFO yang didukung
• file dan direktori wajib
• konvensi penamaan jalur file wajib
• Path File yang Ditentukan Sumber dan konsistensi jalur direktori di seluruh file sumber
• Format file XML yang valid
• *.Plist File Properti Nilai Daftar Properti Cek
• *.Plist File File Properti Nilai Jenis Nilai Pemeriksaan
• fontinfo.plist opentype properti penamaan konvensi
• fontinfo.plist OpenType Validasi Data Properti
• *.Glif Format File Testing
• *. Garis besar file, atribut, jangkar, pedoman, gambar, catatan validasi
• Gambar Ikuti spesifikasi UFO V3+ PNG
• file sumber impor ke perpustakaan ufolib dengan metode publik ufolib

Tes ini dilakukan melalui kombinasi metode publik di perpustakaan fonttools.ufolib dan tes tambahan yang diimplementasikan dalam aplikasi Ufolint. Ufolint menangkap pengecualian yang diangkat dalam metode baca publik UfoLib untuk semua jenis file _.plist dan semua validasi ufolib yang dilakukan pada file _.glif. Ini dikembalikan ke pengguna dengan pesan kesalahan informatif yang menunjukkan filePath (s) kepedulian dan keluar kode status 1.

Instal dan Tingkatkan

Ufolint dapat dijalankan secara lokal atau dengan layanan pengujian CI jarak jauh.

Instal dan Tingkatkan Lokal

Gunakan perintah:

 $ pip install ufolint

Tingkatkan ke versi baru aplikasi dengan perintah:

 $ pip install --upgrade ufolint

Penggunaan lokal

Prosesnya sepenuhnya otomatis. Cukup arahkan ufolint ke satu atau lebih direktori sumber UFO dan menangani sisanya. Ufolint keluar dengan kode status 0 jika semua tes lulus dan keluar dengan kode status 1 jika ada tes yang gagal.

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

Contoh

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

Untuk kegagalan kritis yang mencegah penyelesaian pengujian lebih lanjut, Ufolint keluar segera dan tes lainnya dibatalkan. Dalam semua keadaan lain, kegagalan dikumpulkan di seluruh analisis dan ditampilkan pada penyelesaian semua tes.

Ufolint menyediakan pesan kesalahan yang berguna dan bermanfaat yang menyertakan file yang menjadi perhatian, jenis kesalahan, dan dalam banyak kasus, baris bermasalah dalam file.

Pengaturan Travis CI

Untuk terus menguji perubahan sumber UFO Anda pada Travis dengan setiap komit yang didorong atau permintaan tarik yang dikirimkan ke repositori github Anda, gunakan dua langkah awal ini dari panduan memulai Travis:

• Langkah 1 : Masuk ke Travis dengan akun GitHub Anda
• Langkah 2 : Buka halaman Profil Travis Anda dan aktifkan Travis untuk repositori jenis huruf di mana Anda ingin mengaktifkan pengujian Ufolint

Kemudian di repositori github Anda,

• Langkah 3 : Tambahkan file di path .travis.yml di akar repositori github Anda yang mencakup teks berikut:

.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

• Langkah 4 : Ganti VARIANT=src/Test-*.ufo di file .travis.yml dengan jalur aktual ke file sumber UFO Anda setelah karakter = . Gunakan satu baris per varian dan tambahkan atau kurangi garis yang diperlukan untuk menguji direktori UFO sumber yang diinginkan di repositori. Ini harus menjadi jalur relatif dari akar repositori git Anda.

Struktur pengaturan Travis ini melakukan tes varian secara paralel untuk masing -masing varian yang ditentukan di bawah bidang env dari file pengaturan Travis. Setiap varian akan diberi label pada halaman pengujian Travis seperti ini:

• Langkah 5 : Dengan setiap komit baru yang didorong ke repositori GitHub Anda (atau permintaan tarik baru yang diajukan oleh orang lain) Travis secara otomatis diberitahu dan melakukan tes UfoLint pada sumber yang dimodifikasi (atau yang diusulkan untuk permintaan tarik) sumber UFO. Anda dapat melihat hasil tes di halaman akun Travis Anda untuk repositori.

• Opsional : Untuk menambahkan lencana hasil tes Travis ke halaman ReadMe Repositori Anda, masukkan markdown berikut di halaman ReadMe Anda dan ubah [ACCOUNT] dan [REPOSITORY] dengan akun Travis dan detail repositori Anda:

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

Ucapan Terima Kasih

Dibangun dengan Perpustakaan Ufolib Fonttools yang fantastis di mana mayoritas pekerjaan validasi UFO telah dilakukan!

Lisensi

Lisensi MIT