bpmnlint - npm Package Compare versions

Comparing version 4.1.0 to 5.0.0

CHANGELOG.md

@@ -9,2 +9,6 @@ # Changelog
 
+## 5.0.0
+
+* `FEAT`: don't expose utils to rules; use `bpmnlint-utils` instead
+
 ## 4.1.0
@@ -20,3 +24,3 @@
 * `FEAT`: don't resolve disabled rules ([`6c45f3f9`](https://github.com/bpmn-io/bpmnlint/commit/6c45f3f952a412dda05deb5c57861a1c76af23bb))
-* `CHORE`: unify names of built-in rules
+* `CHORE`: unify messages of built-in rules
 * `CHORE`: adopt cli output to eslint styling
@@ -44,3 +48,3 @@
 
-## 3.0.0bpmnlinter
+## 3.0.0
 
@@ -47,0 +51,0 @@ #### Breaking Changes

lib/linter.js

 const testRule = require('./test-rule');
-const utils = require('./utils');
 
@@ -102,3 +101,3 @@ const categoryMap = {
 
-    const rule = this.cachedRules[id] = ruleFactory(utils);
+    const rule = this.cachedRules[id] = ruleFactory();
 
@@ -105,0 +104,0 @@ return rule;

package.json

 {
   "name": "bpmnlint",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "main": "lib/index.js",
@@ -36,2 +36,3 @@ "keywords": [
     "bpmn-moddle": "^4.0.0",
+    "bpmnlint-utils": "^1.0.1",
     "chalk": "^2.4.1",
@@ -38,0 +39,0 @@ "cli-table": "^0.3.1",

rules/conditional-flows.js

@@ -1,7 +0,8 @@
-// verify that sequence flows outgoing from a
-// conditional forking gateway or activity are
-// either default flows _or_ have a condition attached
+/**
+ * A rule that checks that sequence flows outgoing from a
+ * conditional forking gateway or activity are
+ * either default flows _or_ have a condition attached
+ */
+module.exports = function() {
 
-module.exports = function(utils) {
-
   function check(node, reporter) {
@@ -8,0 +9,0 @@

rules/end-event-required.js

@@ -0,10 +1,12 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+
 /**
- * Rule is to impose the presence of an end event in the process.
+ * A rule that checks the presence of an end event per scope.
  */
-
 module.exports = function(utils) {
 
-  const is = utils.is;
-  const isAny = utils.isAny;
-
   function hasEndEvent(node) {
@@ -11,0 +13,0 @@ const flowElements = node.flowElements || [];

rules/event-sub-process-typed-start-event.js

@@ -1,8 +0,11 @@
-// verify that start events inside an event sub-process
-// are typed.
+const {
+  is
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
+/**
+ * A rule that checks that start events inside an event sub-process
+ * are typed.
+ */
+module.exports = function() {
 
-  const is = utils.is;
-
   function check(node, reporter) {
@@ -9,0 +12,0 @@

rules/fake-join.js

@@ -1,11 +0,14 @@
-// verify that no fake join is modeled by attempting
-// to give a task or event join semantics.
-//
-// users should model a parallel joining gateway
-// to achieve the desired behavior.
+const {
+  isAny
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
+/**
+ * A rule that checks that no fake join is modeled by attempting
+ * to give a task or event join semantics.
+ *
+ * Users should model a parallel joining gateway
+ * to achieve the desired behavior.
+ */
+module.exports = function() {
 
-  const isAny = utils.isAny;
-
   function check(node, reporter) {
@@ -12,0 +15,0 @@

rules/helper.js

@@ -0,1 +1,4 @@
+const {
+  is
+} = require('bpmnlint-utils');
 
@@ -11,6 +14,4 @@ /**
 
-  return function(utils) {
+  return function() {
 
-    const is = utils.is;
-
     function check(node, reporter) {
@@ -17,0 +18,0 @@

rules/label-required.js

@@ -0,10 +1,12 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+
 /**
- * Rule is to impose the presence of a label for every flow node.
+ * A rule that checks the presence of a label.
  */
+module.exports = function() {
 
-module.exports = function(utils) {
-
-  const is = utils.is;
-  const isAny = utils.isAny;
-
   function check(node, reporter) {
@@ -11,0 +13,0 @@

rules/no-disconnected.js

@@ -1,8 +0,12 @@
-// verify that there exists no disconnected
-// flow elements, i.e. elements without incoming
-// _or_ outgoing sequence flows
+const {
+  isAny
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
 
-  const isAny = utils.isAny;
+/**
+ * A rule that verifies that there exists no disconnected
+ * flow elements, i.e. elements without incoming
+ * _or_ outgoing sequence flows
+ */
+module.exports = function() {
 
@@ -9,0 +13,0 @@ function check(node, reporter) {

rules/no-gateway-join-fork.js

@@ -1,7 +0,11 @@
-// verify that a gateway does not fork and join
-// at the same time.
+const {
+  is
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
 
-  const is = utils.is;
+/**
+ * A rule that checks, whether a gateway forks and joins
+ * at the same time.
+ */
+module.exports = function() {
 
@@ -8,0 +12,0 @@ function check(node, reporter) {

rules/no-implicit-split.js

@@ -1,10 +0,14 @@
-// verify that no implicit split is modeled
-// starting from a task.
-//
-// users should model the parallel splitting gateway
-// explicitly instead.
+const {
+  isAny
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
 
-  const isAny = utils.isAny;
+/**
+ * A rule that checks that no implicit split is modeled
+ * starting from a task.
+ *
+ * users should model the parallel splitting gateway
+ * explicitly instead.
+ */
+module.exports = function() {
 
@@ -11,0 +15,0 @@ function check(node, reporter) {

rules/single-blank-start-event.js

@@ -1,8 +0,11 @@
-// verify that there exists only a single blank
-// start event per scope
+const {
+  is
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
+/**
+ * A rule that checks whether not more than one blank start event
+ * exists per scope.
+ */
+module.exports = function() {
 
-  const is = utils.is;
-
   function check(node, reporter) {
@@ -9,0 +12,0 @@

rules/single-event-definition.js

@@ -1,7 +0,10 @@
-// verify that an event contains maximum one
-// event definition
+const {
+  is
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
 
-  const is = utils.is;
+/**
+ * A rule that verifies that an event contains maximum one event definition.
+ */
+module.exports = function() {
 
@@ -8,0 +11,0 @@ function check(node, reporter) {

rules/start-event-required.js

@@ -0,10 +1,12 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+
 /**
- * Rule is to impose the presence of a start event in the process.
+ * A rule that checks for the presence of a start event per scope.
  */
+module.exports = function() {
 
-module.exports = function(utils) {
-
-  const is = utils.is;
-  const isAny = utils.isAny;
-
   function hasStartEvent(node) {
@@ -11,0 +13,0 @@ const flowElements = node.flowElements || [];

rules/sub-process-blank-start-event.js

@@ -1,7 +0,11 @@
-// verify that start events inside a normal sub-process
-// are blank (do not have an event definition).
+const {
+  is
+} = require('bpmnlint-utils');
 
-module.exports = function(utils) {
 
-  const is = utils.is;
+/**
+ * A rule that checks that start events inside a normal sub-processes
+ * are blank (do not have an event definition).
+ */
+module.exports = function() {
 
@@ -8,0 +12,0 @@ function check(node, reporter) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

1196

increased by0.42%

Worsened metrics

Total package byte prevSize

38137

decreased by-0.8%

Dependency count

6

increased by20%

Number of package files

31

decreased by-3.12%

Dependency changes

• + Addedbpmnlint-utils@^1.0.1

• + Addedbpmnlint-utils@1.1.1(transitive)