@forumone/throughline-design-system 1.0.0-next.0 → 1.0.0-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -0
- package/README.md +12 -10
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -2,20 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
The design-system side of Throughline. A design system describes its components in a manifest; this package defines that manifest, lints it, and turns it into Payload blocks, rendering and admin components for a Throughline site.
|
|
4
4
|
|
|
5
|
-
> **1.0 is in progress.** This package is `@forumone/throughline-design-contract` and `@forumone/throughline-design-system-payload` together; [
|
|
5
|
+
> **1.0 is in progress.** This package is `@forumone/throughline-design-contract` and `@forumone/throughline-design-system-payload` together; [Upgrading from 0.x](https://github.com/forumone/throughline/blob/main/docs/guides/upgrading.md) moves a 0.x site onto it. Pre-releases publish as `1.0.0-next.N` under the `next` dist-tag.
|
|
6
6
|
|
|
7
|
-
| Subpath | Holds
|
|
8
|
-
| ----------- |
|
|
9
|
-
| `/contract` | `ComponentContractSchema`, `ManifestSchema`, `loadManifest`: the contract every component declares and the manifest they make; see [docs/contract.md](docs/contract.md) |
|
|
10
|
-
| `/lint` | `lintManifest`, `formatLintIssues`, `assertManifestClean`
|
|
11
|
-
| `/generate` | `generateBlocks` and friends, manifest to Payload blocks, and `fieldOverride` for a site's exceptions; see [docs/payload.md](docs/
|
|
12
|
-
| `/render` | `RenderBlocks` and `coerceBlock`: stored blocks back to React
|
|
13
|
-
| `/client` | `BlockSummary`, `BlockGuidance`, `RowSummary`: admin components named in Payload's import map
|
|
14
|
-
| `/testing` | `describeBlockInvariants`, `checkUntouchedBlocks`, `checkBlockProps`: invariants a site runs over its blocks
|
|
15
|
-
| bin | `check-block-props <manifest.json> <components-dir>…`: does each contract produce the props its component takes?
|
|
7
|
+
| Subpath | Holds |
|
|
8
|
+
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
9
|
+
| `/contract` | `ComponentContractSchema`, `ManifestSchema`, `loadManifest`: the contract every component declares and the manifest they make; see [docs/contract.md](https://github.com/forumone/throughline/blob/main/docs/reference/design-system/contract.md) |
|
|
10
|
+
| `/lint` | `lintManifest`, `formatLintIssues`, `assertManifestClean` |
|
|
11
|
+
| `/generate` | `generateBlocks` and friends, manifest to Payload blocks, and `fieldOverride` for a site's exceptions; see [docs/payload.md](https://github.com/forumone/throughline/blob/main/docs/reference/design-system/generate.md) |
|
|
12
|
+
| `/render` | `RenderBlocks` and `coerceBlock`: stored blocks back to React |
|
|
13
|
+
| `/client` | `BlockSummary`, `BlockGuidance`, `RowSummary`: admin components named in Payload's import map |
|
|
14
|
+
| `/testing` | `describeBlockInvariants`, `checkUntouchedBlocks`, `checkBlockProps`: invariants a site runs over its blocks |
|
|
15
|
+
| bin | `check-block-props <manifest.json> <components-dir>…`: does each contract produce the props its component takes? |
|
|
16
16
|
|
|
17
17
|
```bash
|
|
18
18
|
pnpm add @forumone/throughline-design-system@next
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
`/contract` and `/lint` have no peers, so a design system that only publishes a manifest needs nothing else. The rest expects `payload` and `react`, `/client` expects `@payloadcms/ui`, `/generate` reads component source with `typescript`, and `/testing` is a vitest suite.
|
|
22
|
+
|
|
23
|
+
**Reference: [`docs/reference/design-system.md`](https://github.com/forumone/throughline/blob/main/docs/reference/design-system.md).**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forumone/throughline-design-system",
|
|
3
|
-
"version": "1.0.0-next.
|
|
3
|
+
"version": "1.0.0-next.2",
|
|
4
4
|
"description": "The design-system side of Throughline: the component contract and manifest a design system publishes, its linter, and the Payload blocks, rendering and admin components generated from it.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"exports": {
|