fonttools / fontbakery

šŸ§ A font quality assurance tool for everyone
https://fontbakery.readthedocs.io
Apache License 2.0
553 stars 102 forks source link

Command-line interface: rationales need consistent formatting #2681

Closed eliheuer closed 5 years ago

eliheuer commented 5 years ago

Observed behaviour

While using the command-line interface the rationales appear to be formatted in an inconsistent and arbitrary way. See the screenshot below for an example.

cli-fb-test

Expected behaviour

The rationales should all align with the preceding purple doc string and be prefaced with an indicator explaining what the text is. For example:

>> com.google.fonts/check/epar with (('font[0]', 'Lemonada[wght].ttf'),)
   EPAR table present in font?

   Check Rationale: The EPAR table is/was a way of expressing common 
   licensing permissions and restrictions in metadata; while almost nothing 
   supported it, Dave Crossland wonders that adding it to everything in
   Google Fonts could help make it more popular.

   More info is available at:
   https://davelab6.github.io/epar/

Ideally the Check Rationale: preface would be in a color that sets it apart from the rest of the rationale text, like the green used for PASS.

pass

Finally, the line length of the rationale text should be consistent, note that it isn't in the above screenshot. I suggest keeping all the rationale text as close to 80 character wide as possible.

Resources and exact process needed to replicate

Use Fontbakery from the b138b9e6 commit onward.

felipesanches commented 5 years ago

I spent several hours reviewing and improving the rationale texts of the entire collection of checks.

I cleaned them up, fixed typos, converted a few docstrings into rationale entries, tweaked the syntax and wrote a pice of code that does the 80 column formating for us. We now store the paragraphs as long lines instead of breaking them into smaller lines manually. This will make editing the text easier and will allow the actual text-box width to be chosen per-reporter (such as ghmarkdown, text terminal, readthedocs, etc)

All the work is at https://github.com/felipesanches/fontbakery/commit/8e02c0aebdf37abee0f3b44407beb947306511b6 but I' ll probably still implement similar post-processing of the rationale entries on the other reporters as well. And at some point we will have to hook up a proper markdown parser/renderer to provide richer formating for each of these.

Here' s an example of the resulting output after the big commit ## Fontbakery report Fontbakery version: 0.7.15.dev3+gec569215
[29] Family checks
šŸ”„ FAIL: Do we have the latest version of FontBakery installed? * [com.google.fonts/check/fontbakery_version](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/fontbakery_version) * šŸ”„ **FAIL** Unable to detect what's the latest version of FontBakery available. Maybe we're offline? Please check Internet access and try again. * šŸž **PASS** Font Bakery is up-to-date
šŸž PASS: All tabular figures must have the same width across the RIBBI-family. * [com.google.fonts/check/family/tnum_horizontal_metrics](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/family/tnum_horizontal_metrics)
--- Rationale ---
Tabular figures need to have the same metrics in all styles in order to allow
tables to be set with proper typographic control, but to maintain the placement
of decimals and numeric columns between rows.

