Skip to content

Commit e672a3e

Browse files
committed
uses ef-forms and solid-ui-core. Thank you claude
1 parent 143221a commit e672a3e

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

CLAUDE.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,28 @@ Git hooks (Husky): pre-commit runs lint-staged; pre-push runs `npm test`.
5050

5151
**Data layer:** The library relies on `solid-logic` for the RDF store (`store`) and authentication (`authn`). RDF namespaces come from `solid-namespace`. Widgets read/write RDF data through `rdflib` quad-store APIs — no REST calls are made directly; all persistence goes through the store.
5252

53-
## solid-ui-core
53+
## Related packages
5454

55-
Pure utility modules (namespaces, style, debug, logging, icons, key helpers) live in a separate package at `../solid-ui-core/` (repo: `github.com/solidos/solid-ui-core`). They are imported here as `solid-ui-core`.
55+
This repo depends on two sibling packages, both cloned next to this directory:
5656

57-
**Local development:** After editing solid-ui-core, run `npm run build-lib` there, then tests here will pick up the changes via the npm link. The link is set up with `npm link solid-ui-core` from this directory.
57+
| Package | Repo | Local path |
58+
|---------|------|------------|
59+
| `solid-ui-core` | `github.com/solidos/solid-ui-core` | `../solid-ui-core/` |
60+
| `ui-forms` | `github.com/solidos/ui-forms` | `../ui-forms/` |
5861

59-
**Critical:** `solid-logic` and `rdflib` must not exist inside `node_modules/solid-ui-core/node_modules/` — npm 7 sometimes auto-installs peer deps there, which creates duplicate store instances. Delete them if they appear.
62+
**`solid-ui-core`** holds pure utility modules: namespaces (`ns`), style constants, debug/log, icons, buttons, error, dragAndDrop, multiSelect, widgetHelpers, and utils/keyHelpers.
6063

61-
**Jest mocking:** When mocking solid-ui-core modules in tests, use the package alias form:
64+
**`ui-forms`** holds the W3C UI vocabulary form renderer: fieldParams, fieldFunction, formStyle, basic, comment, and autocomplete components.
65+
66+
**Local development:** Neither package is published to npm yet — they are npm-linked. After editing either sibling, run `npm run build-lib` there before running tests here. Links are set up as symlinks in `node_modules/`.
67+
68+
**Critical:** `solid-logic` and `rdflib` must not exist inside `node_modules/solid-ui-core/node_modules/` or `node_modules/ui-forms/node_modules/` — npm 7 auto-installs peer deps there, creating duplicate store instances. Delete them if they appear.
69+
70+
**Jest mocking:** When mocking sub-path imports in tests, use the package alias form:
6271
```ts
6372
jest.mock('solid-ui-core/utils/keyHelpers/otherHelpers', () => { ... })
6473
```
65-
Not the raw `node_modules/solid-ui-core/src/...ts` path — that never intercepts the compiled `require()` calls.
74+
Not the raw `node_modules/.../src/...ts` path — that never intercepts the compiled `require()` calls.
6675

6776
**Build outputs:**
6877
- `lib/` — Babel-transpiled CommonJS modules (npm consumers)

0 commit comments

Comments
 (0)