@camunda/linting 3.27.2 → 3.29.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/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2022-present Camunda Services GmbH
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2022-present Camunda Services GmbH
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,75 +1,75 @@
1
- # @camunda/linting
2
-
3
- [![CI](https://github.com/camunda/linting/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/linting/actions/workflows/CI.yml)
4
-
5
- The BPMN linter used by the Camunda Desktop and Web Modeler. Batteries included. 🔋
6
-
7
- ## Features
8
-
9
- * bundles [bpmnlint](https://github.com/bpmn-io/bpmnlint) and [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat/)
10
- * configures linter based on `modeler:executionPlatform` and `modeler:executionPlatformVersion`
11
- * creates error messages to be shown in desktop and web modeler
12
- * creates errors to be shown in properties panel
13
- * creates error overlays to be shown on canvas
14
-
15
- ## Usage
16
-
17
- ```javascript
18
- import Modeler from 'bpmn-js/lib/Modeler';
19
-
20
- import { Linter } from '@camunda/linting';
21
-
22
- import lintingModule from '@camunda/linting/modeler';
23
-
24
- import '@camunda/linting/assets/linting.css';
25
-
26
- const modeler = new Modeler({
27
- additionalModules: [
28
- lintingModule
29
- ]
30
- });
31
-
32
- // configure to be used with desktop or web modeler
33
- const linter = new Linter({
34
- modeler: 'web', // `desktop` or `web` modeler, defaults to `desktop`
35
- type: 'cloud' // `cloud` or `platform` diagrams, defaults to `cloud`
36
- });
37
-
38
- // lint by passing definitions
39
- const reports = await linter.lint(definitions);
40
-
41
- // or passing XML
42
- const reports = await linter.lint(xml);
43
-
44
- ...
45
-
46
- // update errors on canvas and in properties panel (requires bpmn-js-properties-panel >= 1.3.0)
47
- modeler.get('linting').setErrors(reports);
48
-
49
- // show error by selecting element and properties panel entry
50
- modeler.get('linting').showError(report);
51
-
52
- // activate and deactivate errors on canvas
53
- modeler.get('linting').activate();
54
- modeler.get('linting').deactivate();
55
- ```
56
-
57
- ## Development
58
-
59
- ```sh
60
- # install
61
- npm i
62
-
63
- # run tests
64
- npm t
65
-
66
- # run tests in watch mode
67
- npm run test:watch
68
-
69
- # run example
70
- npm start
71
- ```
72
-
73
- ## License
74
-
75
- MIT
1
+ # @camunda/linting
2
+
3
+ [![CI](https://github.com/camunda/linting/actions/workflows/CI.yml/badge.svg)](https://github.com/camunda/linting/actions/workflows/CI.yml)
4
+
5
+ The BPMN linter used by the Camunda Desktop and Web Modeler. Batteries included. 🔋
6
+
7
+ ## Features
8
+
9
+ * bundles [bpmnlint](https://github.com/bpmn-io/bpmnlint) and [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat/)
10
+ * configures linter based on `modeler:executionPlatform` and `modeler:executionPlatformVersion`
11
+ * creates error messages to be shown in desktop and web modeler
12
+ * creates errors to be shown in properties panel
13
+ * creates error overlays to be shown on canvas
14
+
15
+ ## Usage
16
+
17
+ ```javascript
18
+ import Modeler from 'bpmn-js/lib/Modeler';
19
+
20
+ import { Linter } from '@camunda/linting';
21
+
22
+ import lintingModule from '@camunda/linting/modeler';
23
+
24
+ import '@camunda/linting/assets/linting.css';
25
+
26
+ const modeler = new Modeler({
27
+ additionalModules: [
28
+ lintingModule
29
+ ]
30
+ });
31
+
32
+ // configure to be used with desktop or web modeler
33
+ const linter = new Linter({
34
+ modeler: 'web', // `desktop` or `web` modeler, defaults to `desktop`
35
+ type: 'cloud' // `cloud` or `platform` diagrams, defaults to `cloud`
36
+ });
37
+
38
+ // lint by passing definitions
39
+ const reports = await linter.lint(definitions);
40
+
41
+ // or passing XML
42
+ const reports = await linter.lint(xml);
43
+
44
+ ...
45
+
46
+ // update errors on canvas and in properties panel (requires bpmn-js-properties-panel >= 1.3.0)
47
+ modeler.get('linting').setErrors(reports);
48
+
49
+ // show error by selecting element and properties panel entry
50
+ modeler.get('linting').showError(report);
51
+
52
+ // activate and deactivate errors on canvas
53
+ modeler.get('linting').activate();
54
+ modeler.get('linting').deactivate();
55
+ ```
56
+
57
+ ## Development
58
+
59
+ ```sh
60
+ # install
61
+ npm i
62
+
63
+ # run tests
64
+ npm t
65
+
66
+ # run tests in watch mode
67
+ npm run test:watch
68
+
69
+ # run example
70
+ npm start
71
+ ```
72
+
73
+ ## License
74
+
75
+ MIT
@@ -1,38 +1,38 @@
1
- :root {
2
- --cl-color-white: hsl(0, 0%, 100%);
3
-
4
- --cl-color-info: #0f62fe;
5
- --cl-color-warning: #ff832b;
6
- --cl-color-error: #da1e26;
7
- --cl-color-success: #52b415;
8
- }
9
-
10
- .cl-icon, .cl-icon * {
11
- box-sizing: border-box;
12
- }
13
-
14
- .cl-icon {
15
- --icon-color: white;
16
- --icon-bg-color: #333;
17
- background: var(--icon-bg-color);
18
- color: var(--icon-color);
19
- border-radius: 100%;
20
- height: 20px;
21
- width: 20px;
22
- border: solid 4px var(--icon-bg-color);
23
- display: flex;
24
- align-items: center;
25
- justify-content: center;
26
- }
27
-
28
- .cl-icon-error {
29
- --icon-bg-color: var(--cl-color-error);
30
- }
31
-
32
- .cl-icon-warn {
33
- --icon-bg-color: var(--cl-color-warning);
34
- }
35
-
36
- .cl-icon-info {
37
- --icon-bg-color: var(--cl-color-info);
1
+ :root {
2
+ --cl-color-white: hsl(0, 0%, 100%);
3
+
4
+ --cl-color-info: #0f62fe;
5
+ --cl-color-warning: #ff832b;
6
+ --cl-color-error: #da1e26;
7
+ --cl-color-success: #52b415;
8
+ }
9
+
10
+ .cl-icon, .cl-icon * {
11
+ box-sizing: border-box;
12
+ }
13
+
14
+ .cl-icon {
15
+ --icon-color: white;
16
+ --icon-bg-color: #333;
17
+ background: var(--icon-bg-color);
18
+ color: var(--icon-color);
19
+ border-radius: 100%;
20
+ height: 20px;
21
+ width: 20px;
22
+ border: solid 4px var(--icon-bg-color);
23
+ display: flex;
24
+ align-items: center;
25
+ justify-content: center;
26
+ }
27
+
28
+ .cl-icon-error {
29
+ --icon-bg-color: var(--cl-color-error);
30
+ }
31
+
32
+ .cl-icon-warn {
33
+ --icon-bg-color: var(--cl-color-warning);
34
+ }
35
+
36
+ .cl-icon-info {
37
+ --icon-bg-color: var(--cl-color-info);
38
38
  }
package/lib/Resolver.js CHANGED
@@ -1,31 +1,31 @@
1
- export default class NestedResolver {
2
- constructor(resolvers) {
3
- this.resolvers = resolvers.slice().reverse();
4
- }
5
-
6
- resolveRule(pkg, ruleName) {
7
- for (const resolver of this.resolvers) {
8
- try {
9
- return resolver.resolveRule(pkg, ruleName);
10
- } catch (err) {
11
-
12
- // ignore
13
- }
14
- }
15
-
16
- throw new Error(`unknown rule <${ pkg }/${ ruleName }>`);
17
- }
18
-
19
- resolveConfig(pkg, configName) {
20
- for (const resolver of this.resolvers) {
21
- try {
22
- return resolver.resolveConfig(pkg, configName);
23
- } catch (err) {
24
-
25
- // ignore
26
- }
27
- }
28
-
29
- throw new Error(`unknown config <${ pkg }/${ configName }>`);
30
- }
31
- }
1
+ export default class NestedResolver {
2
+ constructor(resolvers) {
3
+ this.resolvers = resolvers.slice().reverse();
4
+ }
5
+
6
+ resolveRule(pkg, ruleName) {
7
+ for (const resolver of this.resolvers) {
8
+ try {
9
+ return resolver.resolveRule(pkg, ruleName);
10
+ } catch (err) {
11
+
12
+ // ignore
13
+ }
14
+ }
15
+
16
+ throw new Error(`unknown rule <${ pkg }/${ ruleName }>`);
17
+ }
18
+
19
+ resolveConfig(pkg, configName) {
20
+ for (const resolver of this.resolvers) {
21
+ try {
22
+ return resolver.resolveConfig(pkg, configName);
23
+ } catch (err) {
24
+
25
+ // ignore
26
+ }
27
+ }
28
+
29
+ throw new Error(`unknown config <${ pkg }/${ configName }>`);
30
+ }
31
+ }
@@ -58,6 +58,7 @@ const rules = {
58
58
  "camunda-compat/no-propagate-all-parent-variables": "error",
59
59
  "camunda-compat/no-signal-event-sub-process": "error",
60
60
  "camunda-compat/no-task-schedule": "error",
61
+ "camunda-compat/no-task-listeners": "error",
61
62
  "camunda-compat/no-template": "error",
62
63
  "camunda-compat/no-version-tag": "error",
63
64
  "camunda-compat/no-zeebe-properties": "error",
@@ -68,12 +69,14 @@ const rules = {
68
69
  "camunda-compat/signal-reference": "error",
69
70
  "camunda-compat/start-event-form": "error",
70
71
  "camunda-compat/subscription": "error",
72
+ "camunda-compat/task-listener": "error",
71
73
  "camunda-compat/task-schedule": "error",
72
74
  "camunda-compat/timer": "error",
73
75
  "camunda-compat/user-task-definition": "warn",
74
76
  "camunda-compat/user-task-form": "error",
75
77
  "camunda-compat/version-tag": "error",
76
- "camunda-compat/wait-for-completion": "error"
78
+ "camunda-compat/wait-for-completion": "error",
79
+ "camunda-compat/zeebe-user-task": "error"
77
80
  };
78
81
 
79
82
  const config = {
@@ -205,66 +208,78 @@ import rule_28 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-task-
205
208
 
206
209
  cache['bpmnlint-plugin-camunda-compat/no-task-schedule'] = rule_28;
207
210
 
208
- import rule_29 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-template';
211
+ import rule_29 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-task-listeners';
209
212
 
210
- cache['bpmnlint-plugin-camunda-compat/no-template'] = rule_29;
213
+ cache['bpmnlint-plugin-camunda-compat/no-task-listeners'] = rule_29;
211
214
 
212
- import rule_30 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-version-tag';
215
+ import rule_30 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-template';
213
216
 
214
- cache['bpmnlint-plugin-camunda-compat/no-version-tag'] = rule_30;
217
+ cache['bpmnlint-plugin-camunda-compat/no-template'] = rule_30;
215
218
 
216
- import rule_31 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe-properties';
219
+ import rule_31 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-version-tag';
217
220
 
218
- cache['bpmnlint-plugin-camunda-compat/no-zeebe-properties'] = rule_31;
221
+ cache['bpmnlint-plugin-camunda-compat/no-version-tag'] = rule_31;
219
222
 
220
- import rule_32 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe-user-task';
223
+ import rule_32 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe-properties';
221
224
 
222
- cache['bpmnlint-plugin-camunda-compat/no-zeebe-user-task'] = rule_32;
225
+ cache['bpmnlint-plugin-camunda-compat/no-zeebe-properties'] = rule_32;
223
226
 
224
- import rule_33 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/priority-definition';
227
+ import rule_33 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/no-zeebe-user-task';
225
228
 
226
- cache['bpmnlint-plugin-camunda-compat/priority-definition'] = rule_33;
229
+ cache['bpmnlint-plugin-camunda-compat/no-zeebe-user-task'] = rule_33;
227
230
 
228
- import rule_34 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/secrets';
231
+ import rule_34 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/priority-definition';
229
232
 
230
- cache['bpmnlint-plugin-camunda-compat/secrets'] = rule_34;
233
+ cache['bpmnlint-plugin-camunda-compat/priority-definition'] = rule_34;
231
234
 
232
- import rule_35 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/sequence-flow-condition';
235
+ import rule_35 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/secrets';
233
236
 
234
- cache['bpmnlint-plugin-camunda-compat/sequence-flow-condition'] = rule_35;
237
+ cache['bpmnlint-plugin-camunda-compat/secrets'] = rule_35;
235
238
 
236
- import rule_36 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/signal-reference';
239
+ import rule_36 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/sequence-flow-condition';
237
240
 
238
- cache['bpmnlint-plugin-camunda-compat/signal-reference'] = rule_36;
241
+ cache['bpmnlint-plugin-camunda-compat/sequence-flow-condition'] = rule_36;
239
242
 
240
- import rule_37 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-event-form';
243
+ import rule_37 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/signal-reference';
241
244
 
242
- cache['bpmnlint-plugin-camunda-compat/start-event-form'] = rule_37;
245
+ cache['bpmnlint-plugin-camunda-compat/signal-reference'] = rule_37;
243
246
 
244
- import rule_38 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/subscription';
247
+ import rule_38 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/start-event-form';
245
248
 
246
- cache['bpmnlint-plugin-camunda-compat/subscription'] = rule_38;
249
+ cache['bpmnlint-plugin-camunda-compat/start-event-form'] = rule_38;
247
250
 
248
- import rule_39 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/task-schedule';
251
+ import rule_39 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/subscription';
249
252
 
250
- cache['bpmnlint-plugin-camunda-compat/task-schedule'] = rule_39;
253
+ cache['bpmnlint-plugin-camunda-compat/subscription'] = rule_39;
251
254
 
252
- import rule_40 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/timer';
255
+ import rule_40 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/task-listener';
253
256
 
254
- cache['bpmnlint-plugin-camunda-compat/timer'] = rule_40;
257
+ cache['bpmnlint-plugin-camunda-compat/task-listener'] = rule_40;
255
258
 
256
- import rule_41 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-definition';
259
+ import rule_41 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/task-schedule';
257
260
 
258
- cache['bpmnlint-plugin-camunda-compat/user-task-definition'] = rule_41;
261
+ cache['bpmnlint-plugin-camunda-compat/task-schedule'] = rule_41;
259
262
 
260
- import rule_42 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-form';
263
+ import rule_42 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/timer';
261
264
 
262
- cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_42;
265
+ cache['bpmnlint-plugin-camunda-compat/timer'] = rule_42;
263
266
 
264
- import rule_43 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/version-tag';
267
+ import rule_43 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-definition';
265
268
 
266
- cache['bpmnlint-plugin-camunda-compat/version-tag'] = rule_43;
269
+ cache['bpmnlint-plugin-camunda-compat/user-task-definition'] = rule_43;
267
270
 
268
- import rule_44 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion';
271
+ import rule_44 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/user-task-form';
269
272
 
270
- cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_44;
273
+ cache['bpmnlint-plugin-camunda-compat/user-task-form'] = rule_44;
274
+
275
+ import rule_45 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/version-tag';
276
+
277
+ cache['bpmnlint-plugin-camunda-compat/version-tag'] = rule_45;
278
+
279
+ import rule_46 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/wait-for-completion';
280
+
281
+ cache['bpmnlint-plugin-camunda-compat/wait-for-completion'] = rule_46;
282
+
283
+ import rule_47 from 'bpmnlint-plugin-camunda-compat/rules/camunda-cloud/zeebe-user-task';
284
+
285
+ cache['bpmnlint-plugin-camunda-compat/zeebe-user-task'] = rule_47;