@celljs/kit 4.6.0 → 4.7.0
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.en.md +18 -0
- package/package.json +1 -1
package/README.en.md
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# @celljs/kit
|
|
2
|
+
|
|
3
|
+
Shared types of the Cell 4 toolchain for `@celljs/cli`, `@celljs/vite`, toolchain modules, and preset authors, with no runtime dependencies.
|
|
4
|
+
|
|
5
|
+
- `CellError`: the shape of all toolchain errors `{ code, message, file?, line?, column?, hint, docs }`. `CellError.is(e)` identifies by name and works even with cross-package copies; `format()` is the CLI output format, `toJSON()` is the `--json` format.
|
|
6
|
+
- Events: `CELL_EVENTS`, `EVENT_RULES` (each event's fixed combination of rules: `notify` / `mutate` / `gate`), `HOOKABLE_EVENTS` (events that a project's `hooks` can subscribe to).
|
|
7
|
+
- `Preset` and `definePreset`.
|
|
8
|
+
- `ComponentManifest`: the `cell` field of component package.json (`modules`, `staticModules`, `targets`, `entries`, `optionalDependencies`, `toolchain`).
|
|
9
|
+
- `ProjectModel` / `TargetModel`: the project model produced by `@celljs/vite`.
|
|
10
|
+
- `CellModuleOptions`: toolchain modules extend it to declare option types for `cell.config.ts`.
|
|
11
|
+
|
|
12
|
+
```ts
|
|
13
|
+
declare module '@celljs/kit' {
|
|
14
|
+
interface CellModuleOptions {
|
|
15
|
+
audit?: { url: string };
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
```
|