Skip to content

Commit 353eba0

Browse files
committed
dev: add project information for Theia AI
Adds '.prompts/project-info.prompttemplate' to hand over JSON Forms project information to Theia AI.
1 parent e0da625 commit 353eba0

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.prompts/project-info.prompttemplate

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## JSON Forms Project information
2+
3+
JSON Forms is a declarative framework for efficiently building form-based web UIs.
4+
These UIs are targeted at entering, modifying and viewing data and are usually embedded within an application.
5+
6+
Any UI is defined by using two schemata:
7+
- The JSON schema defines the underlying data to be shown in the UI (objects, properties, and their types)
8+
- The UI schema defines how this data is rendered as a form, e.g. the order of controls, their visibility, and the layout.
9+
If no UI schema is given, it will be auto generated
10+
11+
We put great emphasis on the customizability and extensibility of JSON Forms.
12+
13+
### Architecture overview
14+
15+
The JSON Forms mono repository consists of these packages:
16+
- `@jsonforms/core` in `packages/core`: Provides utilities for managing and rendering JSON Schema based forms.
17+
The core package is independent of any UI technology.
18+
- `@jsonforms/react` in `packages/react`, `@jsonforms/angular` in `packages/angular`, `@jsonforms/vue` in `packages/vue`.
19+
These use the core package to provide specialized bindings for React, Angular and Vue, leveraging each respective's state management and rendering systems.
20+
- For React we maintain two renderer sets: The `@jsonforms/material-renderers` in `packages/material-renderers`, which are based on the popular Material-UI framework and `@jsonforms/vanilla-renderers` in `packages/vanilla-renderers` which provides pure HTML5 renderers.
21+
For Angular we provide an Angular Material based renderer set (`@jsonforms/angular-material` in `packages/angular-material`). For Vue we provide a HTML5 based renderer set `@jsonforms/vue-vanilla` in `packages/vue-vanilla` and a Vuetify based one `@jsonforms/vue-vuetify` in `packages/vue-vuetify`.
22+
23+
### Core principles
24+
25+
JSON Forms uses a reducer-style approach for its state management.
26+
The form-wide state is manipulated via the reducers in packages/core/src/reducers.
27+
28+
Renderers are registered in a registry, consisting of tester,renderer pairs.
29+
For each UI Schema element to be rendered, all testers are asked for their priority.
30+
The highest priority wins and the respective renderer gets full control over rendering.
31+
The renderer may dispatch back to JSON Forms to render children elements.
32+
33+
Dispatchers only receive a minimal amount of properties, e.g. which part of the JSON Schema they are refering to and which UI Schema element is to be rendered.
34+
Mappers in packages/core/src/mappers are then used to determine the actual props for the renderers to work with, combining the handed over dispatch props and the form-wide state.
35+
36+
The binding packages `@jsonforms/react`, `@jsonforms/angular` and `@jsonforms/vue` bind these functionalities to mechanisms of their respective framework.
37+
The renderers then use the bound functionalities and usually do not interact with `@jsonforms/core` directly.
38+
39+
### Coding Guidelines
40+
41+
When creating new functions we prefer the arrow style approach
42+
43+
### Development Guidelines
44+
45+
The framework is popular, therefore we never break adopters if we don't have to.
46+
Consider this for all changes.

0 commit comments

Comments
 (0)