feat(entry-field-description): make translate first parameter

bpmn-io · Oct 5, 2020 · 9755d04 · 9755d04
1 parent b361381
commit 9755d04
Show file tree

Hide file tree

Showing 14 changed files with 35 additions and 36 deletions.
diff --git a/lib/factory/AutoSuggestTextBoxFactory.js b/lib/factory/AutoSuggestTextBoxFactory.js
@@ -50,7 +50,7 @@ var autoSuggestTextBox = function(translate, options, defaultParameters) {
     '</div>');
 
   if (description) {
-    domQuery('.bpp-field-wrapper', resource.html).appendChild(entryFieldDescription(description, translate));
+    domQuery('.bpp-field-wrapper', resource.html).appendChild(entryFieldDescription(translate, description));
   }
 
   if (canBeShown) {

diff --git a/lib/factory/CheckboxEntryFactory.js b/lib/factory/CheckboxEntryFactory.js
@@ -31,7 +31,7 @@ var checkbox = function(translate, options, defaultParameters) {
 
   // add description below checkbox entry field
   if (description) {
-    resource.html.appendChild(entryFieldDescription(description, translate, { show: canBeHidden && 'isHidden' }));
+    resource.html.appendChild(entryFieldDescription(translate, description, { show: canBeHidden && 'isHidden' }));
   }
 
   resource.get = function(element) {

diff --git a/lib/factory/ComboEntryFactory.js b/lib/factory/ComboEntryFactory.js
@@ -116,7 +116,7 @@ var comboBox = function(translate, options) {
 
   // add description below combo box entry field
   if (description) {
-    comboBoxEntry.html.appendChild(entryFieldDescription(description, translate, { show: 'showCustomInput' }));
+    comboBoxEntry.html.appendChild(entryFieldDescription(translate, description, { show: 'showCustomInput' }));
   }
 
   return comboBoxEntry;

diff --git a/lib/factory/EntryFieldDescription.js b/lib/factory/EntryFieldDescription.js
@@ -18,7 +18,7 @@ var MAX_DESCRIPTION_LENGTH = 200;
  * @param {object} [options]
  * @param {string} [options.show] - name of callback to determine whether description is shown
  */
-module.exports = function entryFieldDescription(description, translate, options) {
+module.exports = function entryFieldDescription(translate, description, options) {
   var show = options && options.show;
 
   // we tokenize the description to extract text, HTML and markdown links

diff --git a/lib/factory/LinkEntryFactory.js b/lib/factory/LinkEntryFactory.js
@@ -72,7 +72,7 @@ function link(translate, options) {
 
   // add description below link entry field
   if (description) {
-    resource.html.appendChild(entryFieldDescription(description, translate, { show: 'showLink' }));
+    resource.html.appendChild(entryFieldDescription(translate, description, { show: 'showLink' }));
   }
 
   resource.handleClick = bind(handleClick, resource);

diff --git a/lib/factory/SelectEntryFactory.js b/lib/factory/SelectEntryFactory.js
@@ -80,7 +80,7 @@ var selectbox = function(translate, options, defaultParameters) {
 
   // add description below select box entry field
   if (description && typeof options.showCustomInput !== 'function') {
-    resource.html.appendChild(entryFieldDescription(description, translate, { show: canBeHidden && 'isHidden' }));
+    resource.html.appendChild(entryFieldDescription(translate, description, { show: canBeHidden && 'isHidden' }));
   }
 
   /**

diff --git a/lib/factory/TableEntryFactory.js b/lib/factory/TableEntryFactory.js
@@ -172,7 +172,7 @@ module.exports = function(translate, options) {
         '</div>');
 
   if (description) {
-    html.appendChild(entryFieldDescription(description, translate, { show: 'showTable' }));
+    html.appendChild(entryFieldDescription(translate, description, { show: 'showTable' }));
   }
 
   var factory = {

diff --git a/lib/factory/TextBoxEntryFactory.js b/lib/factory/TextBoxEntryFactory.js
@@ -27,7 +27,7 @@ var textBox = function(translate, options, defaultParameters) {
 
   // add description below text box entry field
   if (description) {
-    resource.html.appendChild(entryFieldDescription(description, translate, { show: canBeShown && 'isShown' }));
+    resource.html.appendChild(entryFieldDescription(translate, description, { show: canBeShown && 'isShown' }));
   }
 
   if (canBeShown) {

diff --git a/lib/factory/TextInputEntryFactory.js b/lib/factory/TextInputEntryFactory.js
@@ -60,7 +60,7 @@ var textField = function(translate, options, defaultParameters) {
 
   // add description below text input entry field
   if (description) {
-    resource.html.appendChild(entryFieldDescription(description, translate, { show: canBeHidden && 'isHidden' }));
+    resource.html.appendChild(entryFieldDescription(translate, description, { show: canBeHidden && 'isHidden' }));
   }
 
   resource[actionName] = actionMethod;

diff --git a/lib/factory/ToggleSwitchEntryFactory.js b/lib/factory/ToggleSwitchEntryFactory.js
@@ -42,11 +42,11 @@ var toggleSwitch = function(translate, options, defaultParameters) {
     '</div>'));
 
   if (descriptionOn) {
-    resource.html.appendChild(entryFieldDescription(descriptionOn, translate, { show: 'isOn' }));
+    resource.html.appendChild(entryFieldDescription(translate, descriptionOn, { show: 'isOn' }));
   }
 
   if (descriptionOff) {
-    resource.html.appendChild(entryFieldDescription(descriptionOff, translate, { show: 'isOff' }));
+    resource.html.appendChild(entryFieldDescription(translate, descriptionOff, { show: 'isOff' }));
   }
 
   resource.get = function(element) {

diff --git a/lib/provider/camunda/parts/implementation/InputParameters.js b/lib/provider/camunda/parts/implementation/InputParameters.js
@@ -148,7 +148,7 @@ function getInputParameterEntries(element, bpmnFactory, options, translate) {
       entries;
 
   if (!params.length) {
-    var description = entryFieldDescription(translate('No variables defined.'), translate);
+    var description = entryFieldDescription(translate, translate('No variables defined.'));
 
     return [{
       id: idPrefix + 'input-parameter' + '-placeholder',

diff --git a/lib/provider/camunda/parts/implementation/OutputParameters.js b/lib/provider/camunda/parts/implementation/OutputParameters.js
@@ -149,7 +149,7 @@ function getOutputParameterEntries(element, bpmnFactory, options, translate) {
       entries;
 
   if (!params.length) {
-    var description = entryFieldDescription(translate('No variables defined.'), translate);
+    var description = entryFieldDescription(translate, translate('No variables defined.'));
 
     return [{
       id: idPrefix + 'output-parameter' + '-placeholder',

diff --git a/lib/provider/camunda/parts/implementation/ProcessVariables.js b/lib/provider/camunda/parts/implementation/ProcessVariables.js
@@ -86,7 +86,7 @@ module.exports = function(element, translate) {
       byScope = groupByScope(withNames);
 
   // (1) tab description entry
-  var description = entryFieldDescription(translate('Available process variables, identified in the diagram.'), translate);
+  var description = entryFieldDescription(translate, translate('Available process variables, identified in the diagram.'));
 
   entries.push({
     id: 'process-variables-description',
@@ -99,7 +99,7 @@ module.exports = function(element, translate) {
 
   // (2) empty list placeholder
   if (!withNames.length) {
-    var placeholder = entryFieldDescription(translate('No variables found.'), translate);
+    var placeholder = entryFieldDescription(translate, translate('No variables found.'));
 
     entries.push({
       id: 'process-variables-placeholder',

diff --git a/test/spec/factory/EntryFieldDescriptionSpec.js b/test/spec/factory/EntryFieldDescriptionSpec.js
@@ -11,7 +11,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should use provided callback name', function() {
 
       // when
-      var html = EntryFieldDescription('desc', translate, { show: 'show' });
+      var html = EntryFieldDescription(translate, 'desc', { show: 'show' });
 
       // then
       expect(domAttr(html, 'data-show')).to.equal('show');
@@ -21,8 +21,8 @@ describe('factory/EntryFieldDescription', function() {
     it('should not set "data-show" attribute if callback name is not present', function() {
 
       // when
-      var html1 = EntryFieldDescription('desc', translate);
-      var html2 = EntryFieldDescription('desc', translate, { show: undefined });
+      var html1 = EntryFieldDescription(translate, 'desc');
+      var html2 = EntryFieldDescription(translate, 'desc', { show: undefined });
 
       // then
       expect(domAttr(html1, 'data-show')).not.to.exist;
@@ -36,7 +36,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should escape HTML', function() {
 
       // when
-      var html = EntryFieldDescription('<html />', translate);
+      var html = EntryFieldDescription(translate, '<html />');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal('&lt;html /&gt;');
@@ -46,7 +46,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should preserve plain <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a href="http://foo">FOO</a> <a href="https://bar">BAR</a>!', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a href="http://foo">FOO</a> <a href="https://bar">BAR</a>!');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -58,7 +58,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should preserve query string in plain <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a href="http://foo?foo=bar&foo.bar[]=1">FOO</a>', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a href="http://foo?foo=bar&foo.bar[]=1">FOO</a>');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -70,7 +70,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should preserve <a> and <br/>', function() {
 
       // when
-      var html = EntryFieldDescription(
+      var html = EntryFieldDescription(translate,
         '<div>' +
           '<a href="http://foo">' +
             '<p>' +
@@ -79,8 +79,7 @@ describe('factory/EntryFieldDescription', function() {
           '</a>' +
           '<br />' +
           '<a href="http://bar">BAR</a>' +
-        '</div>',
-        translate
+        '</div>'
       );
 
       // then
@@ -101,7 +100,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should handle markdown special chars in <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a href="http://foo?()[]">[]FOO</a>', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a href="http://foo?()[]">[]FOO</a>');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -113,7 +112,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should ignore custom <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a class="foo" href="http://foo">FOO</a>!', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a class="foo" href="http://foo">FOO</a>!');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -125,7 +124,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should ignore broken <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a href="http://foo>FOO</a>!', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a href="http://foo>FOO</a>!');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -137,7 +136,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should ignore non HTTP(S) protocol <a href>', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo <a href="javascript:foo()">FOO</a>!', translate);
+      var html = EntryFieldDescription(translate, 'Hallo <a href="javascript:foo()">FOO</a>!');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -149,7 +148,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should transform markdown link', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo [FOO](http://foo) [BAR](https://bar?a=1&b=10)!', translate);
+      var html = EntryFieldDescription(translate, 'Hallo [FOO](http://foo) [BAR](https://bar?a=1&b=10)!');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -161,7 +160,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should ignore broken markdown link', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo [FOO](http://foo', translate);
+      var html = EntryFieldDescription(translate, 'Hallo [FOO](http://foo');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -173,7 +172,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should transform HTML in markdown link', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo ["FOO" <div/>](http://foo)', translate);
+      var html = EntryFieldDescription(translate, 'Hallo ["FOO" <div/>](http://foo)');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -185,7 +184,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should preserve line breaks', function() {
 
       // when
-      var html = EntryFieldDescription('Hello <br/> world', translate);
+      var html = EntryFieldDescription(translate, 'Hello <br/> world');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -197,7 +196,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should ignore whitespaces in br tag', function() {
 
       // when
-      var html = EntryFieldDescription('Hello <br       /> world', translate);
+      var html = EntryFieldDescription(translate, 'Hello <br       /> world');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -209,7 +208,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should preserve line breaks within <a> text', function() {
 
       // when
-      var html = EntryFieldDescription('<a href="https://test.com"> HELLO <br/> WORLD </a>', translate);
+      var html = EntryFieldDescription(translate, '<a href="https://test.com"> HELLO <br/> WORLD </a>');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -221,7 +220,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should not ignore <a> if br used within URL field', function() {
 
       // when
-      var html = EntryFieldDescription('<a href="https://test<br />website.com"> HELLO <br/> WORLD </a>', translate);
+      var html = EntryFieldDescription(translate, '<a href="https://test<br />website.com"> HELLO <br/> WORLD </a>');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(
@@ -233,7 +232,7 @@ describe('factory/EntryFieldDescription', function() {
     it('should handle special HTML chars in markdown link', function() {
 
       // when
-      var html = EntryFieldDescription('Hallo [YOU](http://foo=<" []>)', translate);
+      var html = EntryFieldDescription(translate, 'Hallo [YOU](http://foo=<" []>)');
 
       // then
       expect(domQuery('.description__text', html).innerHTML).to.equal(