Here's a good explanation of this:
https://www.typography.com/techniques/fonts-for-financials/#tabular-figs
* šŸž **PASS** OK
šŸž PASS: Checking all files are in the same directory. * [com.google.fonts/check/family/single_directory](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/family/single_directory)
--- Rationale ---
If the set of font files passed in the command line is not all in the same
directory, then we warn the user since the tool will interpret the set of files
as belonging to a single family (and it is unlikely that the user would store
the files from a single family spreaded in several separate directories).
* šŸž **PASS** All files are in the same directory.
šŸž PASS: Each font in a family must have the same vertical metrics values. * [com.google.fonts/check/family/vertical_metrics](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/family/vertical_metrics)
--- Rationale ---
We want all fonts within a family to have the same vertical metrics so their
line spacing is consistent across the family.
* šŸž **PASS** Vertical metrics are the same across the family
šŸž PASS: Fonts have equal unicode encodings? * [com.google.fonts/check/family/equal_unicode_encodings](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/cmap.html#com.google.fonts/check/family/equal_unicode_encodings) * šŸž **PASS** Fonts have equal unicode encodings.
šŸž PASS: Make sure all font files have the same version value. * [com.google.fonts/check/family/equal_font_versions](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/head.html#com.google.fonts/check/family/equal_font_versions) * šŸž **PASS** All font files have the same version.
šŸž PASS: Fonts have consistent PANOSE proportion? * [com.google.fonts/check/family/panose_proportion](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.google.fonts/check/family/panose_proportion) * šŸž **PASS** Fonts have consistent PANOSE proportion.
šŸž PASS: Fonts have consistent PANOSE family type? * [com.google.fonts/check/family/panose_familytype](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.google.fonts/check/family/panose_familytype) * šŸž **PASS** Fonts have consistent PANOSE family type.
šŸž PASS: Check that OS/2.fsSelection bold & italic settings are unique for each NameID1 * [com.adobe.fonts/check/family/bold_italic_unique_for_nameid1](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.adobe.fonts/check/family/bold_italic_unique_for_nameid1)
--- Rationale ---
Per the OpenType spec: name ID 1 'is used in combination with Font Subfamily
name (name ID 2), and should be shared among at most four fonts that differ
only in weight or style...

This four-way distinction should also be reflected in the OS/2.fsSelection
field, using bits 0 and 5.
* šŸž **PASS** The OS/2.fsSelection bold & italic settings were unique within each compatible family group.
šŸž PASS: Fonts have consistent underline thickness? * [com.google.fonts/check/family/underline_thickness](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/post.html#com.google.fonts/check/family/underline_thickness)
--- Rationale ---
Dave C Lemon (Adobe Type Team) recommends setting the underline thickness to be
consistent across the family.

If thicknesses are not family consistent, words set on the same line which have
different styles look strange.

See also:
https://twitter.com/typenerd1/status/690361887926697986
* šŸž **PASS** Fonts have consistent underline thickness.
šŸž PASS: Verify that each group of fonts with the same nameID 1 has maximum of 4 fonts * [com.adobe.fonts/check/family/max_4_fonts_per_family_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.adobe.fonts/check/family/max_4_fonts_per_family_name)
--- Rationale ---
Per the OpenType spec:
'The Font Family name ... should be shared among at most four fonts that differ
only in weight or style ...'
* šŸž **PASS** There were no more than 4 fonts per family name.
šŸ’¤ SKIP: Check METADATA.pb parse correctly. * [com.google.fonts/check/metadata/parses](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/parses)
--- Rationale ---
The purpose of this check is to ensure that the METADATA.pb file is not
malformed.
* šŸ’¤ **SKIP** Font family at '/usr/share/fonts/opentype/cantarell' lacks a METADATA.pb file.
šŸ’¤ SKIP: Font designer field in METADATA.pb must not be 'unknown'. * [com.google.fonts/check/metadata/unknown_designer](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/unknown_designer) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Multiple values in font designer field in METADATA.pb must be separated by commas. * [com.google.fonts/check/metadata/designer_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/designer_values)
--- Rationale ---
We must use commas instead of forward slashes because the server-side code at
the fonts.google.com directory will segment the string on the commas into a
list of names and display the first item in the list as the "principal
designer" while the remaining names are identified as "contributors".

See eg https://fonts.google.com/specimen/Rubik
* šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Does METADATA.pb copyright field contain broken links? * [com.google.fonts/check/metadata/broken_links](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/broken_links) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Ensure METADATA.pb lists all font binaries. * [com.google.fonts/check/metadata/undeclared_fonts](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/undeclared_fonts)
--- Rationale ---
The set of font binaries available must match exactly those declared on the
METADATA.pb file.

Also, to avoid confusion, we expect that font files are not placed on
subdirectories.
* šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Check font has a license. * [com.google.fonts/check/family/has_license](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/family/has_license) * šŸ’¤ **SKIP** Unfulfilled Conditions: gfonts_repo_structure
šŸ’¤ SKIP: METADATA.pb: check if fonts field only has unique "full_name" values. * [com.google.fonts/check/metadata/unique_full_name_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/unique_full_name_values) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb: check if fonts field only contains unique style:weight pairs. * [com.google.fonts/check/metadata/unique_weight_style_pairs](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/unique_weight_style_pairs) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb license is "APACHE2", "UFL" or "OFL"? * [com.google.fonts/check/metadata/license](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/license) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb should contain at least "menu" and "latin" subsets. * [com.google.fonts/check/metadata/menu_and_latin](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/menu_and_latin) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb subsets should be alphabetically ordered. * [com.google.fonts/check/metadata/subsets_order](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/subsets_order) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb: Copyright notice is the same in all fonts? * [com.google.fonts/check/metadata/copyright](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/copyright) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Check that METADATA.pb family values are all the same. * [com.google.fonts/check/metadata/familyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/familyname) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb: According Google Fonts standards, families should have a Regular style. * [com.google.fonts/check/metadata/has_regular](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/has_regular) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb: Regular should be 400. * [com.google.fonts/check/metadata/regular_is_400](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/regular_is_400) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata, has_regular_style
šŸ’¤ SKIP: METADATA.pb: Font filenames match font.filename entries? * [com.google.fonts/check/metadata/filenames](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/filenames) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Does font file include unacceptable control character glyphs? * [com.google.fonts/check/family/control_chars](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/family/control_chars)
--- Rationale ---
Use of some unacceptable control characters in the U+0000 - U+001F range can
lead to rendering issues on some platforms.

Acceptable control characters are defined as .null (U+0000) and CR (U+000D) for
this test.
* šŸ’¤ **SKIP** Unfulfilled Conditions: are_ttf
āš  WARN: Is the command `ftxvalidator` (Apple Font Tool Suite) available? * [com.google.fonts/check/ftxvalidator_is_available](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/ftxvalidator_is_available)
--- Rationale ---
There's no reasonable (and legal) way to run the command `ftxvalidator` of the
Apple Font Tool Suite on a non-macOS machine. I.e. on GNU+Linux or Windows etc.

If Font Bakery is not running on an OSX machine, the machine running Font
Bakery could access `ftxvalidator` on OSX, e.g. via ssh or a remote procedure
call (rpc).

There's an ssh example implementation at:
https://github.com/googlefonts/fontbakery/blob/master/prebuilt/workarounds/ftxvalidator/ssh-implementation/ftxvalidator
* āš  **WARN** ftxvalidator is not available.

[131] Cantarell-Regular.otf
šŸ’” ERROR: Version number has increased since previous release on Google Fonts? * [com.google.fonts/check/version_bump](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/version_bump) * šŸ’” **ERROR** The condition had an error: FailedConditionError: The condition had an error: ConnectionError: HTTPConnectionPool(host='fonts.googleapis.com', port=80): Max retries exceeded with url: /css?family=Cantarell (Caused by NewConnectionError(': Failed to establish a new connection: [Errno -2] Name or service not known'))
šŸ’” ERROR: Glyphs are similiar to Google Fonts version? * [com.google.fonts/check/production_glyphs_similarity](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/production_glyphs_similarity) * šŸ’” **ERROR** The condition had an error: FailedConditionError: The condition had an error: ConnectionError: HTTPConnectionPool(host='fonts.googleapis.com', port=80): Max retries exceeded with url: /css?family=Cantarell (Caused by NewConnectionError(': Failed to establish a new connection: [Errno -2] Name or service not known'))
šŸ’” ERROR: Familyname must be unique according to namecheck.fontdata.com * [com.google.fonts/check/fontdata_namecheck](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/fontdata_namecheck)
--- Rationale ---
We need to check names are not already used, and today the best place to check
that is http://namecheck.fontdata.com
* šŸ’” **ERROR** Failed to access: http://namecheck.fontdata.com. Please report this issue at: https://github.com/googlefonts/fontbakery/issues [code: namecheck-service]
šŸ’” ERROR: Check if the vertical metrics of a family are similar to the same family hosted on Google Fonts. * [com.google.fonts/check/vertical_metrics_regressions](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/vertical_metrics_regressions)
--- Rationale ---
If the family already exists on Google Fonts, we need to ensure that the
checked family's vertical metrics are similar. This check will test the
following schema which was outlined in Fontbakery issue #1162 [1]:

- The family should visually have the same vertical metrics as the
  Regular style hosted on Google Fonts.
- If the family on Google Fonts has differing hhea and typo metrics,
  the family being checked should use the typo metrics for both the
  hhea and typo entries.
- If the family on Google Fonts has use typo metrics not enabled and the
  family being checked has it enabled, the hhea and typo metrics
  should use the family on Google Fonts winAscent and winDescent values.
- If the upms differ, the values must be scaled so the visual appearance
  is the same.

[1] https://github.com/googlefonts/fontbakery/issues/1162
* šŸ’” **ERROR** The condition had an error: ConnectionError: HTTPConnectionPool(host='fonts.googleapis.com', port=80): Max retries exceeded with url: /css?family=Cantarell (Caused by NewConnectionError(': Failed to establish a new connection: [Errno -2] Name or service not known'))
šŸ”„ FAIL: Checking OS/2 fsType does not impose restrictions. * [com.google.fonts/check/fstype](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/fstype)
--- Rationale ---
The fsType in the OS/2 table is a legacy DRM-related field. Fonts in the Google
Fonts collection must have it set to zero (also known as "Installable
Embedding"). This setting indicates that the fonts can be embedded in documents
and permanently installed by applications on remote systems.

More detailed info is available at:
https://docs.microsoft.com/en-us/typography/opentype/spec/os2#fstype
* šŸ”„ **FAIL** In this font fsType is set to 8 meaning that: The font may be embedded but must only be installed temporarily on other systems. No such DRM restrictions can be enabled on the Google Fonts collection, so the fsType field must be set to zero (Installable Embedding) instead. [code: drm]
šŸ”„ FAIL: Check `Google Fonts Latin Core` glyph coverage. * [com.google.fonts/check/glyph_coverage](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/glyph_coverage)
--- Rationale ---
Google Fonts expects that fonts in its collection support at least the minimal
set of characters defined in the `GF-latin-core` glyph-set.
* šŸ”„ **FAIL** Missing required codepoints: 0x000D (CARRIAGE RETURN) [code: missing-codepoints]
šŸ”„ FAIL: License URL matches License text on name table? * [com.google.fonts/check/name/license_url](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/license_url) * šŸ”„ **FAIL** A known license URL must be provided in the NameID 14 (LICENSE INFO URL) entry. Currently accepted licenses are Apache: 'http://www.apache.org/licenses/LICENSE-2.0' or Open Font License: 'http://scripts.sil.org/OFL' For a small set of legacy families the Ubuntu Font License 'https://www.ubuntu.com/legal/terms-and-policies/font-licence' may be acceptable as well. When in doubt, please choose OFL for new font projects. [code: no-license-found]
šŸ”„ FAIL: Version format is correct in 'name' table? * [com.google.fonts/check/name/version_format](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/version_format) * šŸ”„ **FAIL** The NameID.VERSION_STRING (nameID=5) value must follow the pattern "Version X.Y" with X.Y greater than or equal to 1.000. Current version string is: "Version 0.111" [code: bad-version-strings]
šŸ”„ FAIL: Copyright notices match canonical pattern in fonts * [com.google.fonts/check/font_copyright](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/font_copyright) * šŸ”„ **FAIL** Name Table entry: Copyright notices should match a pattern similar to: "Copyright 2019 The Familyname Project Authors (git url)" But instead we have got: "Copyright (c) 2009--2017 The Cantarell Authors" [code: bad-notice-format]
šŸ”„ FAIL: Checking OS/2 usWinAscent & usWinDescent. * [com.google.fonts/check/family/win_ascent_and_descent](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/family/win_ascent_and_descent)
--- Rationale ---
A font's winAscent and winDescent values should be greater than the head
table's yMax, abs(yMin) values. If they are less than these values, clipping
can occur on Windows platforms
(https://github.com/RedHatBrand/Overpass/issues/33).

If the font includes tall/deep writing systems such as Arabic or Devanagari,
the winAscent and winDescent can be greater than the yMax and abs(yMin) to
accommodate vowel marks.

When the win Metrics are significantly greater than the upm, the linespacing
can appear too loose. To counteract this, enabling the OS/2 fsSelection bit 7
(Use_Typo_Metrics), will force Windows to use the OS/2 typo values instead.
This means the font developer can control the linespacing with the typo values,
whilst avoiding clipping by setting the win values to values greater than the
yMax and abs(yMin).
* šŸ”„ **FAIL** OS/2.usWinAscent value should be equal or greater than 1101, but got 983 instead [code: ascent] * šŸ”„ **FAIL** OS/2.usWinDescent value should be equal or greater than 256, but got 217 instead [code: descent]
šŸ”„ FAIL: Checking OS/2 Metrics match hhea Metrics. * [com.google.fonts/check/os2_metrics_match_hhea](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/os2_metrics_match_hhea)
--- Rationale ---
When OS/2 and hhea vertical metrics match, the same linespacing results on
macOS, GNU+Linux and Windows. Unfortunately as of 2018, Google Fonts has
released many fonts with vertical metrics that don't match in this way. When we
fix this issue in these existing families, we will create a visible change in
line/paragraph layout for either Windows or macOS users, which will upset some
of them.

But we have a duty to fix broken stuff, and inconsistent paragraph layout is
unacceptably broken when it is possible to avoid it.

If users complain and prefer the old broken version, they have the freedom to
take care of their own situation.
* šŸ”„ **FAIL** OS/2 sTypoAscender (739) and hhea ascent (983) must be equal. [code: ascender]
šŸ”„ FAIL: Glyph names are all valid? * [com.google.fonts/check/valid_glyphnames](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/valid_glyphnames)
--- Rationale ---
Microsoft's recommendations for OpenType Fonts states the following:

'NOTE: The PostScript glyph name must be no longer than 31 characters, include
only uppercase or lowercase English letters, European digits, the period or the
underscore, i.e. from the set [A-Za-z0-9_.] and should start with a letter,
except the special glyph name ".notdef" which starts with a period.'

https://docs.microsoft.com/en-us/typography/opentype/spec/recom#post-table
* šŸ”„ **FAIL** The following glyph names do not comply with naming conventions: brevecomb-cy, descender-cy, brevecomb-cy.case, descender-cy.case, descender-cy.strait, circumflexcomb_hookabovecomb.case, descenderreversed-cy, _bar-cy, _descender-cy.case.straight and descenderreverse-cy.case A glyph name may be up to 31 characters in length, must be entirely comprised of characters from the following set: A-Z a-z 0-9 .(period) _(underscore). and must not start with a digit or period. There are a few exceptions such as the special character ".notdef". The glyph names "twocents", "a1", and "_" are all valid, while "2cents" and ".twocents" are not. [code: found-invalid-names]
šŸ”„ FAIL: Does the font have a DSIG table? * [com.google.fonts/check/dsig](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/dsig.html#com.google.fonts/check/dsig)
--- Rationale ---
Some programs expect fonts to have a digital signature declared in their DSIG
table in order to work properly.

This checks verifies that such signature is available in the font.

Typically, even a fake signature would be enough to make the fonts work. If
needed, such dummy-placeholder can be added to the font by using the `gftools
fix-dsig` script available at https://github.com/googlefonts/gftools
* šŸ”„ **FAIL** This font lacks a digital signature (DSIG table). Some applications may require one (even if only a dummy placeholder) in order to work properly. You can add a DSIG table by running the `gftools fix-dsig` script. [code: lacks-signature]
āš  WARN: Checking OS/2 achVendID. * [com.google.fonts/check/vendor_id](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/vendor_id) * āš  **WARN** OS/2 VendorID value 'ABAT' is not a known registered id. You should set it to your own 4 character code, and register that code with Microsoft at https://www.microsoft.com/typography/links/vendorlist.aspx [code: unknown]
āš  WARN: Stricter unitsPerEm criteria for Google Fonts. * [com.google.fonts/check/unitsperem_strict](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/unitsperem_strict)
--- Rationale ---
Even though the OpenType spec allows unitsPerEm to be any value between 16 and
16384, the Google Fonts project aims at a narrower set of reasonable values.

The spec suggests usage of powers of two in order to get some performance
improvements on legacy renderers, so those values are acceptable.

But value of 500 or 1000 are also acceptable, with the added benefit that it
makes upm math easier for designers, while the performance hit of not using a
power of two is most likely negligible nowadays.

Another acceptable value is 2000. Since TT outlines are all integers (no
floats), then instances in a VF suffer rounding compromises, and therefore a
1000 UPM is to small because it forces too many such compromises.

Therefore 2000 is a good 'new VF standard', because 2000 is a simple 2x
conversion from existing fonts drawn on a 1000 UPM, and anyone who knows what
10 units can do for 1000 UPM will know what 20 units does too.

Additionally, values above 2048 would result in filesize increases with not
much added benefit.
* āš  **WARN** Even though unitsPerEm (1000) in this font is reasonable. It is strongly advised to consider changing it to 2000, since it will likely improve the quality of Variable Fonts by avoiding excessive rounding of coordinates on interpolations. [code: legacy-value]
āš  WARN: Are there caret positions declared for every ligature? * [com.google.fonts/check/ligature_carets](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/ligature_carets)
--- Rationale ---
All ligatures in a font must have corresponding caret (text cursor) positions
defined in the GDEF table, otherwhise, users may experience issues with caret
rendering.
* āš  **WARN** This font lacks caret position values for ligature glyphs on its GDEF table. [code: lacks-caret-pos]
āš  WARN: Checking Vertical Metric Linegaps. * [com.google.fonts/check/linegaps](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/hhea.html#com.google.fonts/check/linegaps) * āš  **WARN** OS/2 sTypoLineGap is not equal to 0. [code: OS/2]
āš  WARN: Does GPOS table have kerning information? * [com.google.fonts/check/gpos_kerning_info](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/gpos.html#com.google.fonts/check/gpos_kerning_info) * āš  **WARN** GPOS table lacks kerning information. [code: lacks-kern-info]
šŸ’¤ SKIP: Does DESCRIPTION file contain broken links? * [com.google.fonts/check/description/broken_links](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/broken_links)
--- Rationale ---
The snippet of HTML in the DESCRIPTION.en_us.html file is added to the font
family webpage on the Google Fonts website. For that reason, all hyperlinks in
it must be properly working.
* šŸ’¤ **SKIP** Unfulfilled Conditions: description
šŸ’¤ SKIP: Does DESCRIPTION file contain a upstream Git repo URL? * [com.google.fonts/check/description/git_url](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/git_url)
--- Rationale ---
The contents of the DESCRIPTION.en-us.html file are displayed on the Google
Fonts website in the about section of each font family specimen page.

Since all of the Google Fonts collection is composed of libre-licensed fonts,
this check enforces a policy that there must be a hypertext link in that page
directing users to the repository where the font project files are made
available.

Such hosting is typically done on sites like Github, Gitlab, GNU Savannah or
any other git-based version control service.
* šŸ’¤ **SKIP** Unfulfilled Conditions: description
šŸ’¤ SKIP: Does DESCRIPTION file mention when a family is available as variable font? * [com.google.fonts/check/description/variable_font](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/variable_font)
--- Rationale ---
Families with variable fonts do not always mention that in their descriptions.
Therefore, this check ensures that a standard boilerplate sentence is present
in the DESCRIPTION.en_us.html files for all those families which are available
as variable fonts.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, description
šŸ’¤ SKIP: Is this a proper HTML snippet? * [com.google.fonts/check/description/valid_html](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/valid_html)
--- Rationale ---
When packaging families for being pushed to the `google/fonts` git repo, if
there is no DESCRIPTION.en_us.html file, some older versions of the
`add_font.py` tool insert a dummy description file which contains invalid html.

This file needs to either be replaced with an existing description file or
edited by hand.
* šŸ’¤ **SKIP** Unfulfilled Conditions: descfile
šŸ’¤ SKIP: DESCRIPTION.en_us.html must have more than 200 bytes. * [com.google.fonts/check/description/min_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/min_length) * šŸ’¤ **SKIP** Unfulfilled Conditions: description
šŸ’¤ SKIP: DESCRIPTION.en_us.html must have less than 1000 bytes. * [com.google.fonts/check/description/max_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/description/max_length) * šŸ’¤ **SKIP** Unfulfilled Conditions: description
šŸ’¤ SKIP: Check copyright namerecords match license file. * [com.google.fonts/check/name/license](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/license) * šŸ’¤ **SKIP** Unfulfilled Conditions: license
šŸ’¤ SKIP: Show hinting filesize impact. * [com.google.fonts/check/hinting_impact](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/hinting_impact)
--- Rationale ---
This check is merely informative, displaying and useful comparison of filesizes
after ttfautohint usage versus unhinted font files.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf, ttfautohint_stats
šŸ’¤ SKIP: Font has ttfautohint params? * [com.google.fonts/check/has_ttfautohint_params](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/has_ttfautohint_params) * šŸ’¤ **SKIP** Font appears to our heuristic as not hinted using ttfautohint. [code: not-hinted]
šŸ’¤ SKIP: Font has old ttfautohint applied? * [com.google.fonts/check/old_ttfautohint](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/old_ttfautohint)
--- Rationale ---
This check finds which version of ttfautohint was used, by inspecting name
table entries and then finds which version of ttfautohint is currently
installed in the system.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Is the Grid-fitting and Scan-conversion Procedure ('gasp') table set to optimize rendering? * [com.google.fonts/check/gasp](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/gasp)
--- Rationale ---
Traditionally version 0 'gasp' tables were set so that font sizes below 8 ppem
had no grid fitting but did have antialiasing. From 9-16 ppem, just grid
fitting. And fonts above 17ppem had both antialiasing and grid fitting toggled
on. The use of accelerated graphics cards and higher resolution screens make
this approach obsolete. Microsoft's DirectWrite pushed this even further with
much improved rendering built into the OS and apps.

In this scenario it makes sense to simply toggle all 4 flags ON for all font
sizes.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: METADATA.pb: Fontfamily is listed on Google Fonts API? * [com.google.fonts/check/metadata/listed_on_gfonts](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/listed_on_gfonts) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: Checks METADATA.pb font.name field matches family name declared on the name table. * [com.google.fonts/check/metadata/nameid/family_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/family_name) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Checks METADATA.pb font.post_script_name matches postscript name declared on the name table. * [com.google.fonts/check/metadata/nameid/post_script_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/post_script_name) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.full_name value matches fullname declared on the name table? * [com.google.fonts/check/metadata/nameid/full_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/full_name) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.name value should be same as the family name declared on the name table. * [com.google.fonts/check/metadata/nameid/font_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/font_name) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.full_name and font.post_script_name fields have equivalent values ? * [com.google.fonts/check/metadata/match_fullname_postscript](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/match_fullname_postscript) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.filename and font.post_script_name fields have equivalent values? * [com.google.fonts/check/metadata/match_filename_postscript](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/match_filename_postscript) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.name field contains font name in right format? * [com.google.fonts/check/metadata/valid_name_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/valid_name_values) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.full_name field contains font name in right format? * [com.google.fonts/check/metadata/valid_full_name_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/valid_full_name_values) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.filename field contains font name in right format? * [com.google.fonts/check/metadata/valid_filename_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/valid_filename_values) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata
šŸ’¤ SKIP: METADATA.pb font.post_script_name field contains font name in right format? * [com.google.fonts/check/metadata/valid_post_script_name_values](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/valid_post_script_name_values) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Copyright notices match canonical pattern in METADATA.pb * [com.google.fonts/check/metadata/valid_copyright](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/valid_copyright) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Copyright notice on METADATA.pb should not contain 'Reserved Font Name'. * [com.google.fonts/check/metadata/reserved_font_name](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/reserved_font_name) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb: Copyright notice shouldn't exceed 500 chars. * [com.google.fonts/check/metadata/copyright_max_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/copyright_max_length) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.style "italic" matches font internals? * [com.google.fonts/check/metadata/italic_style](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/italic_style) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.style "normal" matches font internals? * [com.google.fonts/check/metadata/normal_style](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/normal_style) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb font.name and font.full_name fields match the values declared on the name table? * [com.google.fonts/check/metadata/nameid/family_and_full_names](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/family_and_full_names) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb: Check if fontname is not camel cased. * [com.google.fonts/check/metadata/fontname_not_camel_cased](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/fontname_not_camel_cased) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb: Check font name is the same as family name. * [com.google.fonts/check/metadata/match_name_familyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/match_name_familyname) * šŸ’¤ **SKIP** Unfulfilled Conditions: family_metadata, font_metadata
šŸ’¤ SKIP: METADATA.pb: Check that font weight has a canonical value. * [com.google.fonts/check/metadata/canonical_weight_value](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/canonical_weight_value) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Checking OS/2 usWeightClass matches weight specified at METADATA.pb. * [com.google.fonts/check/metadata/os2_weightclass](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/os2_weightclass) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb weight matches postScriptName. * [com.google.fonts/check/metadata/match_weight_postscript](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/match_weight_postscript) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: METADATA.pb: Font styles are named canonically? * [com.google.fonts/check/metadata/canonical_style_names](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/canonical_style_names) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Check if each glyph has the recommended amount of contours. * [com.google.fonts/check/contour_count](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/contour_count)
--- Rationale ---
Visually QAing thousands of glyphs by hand is tiring. Most glyphs can only be
constructured in a handful of ways. This means a glyph's contour count will
only differ slightly amongst different fonts, e.g a 'g' could either be 2 or 3
contours, depending on whether its double story or single story.

However, a quotedbl should have 2 contours, unless the font belongs to a
display family.

This check currently does not cover variable fonts because there's plenty of
alternative ways of constructing glyphs with multiple outlines for each feature
in a VarFont. The expected contour count data for this check is currently
optimized for the typical construction of glyphs in static fonts.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Copyright field for this font on METADATA.pb matches all copyright notice entries on the name table ? * [com.google.fonts/check/metadata/nameid/copyright](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/metadata/nameid/copyright) * šŸ’¤ **SKIP** Unfulfilled Conditions: font_metadata
šŸ’¤ SKIP: Check a static ttf can be generated from a variable font. * [com.google.fonts/check/varfont/generate_static](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont/generate_static)
--- Rationale ---
Google Fonts may serve static fonts which have been generated from variable
fonts. This test will attempt to generate a static ttf using fontTool's varLib
mutator.

The target font will be the mean of each axis e.g:

**VF font axes**

- min weight, max weight = 400, 800
- min width, max width = 50, 100

**Target Instance**

- weight = 600
- width = 75
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: Check that variable fonts have an HVAR table. * [com.google.fonts/check/varfont/has_HVAR](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont/has_HVAR)
--- Rationale ---
Not having a HVAR table can lead to costly text-layout operations on some
platforms, which we want to avoid.

So, all variable fonts on the Google Fonts collection should have an HVAR with
valid values.

More info on the HVAR table can be found at:
https://docs.microsoft.com/en-us/typography/opentype/spec/otvaroverview#variation-data-tables-and-miscellaneous-requirements
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: Font enables smart dropout control in "prep" table instructions? * [com.google.fonts/check/smart_dropout](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/smart_dropout)
--- Rationale ---
This setup is meant to ensure consistent rendering quality for fonts across all
devices (with different rendering/hinting capabilities).

Below is the snippet of instructions we expect to see in the fonts:
B8 01 FF    PUSHW 0x01FF
85          SCANCTRL (unconditinally turn on
                      dropout control mode)
B0 04       PUSHB 0x04
8D          SCANTYPE (enable smart dropout control)

"Smart dropout control" means activating rules 1, 2 and 5:
Rule 1: If a pixel's center falls within the glyph outline,
        that pixel is turned on.
Rule 2: If a contour falls exactly on a pixel's center,
        that pixel is turned on.
Rule 5: If a scan line between two adjacent pixel centers
        (either vertical or horizontal) is intersected
        by both an on-Transition contour and an off-Transition
        contour and neither of the pixels was already turned on
        by rules 1 and 2, turn on the pixel which is closer to
        the midpoint between the on-Transition contour and
        off-Transition contour. This is "Smart" dropout control.

For more detailed info (such as other rules not enabled in this snippet),
please refer to the TrueType Instruction Set documentation.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: All name entries referenced by fvar instances exist on the name table? * [com.google.fonts/check/fvar_name_entries](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/fvar_name_entries)
--- Rationale ---
The purpose of this check is to make sure that all name entries referenced by
variable font instances do exist in the name table.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: A variable font must have named instances. * [com.google.fonts/check/varfont_has_instances](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont_has_instances)
--- Rationale ---
Named instances must be present in all variable fonts in order not to frustrate
the users' typical expectations of a traditional static font workflow.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: Variable font weight coordinates must be multiples of 100. * [com.google.fonts/check/varfont_weight_instances](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont_weight_instances)
--- Rationale ---
The named instances on the weight axis of a variable font must have coordinates
that are multiples of 100 on the design space.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: PPEM must be an integer on hinted fonts. * [com.google.fonts/check/integer_ppem_if_hinted](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/integer_ppem_if_hinted)
--- Rationale ---
Hinted fonts must have head table flag bit 3 set.

Per https://docs.microsoft.com/en-us/typography/opentype/spec/head, bit 3 of
Head::flags decides whether PPEM should be rounded. This bit should always be
set for hinted fonts.

Note:
Bit 3 = Force ppem to integer values for all internal scaler math;
        May use fractional ppem sizes if this bit is clear;
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_hinted
šŸ’¤ SKIP: Is there kerning info for non-ligated sequences? * [com.google.fonts/check/kerning_for_non_ligated_sequences](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/kerning_for_non_ligated_sequences)
--- Rationale ---
Fonts with ligatures should have kerning on the corresponding non-ligated
sequences for text where ligatures aren't used (eg
https://github.com/impallari/Raleway/issues/14).
* šŸ’¤ **SKIP** Unfulfilled Conditions: has_kerning_info
šŸ’¤ SKIP: Directory name in GFonts repo structure must match NameID 1 of the regular. * [com.google.fonts/check/repo/dirname_matches_nameid_1](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/repo/dirname_matches_nameid_1) * šŸ’¤ **SKIP** Unfulfilled Conditions: gfonts_repo_structure
šŸ’¤ SKIP: Check variable font instances have correct coordinate values * [com.google.fonts/check/varfont_instance_coordinates](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont_instance_coordinates) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: Check variable font instances have correct names * [com.google.fonts/check/varfont_instance_names](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/varfont_instance_names) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: Checking with ftxvalidator. * [com.google.fonts/check/ftxvalidator](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/ftxvalidator) * šŸ’¤ **SKIP** Unfulfilled Conditions: ftxvalidator_is_available
šŸ’¤ SKIP: Font has **proper** whitespace glyph names? * [com.google.fonts/check/whitespace_glyphnames](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/whitespace_glyphnames) * šŸ’¤ **SKIP** Font has version 3 post table.
šŸ’¤ SKIP: Font contains all required tables? * [com.google.fonts/check/required_tables](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/required_tables)
--- Rationale ---
Depending on the typeface and coverage of a font, certain tables are
recommended for optimum quality. For example, the performance of a non-linear
font is improved if the VDMX, LTSH, and hdmx tables are present. Non-monospaced
Latin fonts should have a kern table. A gasp table is necessary if a designer
wants to influence the sizes at which grayscaling is used under Windows. A DSIG
table containing a digital signature helps ensure the integrity of the font
file. Etc.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Is the CFF2 subr/gsubr call depth > 10? * [com.adobe.fonts/check/cff2_call_depth](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/cff.html#com.adobe.fonts/check/cff2_call_depth)
--- Rationale ---
Per "The CFF2 CharString Format", the "Subr nesting, stack limit" is 10.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_cff2
šŸ’¤ SKIP: Check if OS/2 xAvgCharWidth is correct. * [com.google.fonts/check/xavgcharwidth](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.google.fonts/check/xavgcharwidth) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Checking correctness of monospaced metadata. * [com.google.fonts/check/monospace](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/monospace)
--- Rationale ---
There are various metadata in the OpenType spec to specify if a font is
monospaced or not. If the font is not trully monospaced, then no monospaced
metadata should be set (as sometimes they mistakenly are...)

Monospace fonts must:

* post.isFixedWidth "Set to 0 if the font is proportionally spaced, non-zero if
the font is not proportionally spaced (monospaced)"
  www.microsoft.com/typography/otspec/post.htm

* hhea.advanceWidthMax must be correct, meaning no glyph's width value is
greater.
  www.microsoft.com/typography/otspec/hhea.htm

* OS/2.panose.bProportion must be set to 9 (monospace). Spec says: "The PANOSE
definition contains ten digits each of which currently describes up to sixteen
variations. Windows uses bFamilyType, bSerifStyle and bProportion in the font
mapper to determine family type. It also uses bProportion to determine if the
font is monospaced."
  www.microsoft.com/typography/otspec/os2.htm#pan
  monotypecom-test.monotype.de/services/pan2

* OS/2.xAverageWidth must be set accurately.
  "OS/2.xAverageWidth IS used when rendering monospaced fonts, at least by
Windows GDI"
  http://typedrawers.com/discussion/comment/15397/#Comment_15397

Also we should report an error for glyphs not of average width
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Name table ID 6 (PostScript name) must be consistent across platforms. * [com.adobe.fonts/check/name/postscript_name_consistency](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.adobe.fonts/check/name/postscript_name_consistency)
--- Rationale ---
The PostScript name entries in the font's 'name' table should be consistent
across platforms.

This is the TTF/CFF2 equivalent of the CFF 'postscript_name_cff_vs_name' check.
* šŸ’¤ **SKIP** Unfulfilled Conditions: not is_cff
šŸ’¤ SKIP: Does the number of glyphs in the loca table match the maxp table? * [com.google.fonts/check/loca/maxp_num_glyphs](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/loca.html#com.google.fonts/check/loca/maxp_num_glyphs) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Monospace font has hhea.advanceWidthMax equal to each glyph's advanceWidth? * [com.google.fonts/check/monospace_max_advancewidth](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/hhea.html#com.google.fonts/check/monospace_max_advancewidth) * šŸ’¤ **SKIP** Font is not monospaced.
šŸ’¤ SKIP: Is there any unused data at the end of the glyf table? * [com.google.fonts/check/glyf_unused_data](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/glyf.html#com.google.fonts/check/glyf_unused_data) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: Check for points out of bounds. * [com.google.fonts/check/points_out_of_bounds](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/glyf.html#com.google.fonts/check/points_out_of_bounds) * šŸ’¤ **SKIP** Unfulfilled Conditions: is_ttf
šŸ’¤ SKIP: The variable font 'wght' (Weight) axis coordinate must be 400 on the 'Regular' instance. * [com.google.fonts/check/varfont/regular_wght_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/regular_wght_coord)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'wght'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_wght

If a variable font has a 'wght' (Weight) axis, then the coordinate of its
'Regular' instance is required to be 400.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, regular_wght_coord
šŸ’¤ SKIP: The variable font 'wdth' (Width) axis coordinate must be 100 on the 'Regular' instance. * [com.google.fonts/check/varfont/regular_wdth_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/regular_wdth_coord)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'wdth'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_wdth

If a variable font has a 'wdth' (Width) axis, then the coordinate of its
'Regular' instance is required to be 100.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, regular_wdth_coord
šŸ’¤ SKIP: The variable font 'slnt' (Slant) axis coordinate must be zero on the 'Regular' instance. * [com.google.fonts/check/varfont/regular_slnt_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/regular_slnt_coord)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'slnt'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_slnt

If a variable font has a 'slnt' (Slant) axis, then the coordinate of its
'Regular' instance is required to be zero.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, regular_slnt_coord
šŸ’¤ SKIP: The variable font 'ital' (Italic) axis coordinate must be zero on the 'Regular' instance. * [com.google.fonts/check/varfont/regular_ital_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/regular_ital_coord)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'ital'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_ital

If a variable font has a 'ital' (Italic) axis, then the coordinate of its
'Regular' instance is required to be zero.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, regular_ital_coord
šŸ’¤ SKIP: The variable font 'opsz' (Optical Size) axis coordinate should be between 9 and 13 on the 'Regular' instance. * [com.google.fonts/check/varfont/regular_opsz_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/regular_opsz_coord)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'opsz'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_opsz

If a variable font has a 'opsz' (Optical Size) axis, then the coordinate of its
'Regular' instance is recommended to be a value in the range 9 to 13.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, regular_opsz_coord
šŸ’¤ SKIP: The variable font 'wght' (Weight) axis coordinate must be 700 on the 'Bold' instance. * [com.google.fonts/check/varfont/bold_wght_coord](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/bold_wght_coord)
--- Rationale ---
The Open-Type spec's registered design-variation tag 'wght' available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_wght does
not specify a required value for the 'Bold' instance of a variable font.

But Dave Crossland suggested that we should enforce a required value of 700 in
this case.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, bold_wght_coord
šŸ’¤ SKIP: The variable font 'wght' (Weight) axis coordinate must be within spec range of 1 to 1000 on all instances. * [com.google.fonts/check/varfont/wght_valid_range](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/wght_valid_range)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'wght'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_wght

On the 'wght' (Weight) axis, the valid coordinate range is 1-1000.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: The variable font 'wdth' (Weight) axis coordinate must be within spec range of 1 to 1000 on all instances. * [com.google.fonts/check/varfont/wdth_valid_range](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/wdth_valid_range)
--- Rationale ---
According to the Open-Type spec's registered design-variation tag 'wdth'
available at
https://docs.microsoft.com/en-gb/typography/opentype/spec/dvaraxistag_wdth

On the 'wdth' (Width) axis, the valid coordinate range is 1-1000
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font
šŸ’¤ SKIP: The variable font 'slnt' (Slant) axis coordinate specifies positive values in its range? * [com.google.fonts/check/varfont/slnt_range](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/fvar.html#com.google.fonts/check/varfont/slnt_range)
--- Rationale ---
The OpenType spec says at
https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxistag_slnt
that:

[...] the scale for the Slant axis is interpreted as the angle of slant in
counter-clockwise degrees from upright. This means that a typical,
right-leaning oblique design will have a negative slant value. This matches the
scale used for the italicAngle field in the post table.
* šŸ’¤ **SKIP** Unfulfilled Conditions: is_variable_font, slnt_axis
ā„¹ INFO: EPAR table present in font? * [com.google.fonts/check/epar](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/epar)
--- Rationale ---
The EPAR table is/was a way of expressing common licensing permissions and
restrictions in metadata; while almost nothing supported it, Dave Crossland
wonders that adding it to everything in Google Fonts could help make it more
popular.

More info is available at:
https://davelab6.github.io/epar/
* ā„¹ **INFO** EPAR table not present in font. To learn more see https://github.com/googlefonts/fontbakery/issues/818 [code: lacks-EPAR]
ā„¹ INFO: Check for font-v versioning. * [com.google.fonts/check/fontv](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/fontv)
--- Rationale ---
The git sha1 tagging and dev/release features of Source Foundry `font-v` tool
are awesome and we would love to consider upstreaming the approach into
fontmake someday. For now we only emit a WARN if a given font does not yet
follow the experimental versioning style, but at some point we may start
enforcing it.
* ā„¹ **INFO** Version string is: "Version 0.111" The version string must ideally include a git commit hash and either a "dev" or a "release" suffix such as in the example below: "Version 1.3; git-0d08353-release" [code: bad-format]
šŸž PASS: Checking file is named canonically. * [com.google.fonts/check/canonical_filename](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/canonical_filename)
--- Rationale ---
A font's filename must be composed in the following manner:
<familyname>-<stylename>.ttf

- Nunito-Regular.ttf,
- Oswald-BoldItalic.ttf

Variable fonts must list the axis tags in alphabetical order in square brackets
and separated by commas:

- Roboto[wdth,wght].ttf
- Familyname-Italic[wght].ttf
* šŸž **PASS** /usr/share/fonts/opentype/cantarell/Cantarell-Regular.otf is named canonically.
šŸž PASS: Substitute copyright, registered and trademark symbols in name table entries. * [com.google.fonts/check/name/unwanted_chars](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/unwanted_chars) * šŸž **PASS** No need to substitute copyright, registered and trademark symbols in name table entries of this font.
šŸž PASS: Checking OS/2 usWeightClass. * [com.google.fonts/check/usweightclass](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/usweightclass) * šŸž **PASS** OS/2 usWeightClass value looks good!
šŸž PASS: Description strings in the name table must not exceed 200 characters. * [com.google.fonts/check/name/description_max_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/description_max_length)
--- Rationale ---
An old FontLab version had a bug which caused it to store copyright notices in
nameID 10 entries.

In order to detect those and distinguish them from actual legitimate usage of
this name table entry, we expect that such strings do not exceed a reasonable
length of 200 chars.

Longer strings are likely instances of the FontLab bug.
* šŸž **PASS** All description name records have reasonably small lengths.
šŸž PASS: Make sure family name does not begin with a digit. * [com.google.fonts/check/name/familyname_first_char](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/familyname_first_char)
--- Rationale ---
Font family names which start with a numeral are often not discoverable in
Windows applications.
* šŸž **PASS** Font family name first character is not a digit.
šŸž PASS: Are there non-ASCII characters in ASCII-only NAME table entries? * [com.google.fonts/check/name/ascii_only_entries](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/ascii_only_entries)
--- Rationale ---
The OpenType spec requires ASCII for the POSTSCRIPT_NAME (nameID 6).

For COPYRIGHT_NOTICE (nameID 0) ASCII is required because that string should be
the same in CFF fonts which also have this requirement in the OpenType spec.

Note:
A common place where we find non-ASCII strings is on name table entries with
NameID > 18, which are expressly for localising the ASCII-only IDs into Hindi /
Arabic / etc.
* šŸž **PASS** None of the ASCII-only NAME table entries contain non-ASCII characteres.
šŸž PASS: Checking OS/2 fsSelection value. * [com.google.fonts/check/fsselection](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/fsselection) * šŸž **PASS** OS/2 fsSelection REGULAR bit is properly set. * šŸž **PASS** OS/2 fsSelection ITALIC bit is properly set. * šŸž **PASS** OS/2 fsSelection BOLD bit is properly set.
šŸž PASS: Checking post.italicAngle value. * [com.google.fonts/check/italic_angle](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/italic_angle)
--- Rationale ---
The 'post' table italicAngle property should be a reasonable amount, likely not
more than -20Ā°, never more than -30Ā°, and never greater than 0Ā°. Note that in
the OpenType specification, the value is negative for a lean rightwards.

https://docs.microsoft.com/en-us/typography/opentype/spec/post
* šŸž **PASS** Value of post.italicAngle is 0.0 with style="Regular".
šŸž PASS: Checking head.macStyle value. * [com.google.fonts/check/mac_style](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/mac_style)
--- Rationale ---
The values of the flags on the macStyle entry on the 'head' OpenType table that
describe whether a font is bold and/or italic must be coherent with the actual
style of the font as inferred by its filename.
* šŸž **PASS** head macStyle ITALIC bit is properly set. * šŸž **PASS** head macStyle BOLD bit is properly set.
šŸž PASS: Font has all mandatory 'name' table entries? * [com.google.fonts/check/name/mandatory_entries](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/mandatory_entries) * šŸž **PASS** Font contains values for all mandatory name table entries.
šŸž PASS: Check name table: FONT_FAMILY_NAME entries. * [com.google.fonts/check/name/familyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/familyname)
--- Rationale ---
Checks that the family name infered from the font filename matches the string
at nameID 1 (NAMEID_FONT_FAMILY_NAME) if it conforms to RIBBI and otherwise
checks that nameID 1 is the family name + the style name.
* šŸž **PASS** FONT_FAMILY_NAME entries are all good. [code: ok]
šŸž PASS: Check name table: FONT_SUBFAMILY_NAME entries. * [com.google.fonts/check/name/subfamilyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/subfamilyname) * šŸž **PASS** FONT_SUBFAMILY_NAME entries are all good.
šŸž PASS: Check name table: FULL_FONT_NAME entries. * [com.google.fonts/check/name/fullfontname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/fullfontname) * šŸž **PASS** FULL_FONT_NAME entries are all good.
šŸž PASS: Check name table: POSTSCRIPT_NAME entries. * [com.google.fonts/check/name/postscriptname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/postscriptname) * šŸž **PASS** POSTCRIPT_NAME entries are all good.
šŸž PASS: Check name table: TYPOGRAPHIC_FAMILY_NAME entries. * [com.google.fonts/check/name/typographicfamilyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/typographicfamilyname) * šŸž **PASS** TYPOGRAPHIC_FAMILY_NAME entries are all good.
šŸž PASS: Check name table: TYPOGRAPHIC_SUBFAMILY_NAME entries. * [com.google.fonts/check/name/typographicsubfamilyname](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/typographicsubfamilyname) * šŸž **PASS** TYPOGRAPHIC_SUBFAMILY_NAME entries are all good.
šŸž PASS: Length of copyright notice must not exceed 500 characters. * [com.google.fonts/check/name/copyright_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/copyright_length)
--- Rationale ---
This is an arbitrary max lentgh for the copyright notice field of the name
table. We simply don't want such notices to be too long. Typically such notices
are actually much shorter than this with a lenghth of roughtly 70 or 80
characters.
* šŸž **PASS** All copyright notice name entries on the 'name' table are shorter than 500 characters.
šŸž PASS: There must not be VTT Talk sources in the font. * [com.google.fonts/check/vttclean](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/vttclean)
--- Rationale ---
The goal here is to reduce filesizes and improve pageloading when dealing with
webfonts.

The VTT Talk sources are not necessary at runtime and endup being just dead
weight when left embedded in the font binaries. The sources should be kept on
the project files but stripped out when building release binaries.
* šŸž **PASS** There are no tables with VTT Talk sources embedded in the font.
šŸž PASS: Are there unwanted Apple tables? * [com.google.fonts/check/aat](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/aat)
--- Rationale ---
Apple's TrueType reference manual [1] describes SFNT tables not in the
Microsoft OpenType specification [2] and these can sometimes sneak into final
release files, but Google Fonts should only have OpenType tables.

[1] https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6.html
[2] https://docs.microsoft.com/en-us/typography/opentype/spec/
* šŸž **PASS** There are no unwanted AAT tables.
šŸž PASS: Combined length of family and style must not exceed 27 characters. * [com.google.fonts/check/name/family_and_style_max_length](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/googlefonts.html#com.google.fonts/check/name/family_and_style_max_length)
--- Rationale ---
According to a GlyphsApp tutorial [1], in order to make sure all versions of
Windows recognize it as a valid font file, we must make sure that the
concatenated length of the familyname (NameID.FONT_FAMILY_NAME) and style
(NameID.FONT_SUBFAMILY_NAME) strings in the name table do not exceed 20
characters.

After discussing the problem in more detail at `FontBakery issue #2179 [2] we
decided that allowing up to 27 chars would still be on the safe side, though.

[1]
https://glyphsapp.com/tutorials/multiple-masters-part-3-setting-up-instances
[2] https://github.com/googlefonts/fontbakery/issues/2179
* šŸž **PASS** All name entries are good.
šŸž PASS: Name table records must not have trailing spaces. * [com.google.fonts/check/name/trailing_spaces](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/name/trailing_spaces) * šŸž **PASS** No trailing spaces on name table entries.
šŸž PASS: Checking with ots-sanitize. * [com.google.fonts/check/ots](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/ots) * šŸž **PASS** ots-sanitize passed this file
šŸž PASS: Font contains .notdef as first glyph? * [com.google.fonts/check/mandatory_glyphs](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/mandatory_glyphs)
--- Rationale ---
The OpenType specification v1.8.2 recommends that the first glyph is the
.notdef glyph without a codepoint assigned and with a drawing.

https://docs.microsoft.com/en-us/typography/opentype/spec/recom#glyph-0-the-notdef-glyph

Pre-v1.8, it was recommended that a font should also contain a .null, CR and
space glyph. This might have been relevant for applications on MacOS 9.
* šŸž **PASS** Font contains the .notdef glyph as the first glyph, it does not have a Unicode value assigned and contains a drawing.
šŸž PASS: Font contains glyphs for whitespace characters? * [com.google.fonts/check/whitespace_glyphs](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/whitespace_glyphs) * šŸž **PASS** Font contains glyphs for whitespace characters.
šŸž PASS: Whitespace glyphs have ink? * [com.google.fonts/check/whitespace_ink](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/whitespace_ink) * šŸž **PASS** There is no whitespace glyph with ink.
šŸž PASS: Are there unwanted tables? * [com.google.fonts/check/unwanted_tables](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/unwanted_tables)
--- Rationale ---
Some font editors store source data in their own SFNT tables, and these can
sometimes sneak into final release files, which should only have OpenType spec
tables.
* šŸž **PASS** There are no unwanted tables.
šŸž PASS: Font contains unique glyph names? * [com.google.fonts/check/unique_glyphnames](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/universal.html#com.google.fonts/check/unique_glyphnames)
--- Rationale ---
Duplicate glyph names prevent font installation on Mac OS X.
* šŸž **PASS** Font contains unique glyph names.
šŸž PASS: Is the CFF subr/gsubr call depth > 10? * [com.adobe.fonts/check/cff_call_depth](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/cff.html#com.adobe.fonts/check/cff_call_depth)
--- Rationale ---
Per "The Type 2 Charstring Format, Technical Note #5177", the "Subr nesting,
stack limit" is 10.
* šŸž **PASS** Maximum call depth not exceeded.
šŸž PASS: Check all glyphs have codepoints assigned. * [com.google.fonts/check/all_glyphs_have_codepoints](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/cmap.html#com.google.fonts/check/all_glyphs_have_codepoints) * šŸž **PASS** All glyphs have a codepoint value assigned.
šŸž PASS: Checking unitsPerEm value is reasonable. * [com.google.fonts/check/unitsperem](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/head.html#com.google.fonts/check/unitsperem)
--- Rationale ---
According to the OpenType spec:

The value of unitsPerEm at the head table must be a value between 16 and 16384.
Any value in this range is valid.

In fonts that have TrueType outlines, a power of 2 is recommended as this
allows performance optimizations in some rasterizers.

But 1000 is a commonly used value. And 2000 may become increasingly more common
on Variable Fonts.
* šŸž **PASS** The unitsPerEm value (1000) on the 'head' table is reasonable.
šŸž PASS: Checking font version fields (head and name table). * [com.google.fonts/check/font_version](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/head.html#com.google.fonts/check/font_version) * šŸž **PASS** All font version fields match.
šŸž PASS: Check if OS/2 fsSelection matches head macStyle bold and italic bits. * [com.adobe.fonts/check/fsselection_matches_macstyle](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.adobe.fonts/check/fsselection_matches_macstyle)
--- Rationale ---
The bold and italic bits in OS/2.fsSelection must match the bold and italic
bits in head.macStyle per the OpenType spec.
* šŸž **PASS** The OS/2.fsSelection and head.macStyle bold and italic settings match.
šŸž PASS: Check code page character ranges * [com.google.fonts/check/code_pages](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/os2.html#com.google.fonts/check/code_pages)
--- Rationale ---
At least some programs (such as Word and Sublime Text) under Windows 7 do not
recognize fonts unless code page bits are properly set on the ulCodePageRange1
(and/or ulCodePageRange2) fields of the OS/2 table.

More specifically, the fonts are selectable in the font menu, but whichever
Windows API these applications use considers them unsuitable for any character
set, so anything set in these fonts is rendered with a fallback font of Arial.

This check currently does not identify which code pages should be set.
Auto-detecting coverage is not trivial since the OpenType specification leaves
the interpretation of whether a given code page is "functional" or not open to
the font developer to decide.

So here we simply detect as a FAIL when a given font has no code page declared
at all.
* šŸž **PASS** At least one code page is defined.
šŸž PASS: Font has correct post table version (2 for TTF, 3 for OTF)? * [com.google.fonts/check/post_table_version](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/post.html#com.google.fonts/check/post_table_version) * šŸž **PASS** Font has post table version 3.
šŸž PASS: Check name table for empty records. * [com.adobe.fonts/check/name/empty_records](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.adobe.fonts/check/name/empty_records)
--- Rationale ---
Check the name table for empty records, as this can cause problems in Adobe
apps.
* šŸž **PASS** No empty name table records found.
šŸž PASS: Description strings in the name table must not contain copyright info. * [com.google.fonts/check/name/no_copyright_on_description](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/name/no_copyright_on_description) * šŸž **PASS** Description strings in the name table do not contain any copyright string.
šŸž PASS: Name table entries should not contain line-breaks. * [com.google.fonts/check/name/line_breaks](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/name/line_breaks) * šŸž **PASS** Name table entries are all single-line (no line-breaks found).
šŸž PASS: Does full font name begin with the font family name? * [com.google.fonts/check/name/match_familyname_fullfont](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/name/match_familyname_fullfont) * šŸž **PASS** Full font name begins with the font family name.
šŸž PASS: Font follows the family naming recommendations? * [com.google.fonts/check/family_naming_recommendations](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/family_naming_recommendations) * šŸž **PASS** Font follows the family naming recommendations.
šŸž PASS: Name table strings must not contain the string 'Reserved Font Name'. * [com.google.fonts/check/name/rfn](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.google.fonts/check/name/rfn) * šŸž **PASS** None of the name table strings contain "Reserved Font Name".
šŸž PASS: CFF table FontName must match name table ID 6 (PostScript name). * [com.adobe.fonts/check/name/postscript_vs_cff](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/name.html#com.adobe.fonts/check/name/postscript_vs_cff)
--- Rationale ---
The PostScript name entries in the font's 'name' table should match the
FontName string in the 'CFF ' table.

The 'CFF ' table has a lot of information that is duplicated in other tables.
This information should be consistent across tables, because there's no
guarantee which table an app will get the data from.
* šŸž **PASS** Name table PostScript name matches CFF table FontName.
šŸž PASS: MaxAdvanceWidth is consistent with values in the Hmtx and Hhea tables? * [com.google.fonts/check/maxadvancewidth](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/hhea.html#com.google.fonts/check/maxadvancewidth) * šŸž **PASS** MaxAdvanceWidth is consistent with values in the Hmtx and Hhea tables.
šŸž PASS: Whitespace and non-breaking space have the same width? * [com.google.fonts/check/whitespace_widths](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/hmtx.html#com.google.fonts/check/whitespace_widths) * šŸž **PASS** Whitespace and non-breaking space have the same width.
šŸž PASS: Is there a "kern" table declared in the font? * [com.google.fonts/check/kern_table](https://font-bakery.readthedocs.io/en/latest/fontbakery/profiles/kern.html#com.google.fonts/check/kern_table)
--- Rationale ---
Even though, all fonts should have their kerning implemented in the GPOS table,
there may be kerning info at the kern table as well.

Some applications such as MS PowerPoint require kerning info on the kern table.
More specifically, they require a format 0 kern subtable from a kern table
version 0, which is the only one that Windows understands (and which is also
the simplest and more limited of all the kern subtables).

Google Fonts ingests fonts made for download and use as desktops, and does all
web font optimizations in the serving pipeline (using libre libraries that
anyone can replicate.)

Ideally, TTFs intended for desktop users (and thus the ones intended for Google
Fonts) should have both KERN and GPOS tables.

Given all of the above, we currently treat kerning on a v0 kern table as a
good-to-have (but optional) feature.
* šŸž **PASS** Font does not declare an optional "kern" table.

### Summary | šŸ’” ERROR | šŸ”„ FAIL | āš  WARN | šŸ’¤ SKIP | ā„¹ INFO | šŸž PASS | šŸ”Ž DEBUG | |:-----:|:----:|:----:|:----:|:----:|:----:|:----:| | 4 | 10 | 6 | 84 | 2 | 54 | 0 | | 2% | 6% | 4% | 52% | 1% | 34% | 0% | **Note:** The following loglevels were omitted in this report: * **DEBUG**
eliheuer commented 5 years ago

Awesome work! The monospace rationale in the markdown looks great IMO.

This also seems like a big improvement to me:

tweaked the syntax and wrote a pice of code that does the 80 column formating for us. We now store the paragraphs as long lines instead of breaking them into smaller lines manually.

felipesanches commented 5 years ago

here' s what we got on the terminal output now: Screenshot from 2019-11-03 20-11-52

I hope you like it ;-)