designspace-lint 0.1.0__tar.gz

designspace_lint-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage

designspace_lint-0.1.0/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-09-22
+
+First release. The checks were extracted from the font editor
+[font-rover](https://github.com/typedev/font-rover), where they grew out of a
+reimplementation of [designspaceProblems](https://github.com/LettError/DesignspaceProblems)
+by Erik van Blokland — see [NOTICE](NOTICE).
+
+### Added
+
+- Ten check categories over a designspace and its UFO masters: file, axes,
+  sources, instances, glyph compatibility, kerning, font info, rules, features
+  and glyph order.
+- `lint()` for callers whose fonts are already open, `lint_path()` for callers
+  with a path, `iter_lint()` to stream results, and `Linter` for phase and
+  progress control.
+- A CLI: `designspace-lint <path>`, with `-v`, `-q` and `--json`, exiting 1 on
+  problems and 2 when the designspace cannot be read.
+- Checks whose rules were verified against fontTools and ufo2ft rather than
+  assumed, and whose messages name what the build will do:
+  - **4.11** a glyph that does not reach one end of an axis reverts to the
+    default master's shape past its last master;
+  - **4.12** a glyph left empty next to masters that draw it;
+  - **5.0** a master with no kerning, where every pair resolves to 0;
+  - **5.8** a glyph in two kerning groups of the same side, whose second group
+    ufo2ft discards whole;
+  - **8.3** `features.fea` mixed across masters, which silently moves the build
+    off the variable-feature path.
+- Layer-based designspaces are handled throughout: masters sharing a UFO are
+  identified by path *and* layer, and glyphs are read from the layer a master
+  actually draws.
+- Codes 4.0–4.10 keep the meanings designspaceProblems gave them.

designspace_lint-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

designspace_lint-0.1.0/NOTICE

@@ -0,0 +1,42 @@
+designspace-lint
+Copyright 2024-2026 TypeDev / Alexander Lubovenko
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+--------------------------------------------------------------------------
+
+This project began as a reimplementation of designspaceProblems by Erik van
+Blokland (LettError), and follows its way of numbering problems by category
+and code. Codes 4.0 through 4.10 -- the glyph compatibility checks -- carry
+the meanings that project gave them. No source code was copied; the checks
+were rewritten, and several of their definitions were changed after being
+measured against fontTools and ufo2ft.
+
+designspaceProblems is available at
+https://github.com/LettError/DesignspaceProblems under the MIT license:
+
+    Copyright (c) 2017-2018 LettError and Erik van Blokland
+    All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a
+    copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to permit
+    persons to whom the Software is furnished to do so, subject to the
+    following conditions:
+
+    The above copyright notice and this permission notice shall be included
+    in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+    OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+    NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+    OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+    USE OR OTHER DEALINGS IN THE SOFTWARE.

designspace_lint-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.5
+Name: designspace-lint
+Version: 0.1.0
+Summary: Tell a designspace what it will do when it is built: silent glyph, kerning, feature and glyph-order problems in UFO masters.
+Project-URL: Homepage, https://github.com/typedev/designspace-lint
+Project-URL: Repository, https://github.com/typedev/designspace-lint
+Project-URL: Issues, https://github.com/typedev/designspace-lint/issues
+Author-email: Alexander Lubovenko <alextypedev@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: designspace,fonts,interpolation,lint,typography,ufo,variable-fonts
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Fonts
+Requires-Python: >=3.10
+Requires-Dist: fontparts>=0.12.0
+Requires-Dist: fontpens>=0.2.4
+Requires-Dist: fonttools>=4.40.0
+Provides-Extra: features
+Requires-Dist: ufo2ft>=3.0.0; extra == 'features'
+Description-Content-Type: text/markdown
+
+# designspace-lint
+
+**What a designspace will do when it is built — before you build it.**
+
+A designspace can be perfectly valid and still produce a variable font nobody
+intended. A glyph missing from the master at the end of an axis quietly reverts
+to the default's shape past that point. A master with no kerning drags the
+family's kerning toward zero around its location. A `features.fea` that differs
+from the default's pushes the whole build onto another path, where `varLib`
+fails somewhere that has nothing to do with the cause. None of this is an
+error at build time; the font just comes out wrong.
+
+This library reports those cases, and each report names the **consequence**,
+not only the discrepancy.
+
+```console
+$ designspace-lint Family.designspace
+error 4.11 /eacute Weight 400 of 900: missing at Weight maximum (900); reverts to the default shape past 400
+error 5.0 Bold.ufo (Bold): no kerning: the family's kerning sags to 0 here
+warn  4.2 /acute missing in 12 sources: anchor '_topacute' missing in 12 sources
+3 problem(s), 2 structural
+```
+
+Exit code is `0` when clean, `1` when there are problems, `2` when the
+designspace cannot be read — so a build script can gate on it directly.
+
+## Install
+
+```console
+pip install designspace-lint            # the checks and the CLI
+pip install "designspace-lint[features]"  # + the features.fea comparison (ufo2ft)
+```
+
+## Use it from Python
+
+```python
+from designspace_lint import lint_path
+
+for problem in lint_path("Family.designspace"):
+    print(problem.category, problem.code, problem.description)
+```
+
+When the fonts are already open — inside an editor, or a build script that has
+loaded them anyway — hand them over instead of paying to open them twice. Any
+object with `path`, `doc` and `sources` will do, where each source has `font`,
+`path`, `name`, `location`, `layer_name` and the layer accessors described by
+`designspace_lint.protocols.SourceLike`:
+
+```python
+from designspace_lint import lint
+
+problems = lint(my_designspace)     # nothing is re-opened
+```
+
+## What it checks
+
+| Category | What it looks at |
+|---|---|
+| 0 File | the document can be read at all |
+| 1 Geometry | axis minimum/default/maximum, mappings, duplicate names and tags |
+| 2 Sources | locations, missing UFOs, duplicate locations, the default |
+| 3 Instances | instance locations and names |
+| 4 Glyphs | master compatibility: contours, points, curve types, components, anchors, unicodes, contour direction, empty glyphs, and **how far along each axis a glyph actually reaches** |
+| 5 Kerning | kerning groups, masters with no kerning, a glyph in two groups of one side |
+| 6 Font Info | units per em, required fields, values that differ |
+| 7 Rules | designspace rules |
+| 8 Features | whether the masters' `features.fea` keep the build on the variable path |
+| 9 Glyph Order | extra glyphs, and orders that break the per-master merge |
+
+The `(category, code)` pairs are a **public contract**. A retired check keeps
+its number, and new checks only ever get new ones.
+
+### The rules come from what the tools actually do
+
+Every rule here was checked against `fontTools` and `ufo2ft` rather than
+assumed, and several of them contradict what seems reasonable:
+
+- A glyph may skip a master **in the middle** of an axis — varLib builds a
+  per-glyph model from the masters that have it. Skipping the master at the
+  **end** of an axis is the dangerous one: measured on a 0 / 0.5 / 1.0 axis
+  carrying 100 / 150 / 300 with the last master missing, 0.75 gives 125 and
+  1.0 gives 100 instead of 225 and 300. The font builds without a word.
+- **Differing kerning pair sets are normal** and are not reported: a pair a
+  master does not list resolves to its group value or to 0, which is exactly
+  what its absence means in a UFO. A master with *no* kerning is reported,
+  because then every pair resolves to 0 there.
+- Groups without pairs do not help — verified by building a variable font and
+  reading the values back.
+- `ufo2ft` compiles one variable feature file from the default master **only**
+  when every other master's `features.fea` matches it or all of them are
+  empty. A mix of the two is not compatible either, and falling off that path
+  is silent.
+- Sparse masters need no naming convention. Which masters a glyph may skip
+  follows from the axes; which sources carry kerning, features and a glyph
+  order of their own follows from whether they are layers.
+
+## Relation to designspaceProblems
+
+This started as a reimplementation of
+[designspaceProblems](https://github.com/LettError/DesignspaceProblems) by
+**Erik van Blokland (LettError)**, MIT-licensed, and it still owes that project
+its shape: the idea of numbering problems by category and code, and most of the
+category-4 glyph compatibility checks, come from there. The numbering is kept
+deliberately compatible — codes 4.0 to 4.10 mean what they mean in
+designspaceProblems — so anyone moving across reads the same numbers.
+
+It was rewritten rather than wrapped because of what using it in a font editor
+asked for, and those needs turned out to be structural:
+
+- **Results as data, not as a report.** Every problem is a dataclass carrying
+  its location, the masters involved and the diagnosis, so a UI can group,
+  filter and navigate them. The original returns a mapping of problem to glyph
+  names, which is the right shape for a report and the wrong one for a list
+  you click through.
+- **No re-opening fonts.** An editor already holds them; the checks take
+  whatever satisfies the protocol.
+- **Layer-based designspaces.** Several masters in one UFO, told apart by
+  layer, have to be compared on the layer they actually draw.
+- **Progress and cancellation**, because a family with 84 masters takes long
+  enough that a person will want to stop it.
+- **Consequences in the message.** The checks grew to say what the build will
+  do, which meant verifying each rule against varLib and ufo2ft — and finding
+  a few where the reasonable-sounding rule is not the real one.
+
+It is not a drop-in replacement: the entry points and the result type differ.
+For the glyph checks the vocabulary is the same.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE), and [NOTICE](NOTICE) for the
+designspaceProblems attribution.

designspace_lint-0.1.0/README.md

@@ -0,0 +1,131 @@
+# designspace-lint
+
+**What a designspace will do when it is built — before you build it.**
+
+A designspace can be perfectly valid and still produce a variable font nobody
+intended. A glyph missing from the master at the end of an axis quietly reverts
+to the default's shape past that point. A master with no kerning drags the
+family's kerning toward zero around its location. A `features.fea` that differs
+from the default's pushes the whole build onto another path, where `varLib`
+fails somewhere that has nothing to do with the cause. None of this is an
+error at build time; the font just comes out wrong.
+
+This library reports those cases, and each report names the **consequence**,
+not only the discrepancy.
+
+```console
+$ designspace-lint Family.designspace
+error 4.11 /eacute Weight 400 of 900: missing at Weight maximum (900); reverts to the default shape past 400
+error 5.0 Bold.ufo (Bold): no kerning: the family's kerning sags to 0 here
+warn  4.2 /acute missing in 12 sources: anchor '_topacute' missing in 12 sources
+3 problem(s), 2 structural
+```
+
+Exit code is `0` when clean, `1` when there are problems, `2` when the
+designspace cannot be read — so a build script can gate on it directly.
+
+## Install
+
+```console
+pip install designspace-lint            # the checks and the CLI
+pip install "designspace-lint[features]"  # + the features.fea comparison (ufo2ft)
+```
+
+## Use it from Python
+
+```python
+from designspace_lint import lint_path
+
+for problem in lint_path("Family.designspace"):
+    print(problem.category, problem.code, problem.description)
+```
+
+When the fonts are already open — inside an editor, or a build script that has
+loaded them anyway — hand them over instead of paying to open them twice. Any
+object with `path`, `doc` and `sources` will do, where each source has `font`,
+`path`, `name`, `location`, `layer_name` and the layer accessors described by
+`designspace_lint.protocols.SourceLike`:
+
+```python
+from designspace_lint import lint
+
+problems = lint(my_designspace)     # nothing is re-opened
+```
+
+## What it checks
+
+| Category | What it looks at |
+|---|---|
+| 0 File | the document can be read at all |
+| 1 Geometry | axis minimum/default/maximum, mappings, duplicate names and tags |
+| 2 Sources | locations, missing UFOs, duplicate locations, the default |
+| 3 Instances | instance locations and names |
+| 4 Glyphs | master compatibility: contours, points, curve types, components, anchors, unicodes, contour direction, empty glyphs, and **how far along each axis a glyph actually reaches** |
+| 5 Kerning | kerning groups, masters with no kerning, a glyph in two groups of one side |
+| 6 Font Info | units per em, required fields, values that differ |
+| 7 Rules | designspace rules |
+| 8 Features | whether the masters' `features.fea` keep the build on the variable path |
+| 9 Glyph Order | extra glyphs, and orders that break the per-master merge |
+
+The `(category, code)` pairs are a **public contract**. A retired check keeps
+its number, and new checks only ever get new ones.
+
+### The rules come from what the tools actually do
+
+Every rule here was checked against `fontTools` and `ufo2ft` rather than
+assumed, and several of them contradict what seems reasonable:
+
+- A glyph may skip a master **in the middle** of an axis — varLib builds a
+  per-glyph model from the masters that have it. Skipping the master at the
+  **end** of an axis is the dangerous one: measured on a 0 / 0.5 / 1.0 axis
+  carrying 100 / 150 / 300 with the last master missing, 0.75 gives 125 and
+  1.0 gives 100 instead of 225 and 300. The font builds without a word.
+- **Differing kerning pair sets are normal** and are not reported: a pair a
+  master does not list resolves to its group value or to 0, which is exactly
+  what its absence means in a UFO. A master with *no* kerning is reported,
+  because then every pair resolves to 0 there.
+- Groups without pairs do not help — verified by building a variable font and
+  reading the values back.
+- `ufo2ft` compiles one variable feature file from the default master **only**
+  when every other master's `features.fea` matches it or all of them are
+  empty. A mix of the two is not compatible either, and falling off that path
+  is silent.
+- Sparse masters need no naming convention. Which masters a glyph may skip
+  follows from the axes; which sources carry kerning, features and a glyph
+  order of their own follows from whether they are layers.
+
+## Relation to designspaceProblems
+
+This started as a reimplementation of
+[designspaceProblems](https://github.com/LettError/DesignspaceProblems) by
+**Erik van Blokland (LettError)**, MIT-licensed, and it still owes that project
+its shape: the idea of numbering problems by category and code, and most of the
+category-4 glyph compatibility checks, come from there. The numbering is kept
+deliberately compatible — codes 4.0 to 4.10 mean what they mean in
+designspaceProblems — so anyone moving across reads the same numbers.
+
+It was rewritten rather than wrapped because of what using it in a font editor
+asked for, and those needs turned out to be structural:
+
+- **Results as data, not as a report.** Every problem is a dataclass carrying
+  its location, the masters involved and the diagnosis, so a UI can group,
+  filter and navigate them. The original returns a mapping of problem to glyph
+  names, which is the right shape for a report and the wrong one for a list
+  you click through.
+- **No re-opening fonts.** An editor already holds them; the checks take
+  whatever satisfies the protocol.
+- **Layer-based designspaces.** Several masters in one UFO, told apart by
+  layer, have to be compared on the layer they actually draw.
+- **Progress and cancellation**, because a family with 84 masters takes long
+  enough that a person will want to stop it.
+- **Consequences in the message.** The checks grew to say what the build will
+  do, which meant verifying each rule against varLib and ufo2ft — and finding
+  a few where the reasonable-sounding rule is not the real one.
+
+It is not a drop-in replacement: the entry points and the result type differ.
+For the glyph checks the vocabulary is the same.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE), and [NOTICE](NOTICE) for the
+designspaceProblems attribution.