-
Notifications
You must be signed in to change notification settings - Fork 418
dev: add project information for Theia AI #2470
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
sdirix
wants to merge
5
commits into
master
Choose a base branch
from
add-project-info-prompttemplate
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
ea3d36e
dev: add project information for Theia AI
sdirix 05fb230
Apply suggestions from code review
lucas-koehler 40b47e6
dev: Add VSCode tasks for common dev commands
lucas-koehler 3a818b1
dev: Add Theia AI slash commands for common dev tasks
lucas-koehler e0cbfc3
dev: Add mono-repo information to project info
lucas-koehler File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| { | ||
|
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Basic tasks which are just executing npm scripts are already automatically derived in Theia and VS code from the |
||
| "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" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The slash commands are meant to model use cases, so we should not have a separate command for the LLM to just execute a single task, this would probably be typed almost as fast manually by the user.
Instead it should cover a workflow, similar like this (untested):
This is just a minimal example. The commands could be more detailed too, for example instructing the LLM to find an example in which an issue can be reproduced. Building and starting the example application, using the App-Tester agent to interact with the examples app to verify the issue is reproducible and/or can be fixed. Instructing to commit the changes or interacting with GH to retrieve information instead of having to paste it manually.
The idea is to instruct the agent with a common development/process loop so that we don't need to repeat it every time when working on a new feature, reproducing a bug, fixing a bug etc.
See here for a more complex example in Theia AI: https://github.com/eclipse-theia/theia/pull/16704/changes#diff-13e142c30c0be119266e6577fe8c5561279d274c3ffd4888ff930487cecb6f01R46