chore: make diagram options optional

* options are optional * core module is added by default
bpmn-io · Mar 1, 2023 · 2ba1a7f · 2ba1a7f
1 parent 6519fd4
commit 2ba1a7f
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 37 deletions.
diff --git a/lib/Diagram.d.ts b/lib/Diagram.d.ts
@@ -54,7 +54,7 @@ export type DiagramOptions = {
  * @param injector An (optional) injector to bootstrap the diagram with.
  */
 export default class Diagram {
-  constructor(options: DiagramOptions, injector?: Injector);
+  constructor(options?: DiagramOptions, injector?: Injector);
 
   /**
    * Resolves a diagram service.

diff --git a/lib/Diagram.js b/lib/Diagram.js
@@ -28,7 +28,7 @@ function bootstrap(modules) {
 /**
  * Creates an injector from passed options.
  *
- * @param {DiagramOptions} options
+ * @param {DiagramOptions} [options]
  *
  * @return {Injector}
  */
@@ -90,7 +90,7 @@ function createInjector(options) {
  *
  * // 'shape ... was added to the diagram' logged to console
  *
- * @param {DiagramOptions} options
+ * @param {DiagramOptions} [options]
  * @param {ModuleDeclaration[]} [options.modules] External modules to instantiate with the diagram.
  * @param {Injector} [injector] An (optional) injector to bootstrap the diagram with.
  */

diff --git a/lib/Diagram.spec.ts b/lib/Diagram.spec.ts
@@ -8,7 +8,9 @@ import EventBus from './core/EventBus';
 import ModelingModule from './features/modeling';
 import Modeling from './features/modeling/Modeling';
 
-const diagram = new Diagram({
+let diagram = new Diagram();
+
+diagram = new Diagram({
   modules: [
     CoreModule,
     CommandModule,

diff --git a/lib/core/Canvas.spec.ts b/lib/core/Canvas.spec.ts
@@ -1,14 +1,9 @@
 import Diagram from '../Diagram';
 
-import CoreModule from '.';
 import Canvas from './Canvas';
 import ElementFactory from './ElementFactory';
 
-const diagram = new Diagram({
-  modules: [
-    CoreModule
-  ]
-});
+const diagram = new Diagram();
 
 const shapeLike = {
   id: 'shapeLike',

diff --git a/lib/core/ElementFactory.spec.ts b/lib/core/ElementFactory.spec.ts
@@ -1,13 +1,8 @@
 import Diagram from '../Diagram';
 
-import CoreModule from '.';
 import ElementFactory from './ElementFactory';
 
-const diagram = new Diagram({
-  modules: [
-    CoreModule
-  ]
-});
+const diagram = new Diagram();
 
 const elementFactory = diagram.get<ElementFactory>('elementFactory');
 

diff --git a/lib/core/ElementRegistry.spec.ts b/lib/core/ElementRegistry.spec.ts
@@ -1,15 +1,10 @@
 import Diagram from '../Diagram';
 
-import CoreModule from '.';
 import ElementFactory from './ElementFactory';
 import ElementRegistry from './ElementRegistry';
 import GraphicsFactory from './GraphicsFactory';
 
-const diagram = new Diagram({
-  modules: [
-    CoreModule
-  ]
-});
+const diagram = new Diagram();
 
 const elementFactory = diagram.get<ElementFactory>('elementFactory'),
       elementRegistry = diagram.get<ElementRegistry>('elementRegistry'),

diff --git a/lib/core/EventBus.spec.ts b/lib/core/EventBus.spec.ts
@@ -1,13 +1,8 @@
 import Diagram from '../Diagram';
 
-import CoreModule from '.';
 import EventBus, { Event } from './EventBus';
 
-const diagram = new Diagram({
-  modules: [
-    CoreModule
-  ]
-});
+const diagram = new Diagram();
 
 const eventBus = diagram.get<EventBus>('eventBus');
 

diff --git a/lib/core/GraphicsFactory.spec.ts b/lib/core/GraphicsFactory.spec.ts
@@ -1,14 +1,9 @@
 import Diagram from '../Diagram';
 
-import CoreModule from '.';
 import ElementFactory from './ElementFactory';
 import GraphicsFactory from './GraphicsFactory';
 
-const diagram = new Diagram({
-  modules: [
-    CoreModule
-  ]
-});
+const diagram = new Diagram();
 
 const elementFactory = diagram.get<ElementFactory>('elementFactory'),
       graphicsFactory = diagram.get<GraphicsFactory>('graphicsFactory');

diff --git a/lib/draw/BaseRenderer.spec.ts b/lib/draw/BaseRenderer.spec.ts
@@ -2,7 +2,6 @@ import { Base, Connection, Shape } from '../model';
 
 import Diagram from '../Diagram';
 
-import CoreModule from '../core';
 import ElementFactory from '../core/ElementFactory';
 import GraphicsFactory from '../core/GraphicsFactory';
 
@@ -32,7 +31,6 @@ class CustomRenderer extends BaseRenderer {
 
 const diagram = new Diagram({
   modules: [
-    CoreModule,
     {
       __init__: [ 'customRenderer' ],
       customRenderer: [ 'type', CustomRenderer ]

diff --git a/lib/features/overlays/Overlays.spec.ts b/lib/features/overlays/Overlays.spec.ts
@@ -1,8 +1,8 @@
 import Diagram from '../../Diagram';
 
-import OverlaysModule from '.';
 import ElementFactory from '../../core/ElementFactory';
 
+import OverlaysModule from '.';
 import Overlays, { OverlayAttrs } from './Overlays';
 
 const diagram = new Diagram({