Generate grammar comments

eclipse-langium · Jan 8, 2024 · e1c45e6 · e1c45e6
1 parent 2ca2b3a
commit e1c45e6
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/examples/domainmodel/src/language-server/domain-model.langium b/examples/domainmodel/src/language-server/domain-model.langium
@@ -22,6 +22,9 @@ Entity:
         (features+=Feature)*
     '}';
 
+/**
+ * This comment should be generated into the grammar!
+ */
 Feature:
     (many?='many')? name=ID ':' type=[Type:QualifiedName];
 

diff --git a/examples/domainmodel/src/language-server/generated/grammar.ts b/examples/domainmodel/src/language-server/generated/grammar.ts
@@ -315,7 +315,8 @@ export const DomainModelGrammar = (): Grammar => loadedDomainModelGrammar ?? (lo
       "fragment": false,
       "hiddenTokens": [],
       "parameters": [],
-      "wildcard": false
+      "wildcard": false,
+      "$comment": "/**\\r\\n * This comment should be generated into the grammar!\\r\\n */"
     },
     {
       "$type": "ParserRule",

diff --git a/packages/langium-cli/src/generator/grammar-serializer.ts b/packages/langium-cli/src/generator/grammar-serializer.ts
@@ -36,6 +36,7 @@ export function serializeGrammar(services: LangiumServices, grammars: Grammar[],
                 };
                 const serializedGrammar = services.serializer.JsonSerializer.serialize(grammar, {
                     space: production ? undefined : 2,
+                    comments: true,
                     uriConverter
                 });
                 // The json serializer returns strings with \n line delimiter by default

diff --git a/packages/langium/src/grammar/langium-grammar.langium b/packages/langium/src/grammar/langium-grammar.langium
@@ -1,8 +1,9 @@
-/******************************************************************************
- * Copyright 2021 TypeFox GmbH
- * This program and the accompanying materials are made available under the
- * terms of the MIT License, which is available in the project root.
- ******************************************************************************/
+// ******************************************************************************
+// Copyright 2021 TypeFox GmbH
+// This program and the accompanying materials are made available under the
+// terms of the MIT License, which is available in the project root.
+// *****************************************************************************
+
 grammar LangiumGrammar
 
 entry Grammar: