chore: inject packageVersion at build time

bpmn-io · Dec 12, 2024 · 6e04e56 · 6e04e56
1 parent ad8897e
commit 6e04e56
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 5 deletions.
diff --git a/karma.config.js b/karma.config.js
@@ -1,6 +1,9 @@
 /* eslint-env node */
 
 const path = require('path');
+
+const pkg = require('./package.json');
+
 const {
   DefinePlugin,
   NormalModuleReplacementPlugin
@@ -93,6 +96,9 @@ module.exports = function(karma) {
       plugins: [
         new DefinePlugin({
 
+          // @nikku needs to be defined
+          'process.env.PKG_VERSION': JSON.stringify(pkg.version),
+
           // @barmac: process.env has to be defined to make @testing-library/preact work
           'process.env': {}
         }),

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -85,6 +85,7 @@
     "@rollup/plugin-commonjs": "^28.0.1",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-replace": "^6.0.1",
     "@testing-library/preact": "^2.0.1",
     "@testing-library/preact-hooks": "^1.1.0",
     "assert": "^2.1.0",

diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -4,6 +4,7 @@ import commonjs from '@rollup/plugin-commonjs';
 import copy from 'rollup-plugin-copy';
 import json from '@rollup/plugin-json';
 import resolve from '@rollup/plugin-node-resolve';
+import replace from '@rollup/plugin-replace';
 
 import {
   readFileSync
@@ -81,6 +82,12 @@ function pgl(plugins = []) {
 function corePlugins(plugins = []) {
   return [
     ...plugins,
+    replace({
+      preventAssignment: true,
+      values: {
+        'process.env.PKG_VERSION': JSON.stringify(pkg.version)
+      }
+    }),
     json(),
     resolve({
       mainFields: [

diff --git a/src/element-templates/ElementTemplates.js b/src/element-templates/ElementTemplates.js
@@ -24,7 +24,8 @@ import {
   coerce
 } from 'semver';
 
-import pkg from '../../package.json';
+// eslint-disable-next-line no-undef
+const packageVersion = process.env.PKG_VERSION;
 
 
 /**
@@ -177,7 +178,7 @@ export default class ElementTemplates {
     // package version; templates may use that engine to declare
     // compatibility with this library
     engines = {
-      elementTemplates: pkg.version,
+      elementTemplates: packageVersion,
       ...engines
     };
 

diff --git a/test/spec/cloud-element-templates/ElementTemplates.spec.js b/test/spec/cloud-element-templates/ElementTemplates.spec.js
@@ -34,7 +34,8 @@ import { findExtensions, findExtension } from 'src/cloud-element-templates/Helpe
 import { getLabel } from 'bpmn-js/lib/features/label-editing/LabelUtil';
 import { findMessage } from 'src/cloud-element-templates/Helper';
 
-import pkg from '../../../package.json';
+// eslint-disable-next-line no-undef
+const packageVersion = process.env.PKG_VERSION;
 
 
 describe('provider/cloud-element-templates - ElementTemplates', function() {
@@ -790,7 +791,9 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
     it('should provide default <elementTemplates> engine', inject(function(elementTemplates) {
 
       // then
-      expect(elementTemplates.getEngines()).to.have.property('elementTemplates', pkg.version);
+      expect(
+        elementTemplates.getEngines()
+      ).to.have.property('elementTemplates', packageVersion);
     }));
 
 
@@ -804,7 +807,7 @@ describe('provider/cloud-element-templates - ElementTemplates', function() {
 
       // then
       expect(elementTemplates.getEngines()).to.eql({
-        'elementTemplates': pkg.version,
+        'elementTemplates': packageVersion,
         'camunda': '8.0.0',
         'other': '100.5.0'
       });