fix: update zmodel code generator

- include imports in output
- fix indentaions
- include comments in output

Author: svetch

packages/sdk/src/zmodel-code-generator.ts

@@ -72,14 +72,15 @@ function gen(name: string) {
  */
 export class ZModelCodeGenerator {
     private readonly options: ZModelCodeOptions;
-
+    private readonly quote: string;
     constructor(options?: Partial<ZModelCodeOptions>) {
         this.options = {
             binaryExprNumberOfSpaces: options?.binaryExprNumberOfSpaces ?? 1,
             unaryExprNumberOfSpaces: options?.unaryExprNumberOfSpaces ?? 0,
             indent: options?.indent ?? 4,
             quote: options?.quote ?? 'single',
         };
+        this.quote = this.options.quote === 'double' ? '"' : "'";
     }
 
     /**
@@ -93,9 +94,14 @@ export class ZModelCodeGenerator {
         return handler.value.call(this, ast);
     }
 
+    private quotedStr(val: string): string {
+        const trimmedVal = val.replace(new RegExp(`${this.quote}`, 'g'), `\\${this.quote}`);
+        return `${this.quote}${trimmedVal}${this.quote}`;
+    }
+
     @gen(Model)
     private _generateModel(ast: Model) {
-        return ast.declarations.map((d) => this.generate(d)).join('\n\n');
+        return `${ast.imports.map((d) => this.generate(d)).join('\n')}\n\n${ast.declarations.map((d) => this.generate(d)).join('\n\n')}`;
     }
 
     @gen(DataSource)
@@ -107,16 +113,17 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}
 
     @gen(ModelImport)
     private _generateModelImport(ast: ModelImport) {
-        return `import '${ast.path}'`;
+        return `import ${this.quotedStr(ast.path)}`;
     }
 
     @gen(Enum)
     private _generateEnum(ast: Enum) {
         return `enum ${ast.name} {
-${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${ast.attributes.length > 0
+${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${
+            ast.attributes.length > 0
                 ? '\n\n' + ast.attributes.map((x) => this.indent + this.generate(x)).join('\n')
                 : ''
-            }
+        }
 }`;
     }
 
@@ -136,7 +143,9 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}
 
     @gen(ConfigField)
     private _generateConfigField(ast: ConfigField) {
-        return `${ast.name} = ${this.generate(ast.value)}`;
+        const longestName = Math.max(...ast.$container.fields.map((x) => x.name.length));
+        const padding = ' '.repeat(longestName - ast.name.length + 1);
+        return `${ast.name}${padding}= ${this.generate(ast.value)}`;
     }
 
     @gen(ConfigArrayExpr)
@@ -164,15 +173,24 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}
 
     @gen(PluginField)
     private _generatePluginField(ast: PluginField) {
-        return `${ast.name} = ${this.generate(ast.value)}`;
+        const longestName = Math.max(...ast.$container.fields.map((x) => x.name.length));
+        const padding = ' '.repeat(longestName - ast.name.length + 1);
+        return `${ast.name}${padding}= ${this.generate(ast.value)}`;
     }
 
     @gen(DataModel)
     private _generateDataModel(ast: DataModel) {
-        return `${ast.isView ? 'view' : 'model'} ${ast.name}${
+        const comments = `${ast.comments.join('\n')}\n`;
+
+        return `${ast.comments.length > 0 ? comments : ''}${ast.isView ? 'view' : 'model'} ${ast.name}${
             ast.mixins.length > 0 ? ' mixes ' + ast.mixins.map((x) => x.ref?.name).join(', ') : ''
         } {
-${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${
+${ast.fields
+    .map((x) => {
+        const comments = x.comments.map((c) => `${this.indent}${c}`).join('\n');
+        return (x.comments.length ? `${comments}\n` : '') + this.indent + this.generate(x);
+    })
+    .join('\n')}${
             ast.attributes.length > 0
                 ? '\n\n' + ast.attributes.map((x) => this.indent + this.generate(x)).join('\n')
                 : ''
@@ -182,7 +200,11 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${
 
     @gen(DataField)
     private _generateDataField(ast: DataField) {
-        return `${ast.name} ${this.fieldType(ast.type)}${
+        const longestFieldName = Math.max(...ast.$container.fields.map((f) => f.name.length));
+        const longestType = Math.max(...ast.$container.fields.map((f) => this.fieldType(f.type).length));
+        const paddingLeft = longestFieldName - ast.name.length;
+        const paddingRight = ast.attributes.length > 0 ? longestType - this.fieldType(ast.type).length : 0;
+        return `${ast.name}${' '.repeat(paddingLeft)} ${this.fieldType(ast.type)}${' '.repeat(paddingRight)}${
             ast.attributes.length > 0 ? ' ' + ast.attributes.map((x) => this.generate(x)).join(' ') : ''
         }`;
     }
@@ -236,7 +258,7 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${
 
     @gen(StringLiteral)
     private _generateLiteralExpr(ast: LiteralExpr) {
-        return this.options.quote === 'single' ? `'${ast.value}'` : `"${ast.value}"`;
+        return this.quotedStr(ast.value as string);
     }
 
     @gen(NumberLiteral)
@@ -279,7 +301,7 @@ ${ast.fields.map((x) => this.indent + this.generate(x)).join('\n')}${
 
     @gen(ReferenceArg)
     private _generateReferenceArg(ast: ReferenceArg) {
-        return `${ast.name}:${this.generate(ast.value)}`;
+        return `${ast.name}: ${this.generate(ast.value)}`;
     }
 
     @gen(MemberAccessExpr)