update

Author: ymc9

packages/schema/src/language-server/zmodel-documentation-provider.ts

@@ -5,7 +5,7 @@ import { AstNode, JSDocDocumentationProvider } from 'langium';
  */
 export class ZModelDocumentationProvider extends JSDocDocumentationProvider {
     getDocumentation(node: AstNode): string | undefined {
-        // prefer to user triple-slash comments
+        // prefer to use triple-slash comments
         if ('comments' in node && Array.isArray(node.comments) && node.comments.length > 0) {
             return node.comments.map((c: string) => c.replace(/^[/]*\s*/, '')).join('\n');
         }

packages/schema/src/plugins/prisma/schema-generator.ts

@@ -100,6 +100,7 @@ export class PrismaSchemaGenerator {
 `;
 
     private mode: 'logical' | 'physical' = 'physical';
+    private customAttributesAsComments = false;
 
     // a mapping from full names to shortened names
     private shortNameMap = new Map<string, string>();
@@ -117,6 +118,14 @@ export class PrismaSchemaGenerator {
             this.mode = options.mode as 'logical' | 'physical';
         }
 
+        if (
+            options.customAttributesAsComments !== undefined &&
+            typeof options.customAttributesAsComments !== 'boolean'
+        ) {
+            throw new PluginError(name, 'option "customAttributesAsComments" must be a boolean');
+        }
+        this.customAttributesAsComments = options.customAttributesAsComments === true;
+
         const prismaVersion = getPrismaVersion();
         if (prismaVersion && semver.lt(prismaVersion, PRISMA_MINIMUM_VERSION)) {
             warnings.push(
@@ -284,10 +293,7 @@ export class PrismaSchemaGenerator {
 
         // user defined comments pass-through
         decl.comments.forEach((c) => model.addComment(c));
-
-        decl.attributes
-            .filter((attr) => attr.decl.ref && !this.isPrismaAttribute(attr))
-            .forEach((attr) => model.addComment('/// - _' + this.zModelGenerator.generate(attr) + '_'));
+        this.getCustomAttributesAsComments(decl).forEach((c) => model.addComment(c));
 
         // generate relation fields on base models linking to concrete models
         this.generateDelegateRelationForBase(model, decl);
@@ -763,12 +769,8 @@ export class PrismaSchemaGenerator {
             )
             .map((attr) => this.makeFieldAttribute(attr));
 
-        const nonPrismaAttributes = field.attributes.filter((attr) => attr.decl.ref && !this.isPrismaAttribute(attr));
-
         // user defined comments pass-through
-        const docs: string[] = [...field.comments];
-        docs.push(...nonPrismaAttributes.map((attr) => '/// - _' + this.zModelGenerator.generate(attr) + '_'));
-
+        const docs = [...field.comments, ...this.getCustomAttributesAsComments(field)];
         const result = model.addField(field.name, type, attributes, docs, addToFront);
 
         if (this.mode === 'logical') {
@@ -900,23 +902,27 @@ export class PrismaSchemaGenerator {
 
         // user defined comments pass-through
         decl.comments.forEach((c) => _enum.addComment(c));
-
-        decl.attributes
-            .filter((attr) => attr.decl.ref && !this.isPrismaAttribute(attr))
-            .forEach((attr) => _enum.addComment('/// - _' + this.zModelGenerator.generate(attr) + '_'));
+        this.getCustomAttributesAsComments(decl).forEach((c) => _enum.addComment(c));
     }
 
     private generateEnumField(_enum: PrismaEnum, field: EnumField) {
         const attributes = field.attributes
             .filter((attr) => this.isPrismaAttribute(attr))
             .map((attr) => this.makeFieldAttribute(attr));
 
-        const nonPrismaAttributes = field.attributes.filter((attr) => attr.decl.ref && !this.isPrismaAttribute(attr));
-
-        const docs = [...field.comments];
-        docs.push(...nonPrismaAttributes.map((attr) => '/// - _' + this.zModelGenerator.generate(attr) + '_'));
+        const docs = [...field.comments, ...this.getCustomAttributesAsComments(field)];
         _enum.addField(field.name, attributes, docs);
     }
+
+    private getCustomAttributesAsComments(decl: DataModel | DataModelField | Enum | EnumField) {
+        if (!this.customAttributesAsComments) {
+            return [];
+        } else {
+            return decl.attributes
+                .filter((attr) => attr.decl.ref && !this.isPrismaAttribute(attr))
+                .map((attr) => `/// ${this.zModelGenerator.generate(attr)}`);
+        }
+    }
 }
 
 function isDescendantOf(model: DataModel, superModel: DataModel): boolean {

packages/schema/tests/generator/prisma-generator.test.ts

@@ -85,6 +85,7 @@ describe('Prisma generator test', () => {
             schemaPath: 'schema.zmodel',
             output: 'schema.prisma',
             format: false,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync('schema.prisma', 'utf-8');
@@ -96,9 +97,9 @@ describe('Prisma generator test', () => {
         );
         expect(content).toContain('schemas = ["auth", "public"]');
         expect(content).toContain('/// My user model');
-        expect(content).toContain(`/// - _@@allow('all', true)_`);
+        expect(content).toContain(`/// @@allow('all', true)`);
         expect(content).toContain(`/// the id field`);
-        expect(content).toContain(`/// - _@allow('read', this == auth())_`);
+        expect(content).toContain(`/// @allow('read', this == auth())`);
         expect(content).not.toContain('/// My post model');
         expect(content).toContain('/// User roles');
         expect(content).toContain('/// Admin role');
@@ -205,6 +206,7 @@ describe('Prisma generator test', () => {
             provider: '@core/prisma',
             schemaPath: 'schema.zmodel',
             output: name,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync(name, 'utf-8');
@@ -237,6 +239,7 @@ describe('Prisma generator test', () => {
             provider: '@core/prisma',
             schemaPath: 'schema.zmodel',
             output: name,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync(name, 'utf-8');
@@ -430,6 +433,7 @@ describe('Prisma generator test', () => {
             schemaPath: 'schema.zmodel',
             output: name,
             generateClient: false,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync(name, 'utf-8');
@@ -480,6 +484,7 @@ describe('Prisma generator test', () => {
             schemaPath: 'schema.zmodel',
             output: name,
             format: true,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync(name, 'utf-8');
@@ -511,6 +516,7 @@ describe('Prisma generator test', () => {
             schemaPath: 'schema.zmodel',
             output: name,
             format: true,
+            customAttributesAsComments: true,
         });
 
         const content = fs.readFileSync(name, 'utf-8');