lang-feel 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (C) 2022-current Nico Rehwaldt <https://github.com/nikku>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# lang-feel
+
+[![CI](https://github.com/nikku/lang-feel/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/lang-feel/actions/workflows/CI.yml)
+
+This package implements the [DMN](https://www.omg.org/spec/DMN/) FEEL language support for the [CodeMirror code editor](https://codemirror.net/).
+
+
+## Related
+
+* [lezer-feel](https://github.com/nikku/lezer-feel) - FEEL grammar
+* [feelin](https://github.com/nikku/feelin) - FEEL parser + interpreter

package/dist/index.cjs

@@ -0,0 +1,120 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var lezerFeel = require('lezer-feel');
+var language = require('@codemirror/language');
+var autocomplete = require('@codemirror/autocomplete');
+
+// / A collection of FEEL-related
+// / [snippets](#autocomplete.snippet).
+const snippets = [
+    autocomplete.snippetCompletion('function(${params})\n\t${body}', {
+        label: 'function',
+        detail: 'definition',
+        type: 'keyword'
+    }),
+    autocomplete.snippetCompletion('for\n\t${a} in ${b}\nreturn\n\t${a}', {
+        label: 'for',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    autocomplete.snippetCompletion('every\n\t${a} in ${}\nsatisfies\n\t${a}', {
+        label: 'every',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    autocomplete.snippetCompletion('some\n\t${a} in ${}\nsatisfies\n\t${a}', {
+        label: 'some',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    autocomplete.snippetCompletion('if ${} then ${}', {
+        label: 'if',
+        detail: 'block',
+        type: 'keyword'
+    }),
+    autocomplete.snippetCompletion('if ${} then ${} else ${}', {
+        label: 'if',
+        detail: '/ else block',
+        type: 'keyword'
+    })
+];
+
+// / A language provider based on the [Lezer FEEL
+// / parser](https://github.com/nikku/lezer-feel), extended with
+// / highlighting and indentation information.
+const feelLanguage = language.LRLanguage.define({
+    parser: lezerFeel.parser.configure({
+        props: [
+            language.indentNodeProp.add({
+                'Context': language.delimitedIndent({
+                    closing: '}'
+                }),
+                'List FilterExpression': language.delimitedIndent({
+                    closing: ']'
+                }),
+                'ParenthesizedExpression FunctionInvocation': language.delimitedIndent({
+                    closing: ')'
+                }),
+                'ForExpression QuantifiedExpression IfExpression': language.continuedIndent({
+                    except: /^\s*(then|else|return|satisfies)\b/
+                }),
+                'FunctionDefinition': language.continuedIndent({
+                    except: /^\s*(\(|\))/
+                })
+            }),
+            language.foldNodeProp.add({
+                Context: language.foldInside,
+                List: language.foldInside,
+                FunctionDefinition(node) {
+                    const last = node.getChild(')');
+                    if (!last)
+                        return null;
+                    return {
+                        from: last.to,
+                        to: node.to
+                    };
+                }
+            })
+        ]
+    }),
+    languageData: {
+        indentOnInput: /^\s*(\)|\}|\]|then|else|return|satisfies)$/,
+        commentTokens: {
+            line: '//',
+            block: {
+                open: '/*',
+                close: '*/'
+            }
+        }
+    }
+});
+// / A language provider for TypeScript.
+const unaryTestsLanguage = feelLanguage.configure({ top: 'UnaryTests' });
+// / Language provider for JSX.
+const expressionsLanguage = feelLanguage.configure({ top: 'Expressions' });
+const keywords = 'for return every some satisfies if then in function'.split(' ').map(kw => ({ label: kw, type: 'keyword' }));
+const dontComplete = [
+    'String', 'Name',
+    'LineComment', 'BlockComment'
+];
+// / FEEL support. Includes [snippet](#lang-feel.snippets)
+// / completion.
+function feel(config = {}) {
+    const lang = config.dialect === 'unaryTests' ? unaryTestsLanguage : expressionsLanguage;
+    const contextualLang = lang.configure({
+        contextTracker: lezerFeel.trackVariables(config.context)
+    });
+    return new language.LanguageSupport(contextualLang, [
+        feelLanguage.data.of({
+            autocomplete: autocomplete.ifNotIn(dontComplete, autocomplete.completeFromList(snippets.concat(keywords)))
+        })
+    ]);
+}
+
+exports.expressionsLanguage = expressionsLanguage;
+exports.feel = feel;
+exports.feelLanguage = feelLanguage;
+exports.snippets = snippets;
+exports.unaryTestsLanguage = unaryTestsLanguage;

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { LRLanguage, LanguageSupport } from '@codemirror/language';
+import { Completion } from '@codemirror/autocomplete';
+
+declare const feelLanguage: LRLanguage;
+declare const unaryTestsLanguage: LRLanguage;
+declare const expressionsLanguage: LRLanguage;
+declare function feel(config?: {
+    dialect?: 'expressions' | 'unaryTests';
+    context?: Record<string, any>;
+}): LanguageSupport;
+
+declare const snippets: readonly Completion[];
+
+export { expressionsLanguage, feel, feelLanguage, snippets, unaryTestsLanguage };

package/dist/index.js

@@ -0,0 +1,112 @@
+import { parser, trackVariables } from 'lezer-feel';
+import { LRLanguage, indentNodeProp, delimitedIndent, continuedIndent, foldNodeProp, foldInside, LanguageSupport } from '@codemirror/language';
+import { snippetCompletion, ifNotIn, completeFromList } from '@codemirror/autocomplete';
+
+// / A collection of FEEL-related
+// / [snippets](#autocomplete.snippet).
+const snippets = [
+    /*@__PURE__*/snippetCompletion('function(${params})\n\t${body}', {
+        label: 'function',
+        detail: 'definition',
+        type: 'keyword'
+    }),
+    /*@__PURE__*/snippetCompletion('for\n\t${a} in ${b}\nreturn\n\t${a}', {
+        label: 'for',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    /*@__PURE__*/snippetCompletion('every\n\t${a} in ${}\nsatisfies\n\t${a}', {
+        label: 'every',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    /*@__PURE__*/snippetCompletion('some\n\t${a} in ${}\nsatisfies\n\t${a}', {
+        label: 'some',
+        detail: 'expression',
+        type: 'keyword'
+    }),
+    /*@__PURE__*/snippetCompletion('if ${} then ${}', {
+        label: 'if',
+        detail: 'block',
+        type: 'keyword'
+    }),
+    /*@__PURE__*/snippetCompletion('if ${} then ${} else ${}', {
+        label: 'if',
+        detail: '/ else block',
+        type: 'keyword'
+    })
+];
+
+// / A language provider based on the [Lezer FEEL
+// / parser](https://github.com/nikku/lezer-feel), extended with
+// / highlighting and indentation information.
+const feelLanguage = /*@__PURE__*/LRLanguage.define({
+    parser: /*@__PURE__*/parser.configure({
+        props: [
+            /*@__PURE__*/indentNodeProp.add({
+                'Context': /*@__PURE__*/delimitedIndent({
+                    closing: '}'
+                }),
+                'List FilterExpression': /*@__PURE__*/delimitedIndent({
+                    closing: ']'
+                }),
+                'ParenthesizedExpression FunctionInvocation': /*@__PURE__*/delimitedIndent({
+                    closing: ')'
+                }),
+                'ForExpression QuantifiedExpression IfExpression': /*@__PURE__*/continuedIndent({
+                    except: /^\s*(then|else|return|satisfies)\b/
+                }),
+                'FunctionDefinition': /*@__PURE__*/continuedIndent({
+                    except: /^\s*(\(|\))/
+                })
+            }),
+            /*@__PURE__*/foldNodeProp.add({
+                Context: foldInside,
+                List: foldInside,
+                FunctionDefinition(node) {
+                    const last = node.getChild(')');
+                    if (!last)
+                        return null;
+                    return {
+                        from: last.to,
+                        to: node.to
+                    };
+                }
+            })
+        ]
+    }),
+    languageData: {
+        indentOnInput: /^\s*(\)|\}|\]|then|else|return|satisfies)$/,
+        commentTokens: {
+            line: '//',
+            block: {
+                open: '/*',
+                close: '*/'
+            }
+        }
+    }
+});
+// / A language provider for TypeScript.
+const unaryTestsLanguage = /*@__PURE__*/feelLanguage.configure({ top: 'UnaryTests' });
+// / Language provider for JSX.
+const expressionsLanguage = /*@__PURE__*/feelLanguage.configure({ top: 'Expressions' });
+const keywords = /*@__PURE__*/'for return every some satisfies if then in function'.split(' ').map(kw => ({ label: kw, type: 'keyword' }));
+const dontComplete = [
+    'String', 'Name',
+    'LineComment', 'BlockComment'
+];
+// / FEEL support. Includes [snippet](#lang-feel.snippets)
+// / completion.
+function feel(config = {}) {
+    const lang = config.dialect === 'unaryTests' ? unaryTestsLanguage : expressionsLanguage;
+    const contextualLang = lang.configure({
+        contextTracker: trackVariables(config.context)
+    });
+    return new LanguageSupport(contextualLang, [
+        feelLanguage.data.of({
+            autocomplete: ifNotIn(dontComplete, completeFromList(snippets.concat(keywords)))
+        })
+    ]);
+}
+
+export { expressionsLanguage, feel, feelLanguage, snippets, unaryTestsLanguage };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "lang-feel",
+  "version": "0.0.1",
+  "description": "FEEL language support for the CodeMirror code editor",
+  "scripts": {
+    "all": "run-s lint build test",
+    "test": "cm-runtests",
+    "lint": "eslint . --ext ts",
+    "build": "cm-buildhelper src/index.ts",
+    "prepare": "npm run build",
+    "dev": "chokidar 'src/*.ts' 'test/*.ts' --initial -c 'npm run build && npm test'"
+  },
+  "keywords": [
+    "editor",
+    "code"
+  ],
+  "author": {
+    "name": "Nico Rehwaldt",
+    "url": "https://github.com/nikku"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  },
+  "types": "dist/index.d.ts",
+  "module": "dist/index.js",
+  "sideEffects": false,
+  "license": "MIT",
+  "dependencies": {
+    "@codemirror/autocomplete": "^6.0.0",
+    "@codemirror/language": "^6.0.0",
+    "@codemirror/state": "^6.0.0",
+    "@codemirror/view": "^6.0.0",
+    "@lezer/common": "^1.0.0",
+    "lezer-feel": "^0.14.1"
+  },
+  "devDependencies": {
+    "@codemirror/buildhelper": "^0.1.5",
+    "@lezer/lr": "^1.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.37.0",
+    "@typescript-eslint/parser": "^5.37.0",
+    "chokidar": "^3.5.3",
+    "chokidar-cli": "^3.0.0",
+    "eslint": "^8.23.1",
+    "eslint-plugin-bpmn-io": "^0.16.0",
+    "npm-run-all": "^4.1.5",
+    "typescript": "^4.8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nikku/lang-feel.git"
+  },
+  "files": [
+    "dist"
+  ]
+}