Merge remote-tracking branch 'upstream/master' into listReadOnly

eclipsesource · Apr 21, 2023 · 7b595cf · 7b595cf
2 parents 75c6402 + 1e1ccad
commit 7b595cf
Show file tree

Hide file tree

Showing 545 changed files with 21,536 additions and 16,041 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,30 +1,26 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/javascript-node
 {
-	"name": "Node.js",
-	"build": {
-		"dockerfile": "Dockerfile",
-		// Update 'VARIANT' to pick a Node version: 14, 16
-		"args": {
-			"VARIANT": "14"
-		}
-	},
-	// Set *default* container specific settings.json values on container create.
-	// Add the IDs of extensions you want installed when the container is created.
-	"extensions": [
-		"esbenp.prettier-vscode",
-		"ms-vscode.vscode-typescript-tslint-plugin",
-		"vue.volar"
-	],
-	"settings": {
-		"editor.formatOnSave": false,
-		"editor.defaultFormatter": "esbenp.prettier-vscode",
-		"prettier.jsxSingleQuote": true,
-		"prettier.singleQuote": true
-	},
-
-	// Use 'postCreateCommand' to run commands after the container is created.
-	"postCreateCommand": "npm ci && npm run init && npm run build",
-	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
-	"remoteUser": "node"
-}
+  "name": "Node.js",
+  "build": {
+    "dockerfile": "Dockerfile",
+    // Update 'VARIANT' to pick a Node version: 14, 16
+    "args": {
+      "VARIANT": "14"
+    }
+  },
+  // Set *default* container specific settings.json values on container create.
+  // Add the IDs of extensions you want installed when the container is created.
+  "customizations": {
+    "extensions": [
+      "DavidAnson.vscode-markdownlint",
+      "dbaeumer.vscode-eslint",
+      "esbenp.prettier-vscode",
+      "vue.volar"
+    ]
+  },
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "npm ci && npm run init && npm run build",
+  // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "node"
+}
diff --git a/.github/config/changelog.json b/.github/config/changelog.json
@@ -2,7 +2,5 @@
   "sort": "DESC",
   "pr_template": "- [${{LABELS}}] ${{TITLE}} (#${{NUMBER}})",
   "template": "${{UNCATEGORIZED}}",
-  "ignore_labels": [
-    "dependencies"
-  ]
+  "ignore_labels": ["dependencies"]
 }
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -15,29 +15,32 @@ jobs:
           - windows-latest
     name: Run on ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Setup node
-      uses: actions/setup-node@v2
-      with:
-        node-version: 14
-    - name: Build
-      run: |
-        npm ci
-        npm run init
-        npm run build
-        npm run bundle
-    - name: Test
-      if: matrix.os == 'windows-latest'
-      run: |
-        npm run test
-    - name: Test & Coverage
-      if: matrix.os == 'ubuntu-latest'
-      run: |
-        npm run test-cov
-        npm run check-format
-        npm run merge-report && cat coverage/lcov.info
-    - name: Upload Coveralls Report
-      if: success() && matrix.os == 'ubuntu-latest'
-      uses: coverallsapp/github-action@master
-      with:
-        github-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v2
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - name: Build
+        run: |
+          npm ci
+          npm run init
+          npm run build
+          npm run bundle
+      - name: Lint
+        if: matrix.os == 'ubuntu-latest'
+        run: npm run lint
+      - name: Test
+        if: matrix.os == 'windows-latest'
+        run: |
+          npm run test
+      - name: Test & Coverage
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          npm run test-cov
+          npm run check-format
+          npm run merge-report && cat coverage/lcov.info
+      - name: Upload Coveralls Report
+        if: success() && matrix.os == 'ubuntu-latest'
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   release:
-    if: | 
+    if: |
       startsWith(github.ref, 'refs/tags/v') &&
       !contains(github.ref, 'alpha') &&
       !contains(github.ref, 'beta') &&

diff --git a/.prettierrc b/.prettierrc
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,6 @@
+module.exports = {
+  $schema: 'http://json.schemastore.org/prettierrc',
+  singleQuote: true,
+  jsxSingleQuote: true,
+  endOfLine: 'auto',
+};
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,13 +1,12 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
   // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
-
   // List of extensions which should be recommended for users of this workspace.
   "recommendations": [
+    "DavidAnson.vscode-markdownlint",
+    "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
-    "ms-vscode.vscode-typescript-tslint-plugin",
     "ms-vscode-remote.remote-containers"
-
   ],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,6 +1,49 @@
 {
-    "editor.formatOnSave": false,
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue"
+  ],
+  "[javascript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "prettier.jsxSingleQuote": true,
-    "prettier.singleQuote": true
-}
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "[vue]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    }
+  },
+  "search.exclude": {
+    "**/docs": true,
+    "**/node_modules": true,
+    "**/lib": true
+  }
+}
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -24,8 +24,16 @@ interface TesterContext {
   config: any;
 }
 
