@camunda/element-templates-json-schema 0.6.0 → 0.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.md CHANGED
@@ -1,4 +1,4 @@
1
- # element-templates-json-schema
1
+ # @camunda/element-templates-json-schema
2
2
 
3
3
  [![Build Status](https://img.shields.io/github/workflow/status/camunda/element-templates-json-schema/CI)](https://github.com/camunda/element-templates-json-schema/actions?query=workflow%3ACI)
4
4
 
@@ -8,7 +8,7 @@ JSON Schema for [(Camunda) Element Templates](https://docs.camunda.org/manual/la
8
8
 
9
9
  ## Usage
10
10
 
11
- There exist different ways to consume the [JSON Schema definition](./resources/schema.json). Many tools, like IDEs, support schema validation out of the box. To activate those, simply specify the `$schema` attribute to an element template.
11
+ Set the `$schema` attribute to reference the [JSON Schema definition](./resources/schema.json).
12
12
 
13
13
  ```js
14
14
  {
@@ -26,7 +26,25 @@ You can also use a specific version.
26
26
  "$schema": "https://unpkg.com/@camunda/element-templates-json-schema@0.1.0/resources/schema.json"
27
27
  ```
28
28
 
29
- Additionally, it's possible to use the schema on top of existing validation libraries and tools. Follow the [example](./example) for further instructions.
29
+ ## Build and Run
30
+
31
+ Prepare the project by installing all dependencies:
32
+
33
+ ```sh
34
+ npm install
35
+ ```
36
+
37
+ Bundle [the source schema files](./src) together
38
+
39
+ ```sh
40
+ npm run build
41
+ ```
42
+
43
+ Execute the following command to run the generated schema against the tests
44
+
45
+ ```sh
46
+ npm run test
47
+ ```
30
48
 
31
49
  ## License
32
50
 
package/package.json CHANGED
@@ -1,36 +1,27 @@
1
1
  {
2
2
  "name": "@camunda/element-templates-json-schema",
3
- "version": "0.6.0",
3
+ "version": "0.7.0",
4
4
  "description": "JSON Schema for (Camunda) Element Templates",
5
+ "files": [
6
+ "resources"
7
+ ],
5
8
  "scripts": {
6
- "lint": "eslint .",
7
9
  "test": "mocha -r esm --reporter=spec --recursive test/spec",
8
10
  "dev": "npm run test -- --watch",
9
- "all": "run-s lint test"
11
+ "all": "run-s build test",
12
+ "build": "node ../../tasks/generate-schema.js --input=./src/schema.json --output=./resources/schema.json",
13
+ "prepare": "run-s build"
10
14
  },
11
15
  "repository": {
12
16
  "type": "git",
13
- "url": "git+https://github.com/camunda/element-templates-json-schema.git"
17
+ "url": "git+https://github.com/camunda/element-templates-json-schema.git",
18
+ "directory": "packages/element-templates-json-schema"
14
19
  },
15
20
  "keywords": [
16
21
  "json-schema",
17
22
  "element-templates",
18
23
  "camunda"
19
24
  ],
20
- "author": "Niklas Kiefer <niklas.kiefer@camunda.com (https://github.com/pinussilvestrus)",
21
25
  "license": "MIT",
22
- "bugs": {
23
- "url": "https://github.com/camunda/element-templates-json-schema/issues"
24
- },
25
- "homepage": "https://github.com/camunda/element-templates-json-schema#readme",
26
- "devDependencies": {
27
- "ajv": "^7.2.3",
28
- "ajv-errors": "^2.0.1",
29
- "chai": "^4.3.4",
30
- "eslint": "^7.22.0",
31
- "eslint-plugin-bpmn-io": "^0.13.0",
32
- "esm": "^3.2.25",
33
- "mocha": "^8.3.2",
34
- "npm-run-all": "^4.1.5"
35
- }
26
+ "gitHead": "10f6fcffa13669ff52d15934e1c189acacf1fd8a"
36
27
  }