@foodpilot/foods 2.25.4 → 2.25.6
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/README.md +19 -14
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -44,20 +44,23 @@ their texts with `react-i18next`, the English strings being the keys; the applic
|
|
|
44
44
|
`npm run storybook` serves it on port 6006, `npm run build-storybook` builds it into `storybook-static/`. The
|
|
45
45
|
`demo.yml` workflow deploys it after every release.
|
|
46
46
|
|
|
47
|
-
| Section
|
|
48
|
-
|
|
|
49
|
-
| Getting Started
|
|
50
|
-
| Components
|
|
51
|
-
| Elements
|
|
52
|
-
| Layout
|
|
53
|
-
| Preview
|
|
54
|
-
|
|
|
55
|
-
| Deprecated
|
|
47
|
+
| Section | What it holds | Folder |
|
|
48
|
+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- |
|
|
49
|
+
| Getting Started | Welcome, and the guides for designers, product and developers | `src/getting-started/` |
|
|
50
|
+
| Components | The components to use, by Figma Design System page: Actions, Avatar and user, Content, Data display, Feedbacks, Inputs, Modals, Navigation | `src/components/<Category>/` |
|
|
51
|
+
| Elements | The foundations: colours, typography, spacing, shadows, breakpoints, icons | `src/elements/` |
|
|
52
|
+
| Layout | Page layouts | `src/layout/` |
|
|
53
|
+
| Preview | Components still being built or redesigned | `src/preview/` |
|
|
54
|
+
| Legacy | Components removed from the Figma Design System, kept for the screens that use them | `src/legacy/<Category>/` |
|
|
55
|
+
| Deprecated | Deliberate deprecations | `src/deprecated/<Category>/` |
|
|
56
56
|
|
|
57
57
|
Each component has an **Overview** page (`src/docs/DocsPage.tsx`) with:
|
|
58
58
|
|
|
59
|
+
- its match with the Figma design (the doc status of its Figma frame) and the day its usage guidelines were copied
|
|
60
|
+
from Figma;
|
|
59
61
|
- its description;
|
|
60
|
-
- the usage guidelines from Figma: do's and don'ts, anatomy, behaviour, content and states
|
|
62
|
+
- the usage guidelines from Figma: do's and don'ts, anatomy, behaviour, content and states, or _No usage guidelines
|
|
63
|
+
yet_;
|
|
61
64
|
- every story;
|
|
62
65
|
- the props (Component API);
|
|
63
66
|
- its references.
|
|
@@ -73,12 +76,14 @@ In Storybook:
|
|
|
73
76
|
[AGENTS.md](AGENTS.md) holds the rules for any change. In short:
|
|
74
77
|
|
|
75
78
|
- **Stories:** a component's stories go in `src/components/<Category>/<Component>.stories.tsx`, without a `title`,
|
|
76
|
-
since the folder decides the sidebar
|
|
77
|
-
|
|
79
|
+
since the folder decides the sidebar, and their meta starts with a stable `id`, the file name in lower case, so the
|
|
80
|
+
URLs survive a move. Their texts are in English, with fitting controls, `fn()` callbacks and a `play` function.
|
|
81
|
+
Usage guidelines come from Figma, in `parameters.guidelines`, with the Figma doc `status` and the `syncedAt` day.
|
|
78
82
|
- **llms.txt:** when a component or its stories are added, moved or removed, run `npm run llms` and commit
|
|
79
83
|
`llms.txt`. CI fails when it is stale.
|
|
80
|
-
- **
|
|
81
|
-
|
|
84
|
+
- **Legacy:** a component's stories move to `src/legacy/` with `git mv` once it is removed from the Figma Design
|
|
85
|
+
System, then `llms.txt` is refreshed. The platform-design skill of the frontend harness reports the stories
|
|
86
|
+
platform-app no longer imports; that alone does not move them.
|
|
82
87
|
- **Checks:**
|
|
83
88
|
- `npm run prettier`, `npm run lint`, `npm run tsc`;
|
|
84
89
|
- `npm test`, which includes the stories' plays and the `llms.txt` check;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@foodpilot/foods",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "2.25.
|
|
4
|
+
"version": "2.25.6",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/main.js",
|
|
7
7
|
"module": "./dist/main.js",
|
|
@@ -300,10 +300,10 @@
|
|
|
300
300
|
"remark-gfm": "^4.0.1",
|
|
301
301
|
"rollup-plugin-visualizer": "^7.0.0",
|
|
302
302
|
"size-limit": "^12.0.0",
|
|
303
|
-
"storybook": "^10.
|
|
303
|
+
"storybook": "^10.6.4",
|
|
304
304
|
"typescript": "^5.9.3",
|
|
305
305
|
"typescript-eslint": "^8.56.1",
|
|
306
|
-
"vite": "^7.3.
|
|
306
|
+
"vite": "^7.3.7",
|
|
307
307
|
"vite-bundle-visualizer": "^1.2.1",
|
|
308
308
|
"vite-plugin-dts": "^4.5.0",
|
|
309
309
|
"vite-plugin-svgr": "^4.5.0",
|