Skip to content

Prisma DMMF parses comments as fields docs #1987

@MichalLytek

Description

@MichalLytek

Bug description

I'm using latest alpha.980 and I've discovered that it now parses the comments // as docs for the fields:

{
  "name": "author",
  "kind": "object",
  "dbNames": [],
  "isList": false,
  "isRequired": true,
  "isUnique": false,
  "isId": false,
  "type": "User",
  "relationName": "PostToUser",
  "relationToFields": [
    "id"
  ],
  "relationOnDelete": "NONE",
  "isGenerated": false,
  "isUpdatedAt": false,
  "documentation": "coAuthor  User?\r"
},

Even worse, it also parse whole comments of model/enum field as base level docs:

{
  "name": "Role",
  "values": [
    {
      "name": "USER",
      "dbName": null
    },
    {
      "name": "ADMIN",
      "dbName": null
    }
  ],
  "dbName": null,
  "documentation": "/ Role enum comment\r\nUSER = \"User\"\r\nADMIN = \"Admin\"\r"
}

Expected behavior

It should parse the docs and comments just like in preview024.

Prisma information

model Post {
  uuid      String    @default(uuid()) @id
  createdAt DateTime  @default(now())
  updatedAt DateTime  @updatedAt
  published Boolean
  title     String
  content   String?
  // coAuthor  User?
  author    User
  kind      PostKind?
}
/// Role enum comment
enum Role {
  // USER = "User"
  USER
  // ADMIN = "Admin"
  ADMIN
}

Environment & setup

  • OS: [e.g. Mac OS, Windows, Debian, CentOS, ...] Win 10 x64
  • Database: [PostgreSQL, MySQL, MariaDB or SQLite] ---
  • Prisma version: [Run prisma2 -v to see your Prisma version] alpha 980
  • Node.js version: [Run node -v to see your Node.js version] 13.11

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions