zenstack 0.1.42 → 1.0.0

package/packages/schema/src/language-server/zmodel.langium

@@ -0,0 +1,186 @@
+grammar ZModel
+
+entry Model:
+    (
+        declarations+=AbstractDeclaration
+    )*;
+
+AbstractDeclaration:
+    DataSource | DataModel | Enum | Function | Attribute;
+
+// datasource
+DataSource:
+    'datasource' name=ID '{' (fields+=DataSourceField)+ '}';
+
+DataSourceField:
+    (name=ID '=' value=(LiteralExpr|InvocationExpr));
+
+// expression
+Expression:
+    LogicalExpr;
+
+LiteralExpr:
+    value=(BOOLEAN | INT | STRING);
+
+ArrayExpr:
+    '[' (items+=Expression (',' items+=Expression)*)? ']';
+
+type ReferenceTarget = FunctionParam | DataModelField | EnumField;
+
+ThisExpr:
+    value=THIS;
+
+NullExpr:
+    value=NULL;
+
+ReferenceExpr:
+    target=[ReferenceTarget:ID] ('(' ReferenceArgList ')')?;
+
+fragment ReferenceArgList:
+    args+=ReferenceArg (',' args+=ReferenceArg)*;
+
+ReferenceArg:
+    name=('sort') ':' value=('Asc'| 'Desc');
+
+InvocationExpr:
+    function=[Function] '(' ArgumentList? ')';
+
+UnaryExpr:
+    operator=('!') operand=Expression;
+
+// binary operator precedence follow Javascript's rules:
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_Precedence#table
+
+MemberAccessExpr infers Expression:
+    PrimaryExpr (
+        {infer MemberAccessExpr.operand=current}
+        ('.' member=[DataModelField])
+    )*;
+
+CollectionPredicateExpr infers Expression:
+    MemberAccessExpr (
+        {infer BinaryExpr.left=current}
+        operator=('?'|'!'|'^')
+        '[' right=Expression ']'
+    )*;
+
+// TODO: support arithmetics?
+//
+// MultDivExpr infers Expression:
+//     CollectionPredicateExpr (
+//         {infer BinaryExpr.left=current}
+//         operator=('*'|'/')
+//         right=CollectionPredicateExpr
+//     )*;
+
+// AddSubExpr infers Expression:
+//     MultDivExpr (
+//         {infer BinaryExpr.left=current}
+//         operator=('+'|'-')
+//         right=MultDivExpr
+//     )*;
+
+ComparisonExpr infers Expression:
+    CollectionPredicateExpr (
+        {infer BinaryExpr.left=current}
+        operator=('>'|'<'|'>='|'<=')
+        right=CollectionPredicateExpr
+    )*;
+
+EqualityExpr infers Expression:
+    ComparisonExpr (
+        {infer BinaryExpr.left=current}
+        operator=('=='|'!=')
+        right=ComparisonExpr
+    )*;
+
+LogicalExpr infers Expression:
+    EqualityExpr (
+        {infer BinaryExpr.left=current}
+        operator=('&&'|'||')
+        right=EqualityExpr
+    )*;
+
+PrimaryExpr infers Expression:
+    '(' Expression ')' |
+    ThisExpr |
+    NullExpr |
+    LiteralExpr |
+    InvocationExpr |
+    ArrayExpr|
+    ReferenceExpr |
+    UnaryExpr;
+
+fragment ArgumentList:
+    args+=Argument (',' args+=Argument)*;
+
+Argument:
+    (name=ID ':')? value=Expression;
+
+// model
+DataModel:
+    'model' name=ID '{' (
+            fields+=DataModelField
+            | attributes+=DataModelAttribute
+        )+
+    '}';
+
+DataModelField:
+    name=ID type=DataModelFieldType (attributes+=DataModelFieldAttribute)*;
+
+DataModelFieldType:
+    (BuiltinType | reference=[TypeDeclaration:ID]) (array?='[]')? (optional?='?')?;
+
+// enum
+Enum:
+    'enum' name=ID '{' (fields+=EnumField)+ '}';
+
+EnumField:
+    name=ID;
+
+// function
+Function:
+    'function' name=ID '(' (params+=FunctionParam (',' params+=FunctionParam)*)? ')' returnType=FunctionParamType '{' (expression=Expression)? '}';
+
+FunctionParam:
+    name=ID type=FunctionParamType;
+
+FunctionParamType:
+    (BuiltinType | reference=[TypeDeclaration]) (array?='[]')?;
+
+// attribute
+Attribute:
+    'attribute' name=ID '(' (params+=AttributeParam (',' params+=AttributeParam)*)? ')';
+
+AttributeParam:
+    positional?='_' name=ID type=AttributeParamType;
+
+AttributeParamType:
+    (BuiltinType | type='FieldReference') array?='[]' optional?='?';
+
+type TypeDeclaration = DataModel | Enum;
+
+DataModelFieldAttribute:
+    '@' decl=[Attribute] ('(' AttributeArgList? ')')?;
+
+DataModelAttribute:
+    '@@' decl=[Attribute] ('(' AttributeArgList? ')')?;
+
+fragment AttributeArgList:
+    args+=AttributeArg (',' args+=AttributeArg)*;
+
+AttributeArg:
+    (name=ID ':')? value=Expression;
+
+fragment BuiltinType:
+    type=('String'|'Boolean'|'Int'|'DateTime'|'JSON');
+
+hidden terminal WS: /\s+/;
+terminal BOOLEAN returns boolean: /true|false/;
+terminal NULL: 'null';
+terminal THIS: 'this';
+terminal ID: /[_a-zA-Z][\w_]*/;
+terminal STRING: /"[^"]*"|'[^']*'/;
+terminal INT returns number: /[+-]?[0-9]+/;
+hidden terminal ML_COMMENT: /\/\*[\s\S]*?\*\//;
+hidden terminal SL_COMMENT: /\/\/[^\n\r]*/;

