process-analytics · csouchet · Sep 20, 2023 · Sep 19, 2023 · Sep 19, 2023 · Sep 19, 2023
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -40,6 +40,7 @@ module.exports = {
         },
       },
     ],
+    'unicorn/prevent-abbreviations': 'error',
     'import/newline-after-import': ['error', { count: 1 }],
     'import/first': 'error',
     'import/order': [

diff --git a/.github/workflows/generate-documentation.yml b/.github/workflows/generate-documentation.yml
@@ -9,7 +9,7 @@ on:
       - '.github/actions/build-setup/**/*'
       - '.github/workflows/generate-documentation.yml'
       - 'docs/users/**'
-      - 'scripts/docs.mjs'
+      - 'scripts/generate-users-documentation.mjs'
       - 'src/**'
       - '.nvmrc'
       - 'package.json'
@@ -25,7 +25,7 @@ on:
       - '.github/actions/custom-surge-preview/**/*'
       - '.github/workflows/generate-documentation.yml'
       - 'docs/users/**'
-      - 'scripts/docs.mjs'
+      - 'scripts/generate-users-documentation.mjs'
       - 'src/**'
       - '.nvmrc'
       - 'package.json'

diff --git a/dev/public/lib-integration.html → dev/public/library-integration.html b/dev/public/lib-integration.html → dev/public/library-integration.html
@@ -4,7 +4,7 @@
   <meta charset="UTF-8">
   <title>bpmn-visualization - Library Integration</title>
   <link rel="icon" type="image/svg+xml" href="./static/img/favicon.svg">
-  <script src="../ts/pages/lib-integration.ts" type="module"></script>
+  <script src="../ts/pages/library-integration.ts" type="module"></script>
 </head>
 <body>
   <div id="bpmn-container-custom"></div>

diff --git a/dev/ts/component/DropFileUserInterface.ts b/dev/ts/component/DropFileUserInterface.ts
@@ -48,9 +48,9 @@ export class DropFileUserInterface {
     this.addEventsOnDocument(this.outerContainerId, this.containerToFade);
   }
 
-  private preventDefaults(e: Event): void {
-    e.preventDefault();
-    e.stopPropagation();
+  private preventDefaults(event: Event): void {
+    event.preventDefault();
+    event.stopPropagation();
   }
 
   private preventDefaultsOnEvents(events: string[], container: Element | Window): void {
@@ -152,8 +152,8 @@ export class DropFileUserInterface {
         const dt = event.dataTransfer;
         const files = dt.files;
         dropCallback(files[0]);
-      } catch (e) {
-        const errorMessage = e instanceof Error ? e.message : String(e);
+      } catch (error) {
+        const errorMessage = error instanceof Error ? error.message : String(error);
         logErrorAndOpenAlert(errorMessage);
       } finally {
         isDocument ? (this as Document).querySelector('#' + outerContainerId).classList.remove('dragging') : (this as HTMLElement).classList.remove('dragging');

diff --git a/dev/ts/component/SvgExporter.ts b/dev/ts/component/SvgExporter.ts
@@ -64,8 +64,8 @@ ${svgAsString}
     const viewScale = this.graph.view.scale;
 
     // Prepares SVG document that holds the output
-    const svgDoc = mxUtils.createXmlDocument();
-    const root = svgDoc.createElementNS(mxConstants.NS_SVG, 'svg');
+    const svgDocument = mxUtils.createXmlDocument();
+    const root = svgDocument.createElementNS(mxConstants.NS_SVG, 'svg');
 
     const s = scale / viewScale;
     const w = Math.max(1, Math.ceil(bounds.width * s) + 2 * border);
@@ -75,9 +75,9 @@ ${svgAsString}
     root.setAttribute('width', w + 'px');
     root.setAttribute('height', h + 'px');
     root.setAttribute('viewBox', (crisp ? '-0.5 -0.5' : '0 0') + ' ' + w + ' ' + h);
-    svgDoc.appendChild(root);
+    svgDocument.appendChild(root);
 
-    const group = svgDoc.createElementNS(mxConstants.NS_SVG, 'g');
+    const group = svgDocument.createElementNS(mxConstants.NS_SVG, 'g');
     root.appendChild(group);
 
     const svgCanvas = this.createSvgCanvas(group);
@@ -98,7 +98,7 @@ ${svgAsString}
     imgExport.includeOverlays = true;
 
     imgExport.drawState(this.graph.getView().getState(this.graph.model.root), svgCanvas);
-    return svgDoc;
+    return svgDocument;
   }
 
   createSvgCanvas(node: Element): mxSvgCanvas2DType {
@@ -123,7 +123,7 @@ class CanvasForExport extends mxSvgCanvas2D {
     y: number,
     w: number,
     h: number,
-    str: string,
+    content: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     align: string,
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -139,51 +139,51 @@ class CanvasForExport extends mxSvgCanvas2D {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     rotation: number,
   ): string {
-    return this.computeTruncatedText(str, w);
+    return this.computeTruncatedText(content, w);
   }
 
   override plainText(
     x: number,
     y: number,
     w: number,
     h: number,
-    str: string,
+    content: string,
     align: string,
     valign: string,
     wrap: string,
     overflow: string,
     clip: string,
     rotation: number,
-    dir: string,
+    direction: string,
   ): void {
-    str = this.computeTruncatedText(str, w);
-    super.plainText(x, y, w, h, str, align, valign, wrap, overflow, clip, rotation, dir);
+    content = this.computeTruncatedText(content, w);
+    super.plainText(x, y, w, h, content, align, valign, wrap, overflow, clip, rotation, direction);
   }
 
-  private computeTruncatedText(str: string, w: number): string {
+  private computeTruncatedText(content: string, w: number): string {
     // Assumes a max character width of 0.5em
-    if (str == null || this.state.fontSize <= 0) {
+    if (content == null || this.state.fontSize <= 0) {
       return '';
     }
 
     try {
-      this.htmlConverter.innerHTML = str;
-      str = mxUtils.extractTextWithWhitespace(this.htmlConverter.childNodes);
+      this.htmlConverter.innerHTML = content;
+      content = mxUtils.extractTextWithWhitespace(this.htmlConverter.childNodes);
 
       // Workaround for substring breaking double byte UTF
       const exp = Math.ceil((2 * w) / this.state.fontSize);
       const result = [];
       let length = 0;
       let index = 0;
 
-      while ((exp == 0 || length < exp) && index < str.length) {
-        const char = str.charCodeAt(index);
+      while ((exp == 0 || length < exp) && index < content.length) {
+        const char = content.charCodeAt(index);
         if (char == 10 || char == 13) {
           if (length > 0) {
             break;
           }
         } else {
-          result.push(str.charAt(index));
+          result.push(content.charAt(index));
           if (char < 255) {
             length++;
           }
@@ -192,12 +192,12 @@ class CanvasForExport extends mxSvgCanvas2D {
       }
 
       // Uses result and adds ellipsis if more than 1 char remains
-      if (result.length < str.length && str.length - result.length > 1) {
-        str = mxUtils.trim(result.join('')) + '...';
+      if (result.length < content.length && content.length - result.length > 1) {
+        content = mxUtils.trim(result.join('')) + '...';
       }
-    } catch (e) {
-      console.warn('Error while computing txt label', e);
+    } catch (error) {
+      console.warn('Error while computing txt label', error);
     }
-    return str;
+    return content;
   }
 }
diff --git a/dev/ts/component/download.ts b/dev/ts/component/download.ts
@@ -64,7 +64,7 @@ export function downloadAsPng(svg: string): void {
   document.body.appendChild(imgPreview);
 
   const canvas = document.createElement('canvas');
-  const canvasCtx = canvas.getContext('2d');
+  const canvasContext = canvas.getContext('2d');
 
   imgPreview.onload = function () {
     const img = new Image();
@@ -73,7 +73,7 @@ export function downloadAsPng(svg: string): void {
     canvas.height = imgPreview.naturalHeight;
     img.crossOrigin = 'Anonymous';
     img.onload = function () {
-      canvasCtx.drawImage(img, 0, 0);
+      canvasContext.drawImage(img, 0, 0);
       URL.revokeObjectURL(svgUrl);
       const pngInBase64 = canvas.toDataURL('image/png');
       document.body.removeChild(imgPreview);

diff --git a/dev/ts/dev-bundle-index.ts → dev/ts/development-bundle-index.ts b/dev/ts/dev-bundle-index.ts → dev/ts/development-bundle-index.ts
diff --git a/dev/ts/pages/bpmn-rendering.ts b/dev/ts/pages/bpmn-rendering.ts
@@ -14,14 +14,14 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { documentReady, log, logError, startBpmnVisualization } from '../dev-bundle-index';
+import { documentReady, log, logError, startBpmnVisualization } from '../development-bundle-index';
 
-function statusFetchKO(errorMsg: string): void {
-  logError(errorMsg);
+function statusFetchKO(errorMessage: string): void {
+  logError(errorMessage);
   const statusElt = document.getElementById('status-zone');
-  statusElt.innerText = errorMsg;
+  statusElt.innerText = errorMessage;
   statusElt.className = 'status-ko';
-  log('Status zone set with error:', errorMsg);
+  log('Status zone set with error:', errorMessage);
 }
 
 documentReady(() => startBpmnVisualization({ globalOptions: { container: 'bpmn-container' }, statusKoNotifier: statusFetchKO }));
diff --git a/dev/ts/pages/diagram-navigation.ts b/dev/ts/pages/diagram-navigation.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { configureControlsPanel, configureMousePointer, documentReady, fit, FitType, startBpmnVisualization, zoom, ZoomType } from '../dev-bundle-index';
+import { configureControlsPanel, configureMousePointer, documentReady, fit, FitType, startBpmnVisualization, zoom, ZoomType } from '../development-bundle-index';
 
 function configureFitAndZoomButtons(): void {
   Object.values(FitType).forEach(fitType => {
@@ -26,37 +26,37 @@ function configureFitAndZoomButtons(): void {
 }
 
 function configureZoomThrottleInput(parameters: URLSearchParams): HTMLInputElement {
-  const elZoomThrottle = document.getElementById('zoom-throttle') as HTMLInputElement;
+  const zoomThrottleElement = document.getElementById('zoom-throttle') as HTMLInputElement;
   if (parameters.get('zoomThrottle')) {
-    elZoomThrottle.value = parameters.get('zoomThrottle');
+    zoomThrottleElement.value = parameters.get('zoomThrottle');
   }
-  return elZoomThrottle;
+  return zoomThrottleElement;
 }
 
 function configureZoomDebounceInput(parameters: URLSearchParams): HTMLInputElement {
-  const elZoomDebounce = document.getElementById('zoom-debounce') as HTMLInputElement;
+  const zoomDebounceElement = document.getElementById('zoom-debounce') as HTMLInputElement;
   if (parameters.get('zoomDebounce')) {
-    elZoomDebounce.value = parameters.get('zoomDebounce');
+    zoomDebounceElement.value = parameters.get('zoomDebounce');
   }
-  return elZoomDebounce;
+  return zoomDebounceElement;
 }
 
 function start(): void {
   const parameters = new URLSearchParams(window.location.search);
   configureMousePointer(parameters);
   configureControlsPanel(parameters);
 
-  const elZoomThrottle = configureZoomThrottleInput(parameters);
-  const elZoomDebounce = configureZoomDebounceInput(parameters);
+  const zoomThrottleElement = configureZoomThrottleInput(parameters);
+  const zoomDebounceElement = configureZoomDebounceInput(parameters);
 
   startBpmnVisualization({
     globalOptions: {
       container: 'bpmn-container',
       navigation: {
         enabled: true,
         zoom: {
-          throttleDelay: Number(elZoomThrottle.value),
-          debounceDelay: Number(elZoomDebounce.value),
+          throttleDelay: Number(zoomThrottleElement.value),
+          debounceDelay: Number(zoomDebounceElement.value),
         },
       },
     },

diff --git a/dev/ts/pages/elements-identification.ts b/dev/ts/pages/elements-identification.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import type { BpmnElementKind, BpmnSemantic, Overlay, ShapeStyleUpdate, StyleUpdate } from '../dev-bundle-index';
+import type { BpmnElementKind, BpmnSemantic, Overlay, ShapeStyleUpdate, StyleUpdate } from '../development-bundle-index';
 
 import {
   addCssClasses,
@@ -37,7 +37,7 @@ import {
   ShapeBpmnElementKind,
   isChildOfSubProcess,
   isFlowKind,
-} from '../dev-bundle-index';
+} from '../development-bundle-index';
 
 let lastIdentifiedBpmnIds: string[] = [];
 let lastIdentifiedParentBpmnIds: string[] = [];

diff --git a/dev/ts/pages/index.ts b/dev/ts/pages/index.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import type { FitOptions, FitType } from '../dev-bundle-index';
+import type { FitOptions, FitType } from '../development-bundle-index';
 
 import {
   documentReady,
@@ -30,7 +30,7 @@ import {
   zoom,
   ZoomType,
   windowAlertStatusKoNotifier,
-} from '../dev-bundle-index';
+} from '../development-bundle-index';
 
 let fitOnLoad = true;
 let fitOptions: FitOptions = {};
@@ -120,8 +120,8 @@ function configureDisplayedFooterContent(): void {
 function preventZoomingPage(): void {
   document.addEventListener(
     'wheel',
-    (e: WheelEvent): void => {
-      if (e.ctrlKey) e.preventDefault(); // prevent whole page zoom
+    (event: WheelEvent): void => {
+      if (event.ctrlKey) event.preventDefault(); // prevent whole page zoom
     },
     { passive: false, capture: true },
   );

diff --git a/dev/ts/pages/lib-integration.ts → dev/ts/pages/library-integration.ts b/dev/ts/pages/lib-integration.ts → dev/ts/pages/library-integration.ts
diff --git a/dev/ts/pages/overlays.ts b/dev/ts/pages/overlays.ts
@@ -14,9 +14,17 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import type { Overlay, OverlayPosition } from '../dev-bundle-index';
-
-import { addOverlays, configureControlsPanel, configureMousePointer, documentReady, getModelElementsByIds, removeAllOverlays, startBpmnVisualization } from '../dev-bundle-index';
+import type { Overlay, OverlayPosition } from '../development-bundle-index';
+
+import {
+  addOverlays,
+  configureControlsPanel,
+  configureMousePointer,
+  documentReady,
+  getModelElementsByIds,
+  removeAllOverlays,
+  startBpmnVisualization,
+} from '../development-bundle-index';
 
 const bpmnIdInputElt = document.getElementById('bpmn-id-input') as HTMLInputElement;
 

diff --git a/dev/ts/shared/controls.ts b/dev/ts/shared/controls.ts
@@ -84,8 +84,8 @@ function showMousePointer(): void {
     true,
   );
   function updateButtons(buttons: number): void {
-    for (let i = 0; i < 5; i++) {
-      box.classList.toggle('button-' + i, (buttons & (1 << i)) > 0);
+    for (let index = 0; index < 5; index++) {
+      box.classList.toggle('button-' + index, (buttons & (1 << index)) > 0);
     }
   }
 }
@@ -97,8 +97,8 @@ export function configureMousePointer(parameters: URLSearchParams): void {
 }
 
 export function configureControlsPanel(parameters: URLSearchParams): void {
-  const elControlsPanel = document.getElementById('controls-panel');
+  const controlsPanelElement = document.getElementById('controls-panel');
   if (parameters.get('showControlsPanel') === 'true') {
-    elControlsPanel.classList.remove('hidden');
+    controlsPanelElement.classList.remove('hidden');
   }
 }