fixup: remaining comments

Author: Buckwich

src/camundaBuiltins.js

@@ -6,10 +6,21 @@
  * Make sure you edit the template file `tasks/camundaBuiltins.template.js` and run `compile:builtins` (or `update:builtins`) to update the file in lib.
  */
 
+/**
+ * @typedef { {
+ *   name: string,
+ *   info: string,
+ *   type?: 'function',
+ *   params?: Array<{
+ *     name: string;
+ *   }>
+ * } } Builtin
+ */
+
 /**
  * List of standard FEEL built-in functions (excluding Camunda-specific extensions).
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const feelBuiltins = [
   {
@@ -1353,7 +1364,7 @@ export const feelBuiltins = [
 /**
  * List of FEEL camunda extensions.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const camundaExtensions = [
   {
@@ -1662,14 +1673,14 @@ export const camundaExtensions = [
 /**
  * Collection of builtins of camunda scala FEEL.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const camundaBuiltins = [ ...feelBuiltins, ...camundaExtensions ];
 
 /**
  * Functions using reserved keywords in their name and need to be added to the parser context.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const reservedNameBuiltins = [
   {

tasks/camundaBuiltins.template.js

@@ -6,30 +6,41 @@
  * Make sure you edit the template file `tasks/camundaBuiltins.template.js` and run `compile:builtins` (or `update:builtins`) to update the file in lib.
  */
 
+/**
+ * @typedef { {
+ *   name: string,
+ *   info: string,
+ *   type?: 'function',
+ *   params?: Array<{
+ *     name: string;
+ *   }>
+ * } } Builtin
+ */
+
 /**
  * List of standard FEEL built-in functions (excluding Camunda-specific extensions).
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const feelBuiltins = /** FEEL_BUILTINS_PLACEHOLDER */ [];
 
 /**
  * List of FEEL camunda extensions.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const camundaExtensions = /** CAMUNDA_EXTENSIONS_PLACEHOLDER */ [];
 
 /**
  * Collection of builtins of camunda scala FEEL.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const camundaBuiltins = [ ...feelBuiltins, ...camundaExtensions ];
 
 /**
  * Functions using reserved keywords in their name and need to be added to the parser context.
  *
- * @type { import("../dist/index.d.ts").Builtin[] }
+ * @type {Builtin[] }
  */
 export const reservedNameBuiltins = /** RESERVED_NAME_BUILTINS_PLACEHOLDER */ [];

test/spec/lib/camundaBuiltins.spec.js

@@ -3,36 +3,36 @@ import { expect } from 'chai';
 import { camundaBuiltins, feelBuiltins, camundaExtensions, reservedNameBuiltins } from '@camunda/feel-builtins';
 
 
-describe('lib/camundaBuiltins', function() {
+describe('camundaBuiltins', function() {
 
-  it('should export ALL built-ins', function() {
+  it('should export ALL builtins', function() {
+
+    // testing if the count of builtin changes, if it does we have to adjust from chore to feat and do a minor release
 
     // then
     expect(camundaBuiltins).to.be.an('array').with.length(135);
+    expect(reservedNameBuiltins).to.be.an('array').with.length(1);
   });
 
 
   it('should export feelBuiltins', function() {
 
     // then
-    expect(feelBuiltins).to.be.an('array');
-    expect(feelBuiltins.length).to.be.greaterThan(0);
-
-    // standard FEEL function should be in feelBuiltins
-    const notFunction = feelBuiltins.find(b => b.name === 'not');
-    expect(notFunction).to.exist;
+    expectBuiltin(feelBuiltins, 'not');
   });
 
 
   it('should export camundaExtensions', function() {
 
     // then
-    expect(camundaExtensions).to.be.an('array');
-    expect(camundaExtensions.length).to.be.greaterThan(0);
+    expectBuiltin(camundaExtensions, 'get or else');
+  });
+
+
+  it('should export reservedNameBuiltins', function() {
 
-    // Camunda extension should be in camundaExtensions
-    const getOrElse = camundaExtensions.find(b => b.name === 'get or else');
-    expect(getOrElse).to.exist;
+    // then
+    expectBuiltin(reservedNameBuiltins, 'get or else');
   });
 
 
@@ -43,29 +43,24 @@ describe('lib/camundaBuiltins', function() {
   });
 
 
-  it('should export reservedNameBuiltins', function() {
 
-    // then
-    expect(reservedNameBuiltins).to.be.an('array').with.length(1);
-    expect(reservedNameBuiltins[0].name).to.equal('get or else');
-  });
 
 
-  it('should export parameterized built-in', function() {
+  it('should export parameterized builtin', function() {
 
     // then
-    expectBuiltin('get or else', {
+    expectBuiltinProperties(camundaBuiltins, 'get or else', {
       name: 'get or else',
       type: 'function',
       params: [ { name: 'value' }, { name: 'default' } ],
     });
   });
 
 
-  it('should export parameterless built-in', function() {
+  it('should export parameterless builtin', function() {
 
     // then
-    expectBuiltin('random number', {
+    expectBuiltinProperties(camundaBuiltins, 'random number', {
       name: 'random number',
       type: 'function',
       params: []
@@ -78,12 +73,13 @@ describe('lib/camundaBuiltins', function() {
 // helpers /////////
 
 /**
+ * @param {import('@camunda/feel-builtins').Builtin[]} builtins
  * @param {string} name
  *
  * @return {import('@camunda/feel-builtins').Builtin}
  */
-function findBuiltin(name) {
-  const builtin = camundaBuiltins.find(builtin => builtin.name === name);
+function expectBuiltin(builtins, name) {
+  const builtin = builtins.find(builtin => builtin.name === name);
 
   if (!builtin) {
     throw expect(builtin, `builtin with name <${name}>`).to.exist;
@@ -93,11 +89,13 @@ function findBuiltin(name) {
 }
 
 /**
+ * @param {import('@camunda/feel-builtins').Builtin[]} builtins
  * @param {string} name
+ *
  * @param {Record<string, any>} expectedProperties
  */
-function expectBuiltin(name, expectedProperties) {
-  const builtin = findBuiltin(name);
+function expectBuiltinProperties(builtins, name, expectedProperties) {
+  const builtin = expectBuiltin(builtins, name);
 
   expect(builtin).to.deep.include(expectedProperties);
   expect(builtin).to.have.property('info');