Skip to content

Commit af4308e

Browse files
committed
feat(table): add table documentation
1 parent cdf38aa commit af4308e

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

prisma/dbml/schema.dbml

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Table Profile {
1414
bio String
1515
user User [not null]
1616
userId Int [unique, not null]
17+
18+
Note: 'User profile'
1719
}
1820

1921
Table Post {

src/index.ts

+10-1
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,19 @@ generatorHandler({
4444

4545
const generateTables = (models: DMMF.Model[]): string[] => {
4646
return models.map(
47-
(model) => `Table ${model.name} {\n` + generateFields(model.fields) + '\n}'
47+
(model) =>
48+
`Table ${model.name} {\n` +
49+
generateFields(model.fields) +
50+
generateTableDocumentation(model) +
51+
'\n}'
4852
);
4953
};
5054

55+
const generateTableDocumentation = (model: DMMF.Model): string => {
56+
const doc = (model as any).documentation;
57+
return doc ? `\n\n\tNote: '${doc}'` : '';
58+
};
59+
5160
const generateFields = (fields: DMMF.Field[]): string => {
5261
return fields
5362
.map(

0 commit comments

Comments
 (0)