diff --git a/.gitignore b/.gitignore index 658b9f0e0e..d3b39378e4 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ stats.html .vscode/* !.vscode/extensions.json !.vscode/settings.json +!.vscode/tasks.json .coveralls.yml packages/examples-react/build diff --git a/.prompts/build-examples.prompttemplate b/.prompts/build-examples.prompttemplate new file mode 100644 index 0000000000..34c883430d --- /dev/null +++ b/.prompts/build-examples.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: build-examples +commandDescription: Build the JSON Forms examples application +--- +Run the "Build Examples App" task to build the examples application for JSON Forms. +~{runTask} diff --git a/.prompts/build.prompttemplate b/.prompts/build.prompttemplate new file mode 100644 index 0000000000..c182250921 --- /dev/null +++ b/.prompts/build.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: build +commandDescription: Build the JSON Forms project +--- +Run the "Build" task to compile the entire JSON Forms project. +~{runTask} diff --git a/.prompts/clean.prompttemplate b/.prompts/clean.prompttemplate new file mode 100644 index 0000000000..a27d1a5d91 --- /dev/null +++ b/.prompts/clean.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: clean +commandDescription: Clean the JSON Forms project build artifacts +--- +Run the "Clean" task to remove build artifacts and clean the JSON Forms project. +~{runTask} diff --git a/.prompts/lint-fix.prompttemplate b/.prompts/lint-fix.prompttemplate new file mode 100644 index 0000000000..81e0fc1eaf --- /dev/null +++ b/.prompts/lint-fix.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: lint-fix +commandDescription: Run linting and auto-fix issues in the JSON Forms project +--- +Run the "Lint Fix" task to automatically fix linting issues in the JSON Forms project. +~{runTask} diff --git a/.prompts/lint.prompttemplate b/.prompts/lint.prompttemplate new file mode 100644 index 0000000000..dc4590971c --- /dev/null +++ b/.prompts/lint.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: lint +commandDescription: Run linting checks on the JSON Forms project +--- +Run the "Lint" task to check the code for linting errors in the JSON Forms project. ~{runTask} +~{runTask} diff --git a/.prompts/project-info.prompttemplate b/.prompts/project-info.prompttemplate new file mode 100644 index 0000000000..e9f1df4ff4 --- /dev/null +++ b/.prompts/project-info.prompttemplate @@ -0,0 +1,55 @@ +## JSON Forms Project information + +JSON Forms is a declarative framework for efficiently building form-based web UIs. +These UIs are targeted at entering, modifying and viewing data and are usually embedded within an application. + +Any UI is defined by using two schemata: + - The JSON schema defines the underlying data to be shown in the UI (objects, properties, and their types) + - The UI schema defines how this data is rendered as a form, e.g. the order of controls, their visibility, and the layout. + If no UI schema is given, JSON Forms generates one based on the given JSON schema. + +We put great emphasis on the customizability and extensibility of JSON Forms. + +### Architecture overview + +The JSON Forms mono repository consists of these packages: + - `@jsonforms/core` in `packages/core`: Provides utilities for managing and rendering JSON Schema based forms. + The core package is independent of any UI technology. + - `@jsonforms/react` in `packages/react`, `@jsonforms/angular` in `packages/angular`, `@jsonforms/vue` in `packages/vue`. + These use the core package to provide specialized bindings for React, Angular and Vue, leveraging each respective's state management and rendering systems. + - 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. + 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`. + +### Mono-repo Setup + +- Package Manager: pnpm with lerna for orchestration +- Dependency Management: Each package declares all its dependencies explicitly (no hoisting assumptions). We aim to use the same dependency versions across packages (e.g. for Typescript or Jest) +- Testing: Independent test setup per package. Tests are implemented in separate folder `test` or `tests` within a package. +- Build: Each package has its own build configuration. Rollup is the default tool except if there are other typical tools for the respective technology (e.g. Angular) +- Linting and Formatting: Each package has its own `.eslintrc.js` and `.prettierrc.js` config +- Typescript: Packages extend common base config `tsconfig.base.js` + +### Core principles + +JSON Forms uses a reducer-style approach for its state management. +The form-wide state is manipulated via the reducers in `packages/core/src/reducers`. + +Renderers are registered in a registry, consisting of tester, renderer pairs. +For each UI Schema element to be rendered, all testers are asked for their priority. +The highest priority wins and the respective renderer gets full control over rendering. +The renderer may dispatch back to JSON Forms to render children elements. + +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. +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. + +The binding packages `@jsonforms/react`, `@jsonforms/angular` and `@jsonforms/vue` bind these functionalities to mechanisms of their respective framework. +The renderers then use the bound functionalities and usually do not interact with `@jsonforms/core` directly. + +### Coding Guidelines + +When creating new functions we prefer the arrow style approach + +### Development Guidelines + +The framework is popular, therefore we never break adopters if we don't have to. +Consider this for all changes. diff --git a/.prompts/test.prompttemplate b/.prompts/test.prompttemplate new file mode 100644 index 0000000000..729518b917 --- /dev/null +++ b/.prompts/test.prompttemplate @@ -0,0 +1,7 @@ +--- +isCommand: true +commandName: test +commandDescription: Run tests for the JSON Forms project +--- +Run the "Test" task to execute the test suite for the JSON Forms project. +~{runTask} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000000..ce1a618c03 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,80 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Build", + "type": "shell", + "command": "pnpm", + "args": ["run", "build"], + "group": { + "kind": "build", + "isDefault": true + }, + "problemMatcher": ["$tsc"], + "presentation": { + "reveal": "always", + "panel": "shared" + } + }, + { + "label": "Test", + "type": "shell", + "command": "pnpm", + "args": ["run", "test"], + "group": "test", + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "shared" + } + }, + { + "label": "Lint", + "type": "shell", + "command": "pnpm", + "args": ["run", "lint"], + "group": "none", + "problemMatcher": ["$eslint-stylish"], + "presentation": { + "reveal": "always", + "panel": "shared" + } + }, + { + "label": "Build Examples App", + "type": "shell", + "command": "pnpm", + "args": ["run", "build:examples-app"], + "group": "build", + "problemMatcher": ["$tsc"], + "presentation": { + "reveal": "always", + "panel": "shared" + } + }, + { + "label": "Lint Fix", + "type": "shell", + "command": "pnpm", + "args": ["run", "lint:fix"], + "group": "none", + "problemMatcher": ["$eslint-stylish"], + "presentation": { + "reveal": "always", + "panel": "shared" + } + }, + { + "label": "Clean", + "type": "shell", + "command": "pnpm", + "args": ["run", "clean"], + "group": "none", + "problemMatcher": [], + "presentation": { + "reveal": "always", + "panel": "shared" + } + } + ] +}