chore: rename unparsable to reservedNameBuiltins

Author: Buckwich

README.md

@@ -19,7 +19,7 @@ This package exports multiple collections of FEEL builtins:
 * **`camundaBuiltins`**: Collection of builtins of camunda scala FEEL.
 * **`feelBuiltins`**: List of standard FEEL built-in functions (excluding Camunda-specific extensions).
 * **`camundaExtensions`**: List of FEEL camunda extensions.
-* **`unparsableBuiltins`**: Functions that cannot be parsed with lezer-feel without context.
+* **`reservedNameBuiltins`**: Functions using reserved keywords in their name and need to be added to the parser context during parsing.
   * You probably want to inject those builtins as additional context to make the parser work.
 
 ### Feel Editor

dist/index.d.ts

@@ -14,9 +14,9 @@ export const feelBuiltins: Builtin[];
 export const camundaExtensions: Builtin[];
 
 /**
- * Functions that cannot be parsed with lezer-feel without context.
+ * Functions using reserved keywords in their name and need to be added to the parser context.
  */
-export const unparsableBuiltins: Builtin[];
+export const reservedNameBuiltins: Builtin[];
 
 export type Builtin = {
   /**

src/camundaBuiltins.js

@@ -1667,11 +1667,11 @@ export const camundaExtensions = [
 export const camundaBuiltins = [ ...feelBuiltins, ...camundaExtensions ];
 
 /**
- * Functions that cannot be parsed with lezer-feel without context.
+ * Functions using reserved keywords in their name and need to be added to the parser context.
  *
  * @type { import("../dist/index.d.ts").Builtin[] }
  */
-export const unparsableBuiltins = [
+export const reservedNameBuiltins = [
   {
     "name": "get or else",
     "type": "function",

src/index.js

@@ -1 +1 @@
-export { camundaBuiltins, feelBuiltins, camundaExtensions, unparsableBuiltins } from './camundaBuiltins.js';
+export { camundaBuiltins, feelBuiltins, camundaExtensions, reservedNameBuiltins } from './camundaBuiltins.js';

tasks/camundaBuiltins.template.js

@@ -28,8 +28,8 @@ export const camundaExtensions = /** CAMUNDA_EXTENSIONS_PLACEHOLDER */ [];
 export const camundaBuiltins = [ ...feelBuiltins, ...camundaExtensions ];
 
 /**
- * Functions that cannot be parsed with lezer-feel without context.
+ * Functions using reserved keywords in their name and need to be added to the parser context.
  *
  * @type { import("../dist/index.d.ts").Builtin[] }
  */
-export const unparsableBuiltins = /** CAMUNDA_UNPARSABLE_BUILTINS_PLACEHOLDER */ [];
+export const reservedNameBuiltins = /** RESERVED_NAME_BUILTINS_PLACEHOLDER */ [];

tasks/utils/categorizeBuiltins.js

@@ -36,22 +36,22 @@ function isCamundaExtension(builtin) {
 }
 
 /**
- * Categorize builtins into FEEL standard functions and Camunda extensions
+ * Categorize builtins into FEEL standard functions Camunda extensions and list ones using reserved keywords.
  * @param {import('@camunda/feel-builtins').Builtin[]} builtins
  * @returns {{
  *   feelBuiltins: import('@camunda/feel-builtins').Builtin[],
  *   camundaExtensions: import('@camunda/feel-builtins').Builtin[],
- *   unparsableBuiltins: import('@camunda/feel-builtins').Builtin[]
+ *   reservedNameBuiltins: import('@camunda/feel-builtins').Builtin[]
  * }}
  */
 export function categorizeBuiltins(builtins) {
   const feelBuiltins = [];
   const camundaExtensions = [];
-  const unparsableBuiltins = [];
+  const reservedNameBuiltins = [];
 
   for (const builtin of builtins) {
     if (!isParsable(builtin)) {
-      unparsableBuiltins.push(builtin);
+      reservedNameBuiltins.push(builtin);
     }
 
     if (isCamundaExtension(builtin)) {
@@ -64,7 +64,7 @@ export function categorizeBuiltins(builtins) {
   return {
     feelBuiltins,
     camundaExtensions,
-    unparsableBuiltins,
+    reservedNameBuiltins,
   };
 }
 
@@ -73,17 +73,17 @@ export function categorizeBuiltins(builtins) {
  * @param {{
  *   feelBuiltins: import('@camunda/feel-builtins').Builtin[],
  *   camundaExtensions: import('@camunda/feel-builtins').Builtin[],
- *   unparsableBuiltins: import('@camunda/feel-builtins').Builtin[]
+ *   reservedNameBuiltins: import('@camunda/feel-builtins').Builtin[]
  * }} categorized
  */
 export function logStatistics(categorized) {
-  const { feelBuiltins, camundaExtensions, unparsableBuiltins } = categorized;
+  const { feelBuiltins, camundaExtensions, reservedNameBuiltins } = categorized;
 
   console.log(`FEEL built-ins: ${feelBuiltins.length}`);
   console.log(`Camunda extensions: ${camundaExtensions.length}`);
-  console.log(`Unparsable functions: ${unparsableBuiltins.length}`);
+  console.log(`Functions using reserved keywords: ${reservedNameBuiltins.length}`);
 
-  if (unparsableBuiltins.length > 0) {
-    console.log('Unparsable:', unparsableBuiltins.map((b) => b.name).join(', '));
+  if (reservedNameBuiltins.length > 0) {
+    console.log('Reserved Functions:', reservedNameBuiltins.map((b) => b.name).join(', '));
   }
 }

tasks/utils/templateWriter.js

@@ -2,7 +2,7 @@ import { readFile, writeFile } from 'node:fs/promises';
 
 const FEEL_BUILTINS_PLACEHOLDER = '/** FEEL_BUILTINS_PLACEHOLDER */ []';
 const CAMUNDA_EXTENSIONS_PLACEHOLDER = '/** CAMUNDA_EXTENSIONS_PLACEHOLDER */ []';
-const CAMUNDA_UNPARSABLE_BUILTINS_PLACEHOLDER = '/** CAMUNDA_UNPARSABLE_BUILTINS_PLACEHOLDER */ []';
+const RESERVED_NAME_BUILTINS_PLACEHOLDER = '/** RESERVED_NAME_BUILTINS_PLACEHOLDER */ []';
 
 /**
  * Write builtins to the destination file using the template
@@ -11,16 +11,16 @@ const CAMUNDA_UNPARSABLE_BUILTINS_PLACEHOLDER = '/** CAMUNDA_UNPARSABLE_BUILTINS
  * @param {Object} categorized
  * @param {import('@camunda/feel-builtins').Builtin[]} categorized.feelBuiltins
  * @param {import('@camunda/feel-builtins').Builtin[]} categorized.camundaExtensions
- * @param {import('@camunda/feel-builtins').Builtin[]} categorized.unparsableBuiltins
+ * @param {import('@camunda/feel-builtins').Builtin[]} categorized.reservedNameBuiltins
  */
 export async function writeBuiltinsFromTemplate(templatePath, destinationPath, categorized) {
-  const { feelBuiltins, camundaExtensions, unparsableBuiltins } = categorized;
+  const { feelBuiltins, camundaExtensions, reservedNameBuiltins } = categorized;
 
   const template = await readFile(templatePath, 'utf-8');
   let content = template
     .replace(FEEL_BUILTINS_PLACEHOLDER, JSON.stringify(feelBuiltins, null, 2))
     .replace(CAMUNDA_EXTENSIONS_PLACEHOLDER, JSON.stringify(camundaExtensions, null, 2))
-    .replace(CAMUNDA_UNPARSABLE_BUILTINS_PLACEHOLDER, JSON.stringify(unparsableBuiltins, null, 2));
+    .replace(RESERVED_NAME_BUILTINS_PLACEHOLDER, JSON.stringify(reservedNameBuiltins, null, 2));
 
   await writeFile(destinationPath, content);
 }

test/spec/lib/camundaBuiltins.spec.js

@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 
-import { camundaBuiltins, feelBuiltins, camundaExtensions, unparsableBuiltins } from '@camunda/feel-builtins';
+import { camundaBuiltins, feelBuiltins, camundaExtensions, reservedNameBuiltins } from '@camunda/feel-builtins';
 
 
 describe('lib/camundaBuiltins', function() {
@@ -43,11 +43,11 @@ describe('lib/camundaBuiltins', function() {
   });
 
 
-  it('should export unparsableBuiltins', function() {
+  it('should export reservedNameBuiltins', function() {
 
     // then
-    expect(unparsableBuiltins).to.be.an('array').with.length(1);
-    expect(unparsableBuiltins[0].name).to.equal('get or else');
+    expect(reservedNameBuiltins).to.be.an('array').with.length(1);
+    expect(reservedNameBuiltins[0].name).to.equal('get or else');
   });