package/packages/schema/src/utils/exec-utils.ts

@@ -0,0 +1,5 @@
+import { execSync as _exec } from 'child_process';
+
+export function execSync(cmd: string) {
+    _exec(cmd, { encoding: 'utf-8', stdio: 'inherit' });
+}

package/packages/schema/src/utils/indent-string.ts

@@ -0,0 +1,6 @@
+// https://github.com/sindresorhus/indent-string
+
+export default function indentString(string: string, count = 4) {
+    const indent = ' ';
+    return string.replace(/^(?!\s*$)/gm, indent.repeat(count));
+}

package/packages/schema/syntaxes/zmodel.json

@@ -0,0 +1,57 @@
+{
+  "name": "zmodel",
+  "scopeName": "source.zmodel",
+  "fileTypes": [
+    ".zmodel"
+  ],
+  "patterns": [
+    {
+      "include": "#comments"
+    },
+    {
+      "name": "keyword.control.zmodel",
+      "match": "\\b(Boolean|datasource|enum|model|String)\\b"
+    },
+    {
+      "name": "string.quoted.double.zmodel",
+      "begin": "\"",
+      "end": "\""
+    },
+    {
+      "name": "string.quoted.single.zmodel",
+      "begin": "'",
+      "end": "'"
+    }
+  ],
+  "repository": {
+    "comments": {
+      "patterns": [
+        {
+          "name": "comment.block.zmodel",
+          "begin": "/\\*",
+          "beginCaptures": {
+            "0": {
+              "name": "punctuation.definition.comment.zmodel"
+            }
+          },
+          "end": "\\*/",
+          "endCaptures": {
+            "0": {
+              "name": "punctuation.definition.comment.zmodel"
+            }
+          }
+        },
+        {
+          "begin": "//",
+          "beginCaptures": {
+            "1": {
+              "name": "punctuation.whitespace.comment.leading.zmodel"
+            }
+          },
+          "end": "(?=$)",
+          "name": "comment.line.zmodel"
+        }
+      ]
+    }
+  }
+}

package/packages/schema/syntaxes/zmodel.tmLanguage.json

@@ -0,0 +1,57 @@
+{
+  "name": "zmodel",
+  "scopeName": "source.zmodel",
+  "fileTypes": [
+    ".zmodel"
+  ],
+  "patterns": [
+    {
+      "include": "#comments"
+    },
+    {
+      "name": "keyword.control.zmodel",
+      "match": "\\b(Asc|attribute|Boolean|datasource|DateTime|Desc|enum|FieldReference|function|Int|JSON|model|sort|String)\\b"
+    },
+    {
+      "name": "string.quoted.double.zmodel",
+      "begin": "\"",
+      "end": "\""
+    },
+    {
+      "name": "string.quoted.single.zmodel",
+      "begin": "'",
+      "end": "'"
+    }
+  ],
+  "repository": {
+    "comments": {
+      "patterns": [
+        {
+          "name": "comment.block.zmodel",
+          "begin": "/\\*",
+          "beginCaptures": {
+            "0": {
+              "name": "punctuation.definition.comment.zmodel"
+            }
+          },
+          "end": "\\*/",
+          "endCaptures": {
+            "0": {
+              "name": "punctuation.definition.comment.zmodel"
+            }
+          }
+        },
+        {
+          "begin": "//",
+          "beginCaptures": {
+            "1": {
+              "name": "punctuation.whitespace.comment.leading.zmodel"
+            }
+          },
+          "end": "(?=$)",
+          "name": "comment.line.zmodel"
+        }
+      ]
+    }
+  }
+}