Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

CLI: Limit line length of check output to improve readability

See original GitHub issue

Observed behaviour

When using the command line interface the output message has no line length limit. Note the following example:

>> com.google.fonts/check/028
   Check font has a license.
 * FAIL: No license file was found. Please add an OFL.txt or a LICENSE.txt file. If you are running fontbakery on a Google Fonts upstream repo, which
is fine, just make sure there is a temporary license file in the same folder. [code: none]

   Result: FAIL

>> com.google.fonts/check/001 with (('font[0]', 'Isotherma-Alpha.otf'),)
   Checking file is named canonically.
 * FAIL: Style name used in "Isotherma-Alpha.otf" is not canonical. You should rebuild the font using any of the following style names: "Thin", "Extra
Light", "Light", "Regular", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "Thin Italic", "ExtraLight Italic", "Light Italic", "Italic", "Medium
Italic", "SemiBold Italic", "Bold Italic", "ExtraBold Italic", "Black Italic".

   Result: FAIL

>> com.google.fonts/check/018 with (('font[0]', 'Isotherma-Alpha.otf'),)
   Checking OS/2 achVendID.
 * WARN: OS/2 VendorID value 'pyrs' is not a known registered id. You should set it to your own 4 character code, and register that code with Microsof
t at https://www.microsoft.com/typography/links/vendorlist.aspx [code: unknown]

   Result: WARN

Expected behaviour

If the output was limited to a line length of 79 characters, readability might be improved. See the following reformatted example:

>> com.google.fonts/check/028
   Check font has a license.
 * FAIL: No license file was found. Please add an OFL.txt or a LICENSE.txt
file. If you are running fontbakery on a Google Fonts upstream repo, which
is fine, just make sure there is a temporary license file in the same folder. 
[code: none]

   Result: FAIL

>> com.google.fonts/check/001 with (('font[0]', 'Isotherma-Alpha.otf'),)
   Checking file is named canonically.
 * FAIL: Style name used in "Isotherma-Alpha.otf" is not canonical. You should
 rebuild the font using any of the following style names: "Thin", "Extra
Light", "Light", "Regular", "Medium", "SemiBold", "Bold", "ExtraBold", "Black",
"Thin Italic", "ExtraLight Italic", "Light Italic", "Italic", "Medium
Italic", "SemiBold Italic", "Bold Italic", "ExtraBold Italic", "Black Italic".

   Result: FAIL

>> com.google.fonts/check/018 with (('font[0]', 'Isotherma-Alpha.otf'),)
   Checking OS/2 achVendID.
 * WARN: OS/2 VendorID value 'pyrs' is not a known registered id. You should
set it to your own 4 character code, and register that code with Microsof
t at https://www.microsoft.com/typography/links/vendorlist.aspx 
[code: unknown]

   Result: WARN

Issue Analytics

State:
Created 5 years ago
Comments:9 (7 by maintainers)

Top GitHub Comments

1reaction

felipesanchescommented, Sep 12, 2018

I disagree with moving the info into a website because that would make the tool less useful for users temporarily offline or having network issues. I suspect it could also potentially lead to unnecessary issues related to synchronization of the data with the program version. I still prefer to keep the tool self-contained.

0reactions

felipesanchescommented, Mar 10, 2021

A friend of mine, Aurélio Heckert (@aurium), will help us here. He’s got an implementation of the text wrapping for the log messages and will soon submit a pull request ;-D

Top Results From Across the Web

Rethink the 80 characters line limit · Issue #833 - GitHub

The soft limit on line length MUST be 120 characters. Lines SHOULD NOT be longer than 80 characters; lines longer than that SHOULD...

Ask Hackaday: Are 80 Characters Per Line Still Reasonable In ...

A common compromise is to encourage 80 characters, but allow up to 100 or 120 characters, and draw the hard limit there. This...

Is there a valid reason for enforcing a maximum width of 80 ...

No it is not. If you write a longer than 80 chars line, you probably already have a problem in expression complexity or...

Setting the AWS CLI output format - AWS Documentation

This topic describes the different output formats for the AWS Command Line Interface (AWS CLI). The AWS CLI supports the following output formats:....

The Black code style - Black 22.12.0 documentation

Line length In general, 90-ish seems like the wise choice. If you're paid by the line of code you write, you can...