-type Tester = (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => boolean;
-type RankedTester = (uischema: UISchemaElement, schema: JsonSchema, context: TesterContext) => number;
+type Tester = (
+  uischema: UISchemaElement,
+  schema: JsonSchema,
+  context: TesterContext
+) => boolean;
+type RankedTester = (
+  uischema: UISchemaElement,
+  schema: JsonSchema,
+  context: TesterContext
+) => number;
 ```
 
 This allows the testers to resolve any `$ref` they might encounter in their handed over `schema` by using the context's `rootSchema`.
@@ -50,30 +58,37 @@ To restore the old behavior, you can use `json-schema-ref-parser` or other libra
 ```ts
 import React, { useState } from 'react';
 import { JsonForms } from '@jsonforms/react';
-import { materialCells, materialRenderers } from '@jsonforms/material-renderers';
+import {
+  materialCells,
+  materialRenderers,
+} from '@jsonforms/material-renderers';
 import $RefParser from '@apidevtools/json-schema-ref-parser';
 import JsonRefs from 'json-refs';
 
 import mySchemaWithReferences from 'myschema.json';
 
 const refParserOptions = {
   dereference: {
-    circular: false
-  }
-}
+    circular: false,
+  },
+};
 
 function App() {
   const [data, setData] = useState(initialData);
   const [resolvedSchema, setSchema] = useState();
 
   useEffect(() => {
-    $RefParser.dereference(mySchemaWithReferences).then(res => setSchema(res.$schema));
+    $RefParser
+      .dereference(mySchemaWithReferences)
+      .then((res) => setSchema(res.$schema));
     // or
-    JsonRefs.resolveRefs(mySchemaWithReferences).then(res => setSchema(res.resolved));
-  },[]);
+    JsonRefs.resolveRefs(mySchemaWithReferences).then((res) =>
+      setSchema(res.resolved)
+    );
+  }, []);
 
-  if(resolvedSchema === undefined) {
-    return <div> Loading... </div>
+  if (resolvedSchema === undefined) {
+    return <div> Loading... </div>;
   }
 
   return (
@@ -143,12 +158,12 @@ export const schema = {
   type: 'object',
   properties: {
     name: {
-      type: 'string'
-    }
+      type: 'string',
+    },
   },
-  required: ['name']
+  required: ['name'],
 };
-export const data = {name: 'Send email to Adrian'};
+export const data = { name: 'Send email to Adrian' };
 
 @Component({
   selector: 'app-root',
@@ -160,7 +175,7 @@ export const data = {name: 'Send email to Adrian'};
       [renderers]="renderers"
       (dataChange)="onDataChange($event)"
     ></jsonforms>
-  `
+  `,
 })
 export class AppComponent {
   readonly renderers = angularMaterialRenderers;
@@ -201,15 +216,12 @@ All current Redux functionally can also be achieved with the standalone version.
 Previously the store was initialized like this:
 
 ```ts
-const store = createStore(
-  combineReducers({ jsonforms: jsonformsReducer() }),
-  {
-    jsonforms: {
-      cells: materialCells,
-      renderers: materialRenderers
-    }
-  }
-);
+const store = createStore(combineReducers({ jsonforms: jsonformsReducer() }), {
+  jsonforms: {
+    cells: materialCells,
+    renderers: materialRenderers,
+  },
+});
 store.dispatch(Actions.init(data, schema, uischema));
 return (
   <Provider store={store}>
@@ -250,7 +262,7 @@ Within the standalone version, the renderer can just be provided to the `<JsonFo
 const renderers = [
   ...materialRenderers,
   // register custom renderer
-  { tester: customControlTester, renderer: CustomControl }
+  { tester: customControlTester, renderer: CustomControl },
 ];
 
 const MyApp = () => (
@@ -259,7 +271,6 @@ const MyApp = () => (
     renderers={renderers}
   />
 );
-
 ```
 
 ##### Example 3: Listen to data and validation changes
@@ -286,7 +297,10 @@ If you want to keep using the Redux variant of JSON Forms for now (which is not
 The new imports are available at `@jsonforms/react/lib/redux`, i.e.
 
 ```ts
-import { jsonformsReducer, JsonFormsReduxProvider } from '@jsonforms/react/lib/redux';
+import {
+  jsonformsReducer,
+  JsonFormsReduxProvider,
+} from '@jsonforms/react/lib/redux';
 ```
 
 ## Migrating from JSON Forms 1.x (AngularJS 1.x)
@@ -298,8 +312,8 @@ The complexity of the migration of an existing JSON Forms 1.x application, which
 There are two big changes between JSON Forms 1 and JSON Forms 2 you need to understand when migrating your existing application.
 
 1. JSON Forms 2.x does not rely on any specific UI framework [or library].
-  The `2.0.0` initial release featured renderers based on [React](https://reactjs.org).
-  An [Angular](https://angular.io) based renderer set was released with `2.1.0`.
+   The `2.0.0` initial release featured renderers based on [React](https://reactjs.org).
+   An [Angular](https://angular.io) based renderer set was released with `2.1.0`.
 
 2. Since JSON Forms 2.x maintains its internal state via [redux](https://redux.js.org/), you will need to add it as a dependency to your application.
 
@@ -314,20 +328,20 @@ Instead of:
 
 ```ts
 const uischema = {
-    type: 'Control',
-    scope: {
-        $ref: '#/properties/name'
-    }
-}
+  type: 'Control',
+  scope: {
+    $ref: '#/properties/name',
+  },
+};
 ```
 
 simply write:
 
 ```ts
 const uischema = {
-    type: 'Control',
-    scope: '#/properties/name'
-}
+  type: 'Control',
+  scope: '#/properties/name',
+};
 ```
 
 Otherwise the UI schema remains unchanged and works like in JSON Forms 1.x.