Add comments explaining that the schema files are generated in the sc…

…hema files (#6397)
keystonejs · Aug 23, 2021 · c76bfc0 · c76bfc0
1 parent f65cf67
commit c76bfc0
Show file tree

Hide file tree

Showing 57 changed files with 177 additions and 2 deletions.
diff --git a/.changeset/fresh-spies-double.md b/.changeset/fresh-spies-double.md
@@ -0,0 +1,5 @@
+---
+'@keystone-next/keystone': patch
+---
+
+Added a comment in the `schema.prisma` and `schema.graphql` files explaining that they're generated and should not be modified manually.
diff --git a/examples-staging/assets-cloud/schema.graphql b/examples-staging/assets-cloud/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples-staging/assets-cloud/schema.prisma b/examples-staging/assets-cloud/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/assets-local/schema.graphql b/examples-staging/assets-local/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples-staging/assets-local/schema.prisma b/examples-staging/assets-local/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/auth/schema.graphql b/examples-staging/auth/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 input CreateInitialUserInput {
   name: String
   email: String

diff --git a/examples-staging/auth/schema.prisma b/examples-staging/auth/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/basic/schema.graphql b/examples-staging/basic/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type RandomNumber {
   number: Int
   generatedAt: Int

diff --git a/examples-staging/basic/schema.prisma b/examples-staging/basic/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/ecommerce/schema.graphql b/examples-staging/ecommerce/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Mutation {
   addToCart(productId: ID): CartItem
   checkout(token: String!): Order

diff --git a/examples-staging/ecommerce/schema.prisma b/examples-staging/ecommerce/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/embedded-nextjs/schema.graphql b/examples-staging/embedded-nextjs/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples-staging/embedded-nextjs/schema.prisma b/examples-staging/embedded-nextjs/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/graphql-api-endpoint/schema.graphql b/examples-staging/graphql-api-endpoint/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 input CreateInitialUserInput {
   name: String
   email: String

diff --git a/examples-staging/graphql-api-endpoint/schema.prisma b/examples-staging/graphql-api-endpoint/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource postgresql {
   url      = env("DATABASE_URL")
   provider = "postgresql"

diff --git a/examples-staging/playground/schema.graphql b/examples-staging/playground/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Note {
   id: ID!
   label: String

diff --git a/examples-staging/playground/schema.prisma b/examples-staging/playground/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/roles/schema.graphql b/examples-staging/roles/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 input CreateInitialPersonInput {
   name: String
   email: String

diff --git a/examples-staging/roles/schema.prisma b/examples-staging/roles/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples-staging/sandbox/schema.graphql b/examples-staging/sandbox/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Todo {
   id: ID!
   label: String

diff --git a/examples-staging/sandbox/schema.prisma b/examples-staging/sandbox/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/blog/schema.graphql b/examples/blog/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples/blog/schema.prisma b/examples/blog/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/custom-admin-ui-logo/schema.graphql b/examples/custom-admin-ui-logo/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/custom-admin-ui-logo/schema.prisma b/examples/custom-admin-ui-logo/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/custom-admin-ui-navigation/schema.graphql b/examples/custom-admin-ui-navigation/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/custom-admin-ui-navigation/schema.prisma b/examples/custom-admin-ui-navigation/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/custom-admin-ui-pages/schema.graphql b/examples/custom-admin-ui-pages/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/custom-admin-ui-pages/schema.prisma b/examples/custom-admin-ui-pages/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/custom-field-view/schema.graphql b/examples/custom-field-view/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/custom-field-view/schema.prisma b/examples/custom-field-view/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/custom-field/schema.graphql b/examples/custom-field/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples/custom-field/schema.prisma b/examples/custom-field/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/default-values/schema.graphql b/examples/default-values/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/default-values/schema.prisma b/examples/default-values/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/document-field/schema.graphql b/examples/document-field/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples/document-field/schema.prisma b/examples/document-field/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/extend-graphql-schema/schema.graphql b/examples/extend-graphql-schema/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Mutation {
   """
    Publish a post

diff --git a/examples/extend-graphql-schema/schema.prisma b/examples/extend-graphql-schema/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/json/schema.graphql b/examples/json/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Package {
   id: ID!
   label: String

diff --git a/examples/json/schema.prisma b/examples/json/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/task-manager/schema.graphql b/examples/task-manager/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/examples/task-manager/schema.prisma b/examples/task-manager/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/testing/schema.graphql b/examples/testing/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 input CreateInitialPersonInput {
   name: String
   email: String

diff --git a/examples/testing/schema.prisma b/examples/testing/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/virtual-field/schema.graphql b/examples/virtual-field/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Post {
   id: ID!
   title: String

diff --git a/examples/virtual-field/schema.prisma b/examples/virtual-field/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/examples/with-auth/schema.graphql b/examples/with-auth/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 input CreateInitialPersonInput {
   name: String
   email: String

diff --git a/examples/with-auth/schema.prisma b/examples/with-auth/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/packages/keystone/src/artifacts.ts b/packages/keystone/src/artifacts.ts
@@ -34,7 +34,12 @@ export async function getCommittedArtifacts(
     'node_modules/.prisma/client'
   );
   return {
-    graphql: format(printSchema(graphQLSchema), { parser: 'graphql' }),
+    graphql: format(
+      '# This file is automatically generated by Keystone, do not modify it manually.\n' +
+        '# Modify your Keystone config when you want to change this.\n\n' +
+        printSchema(graphQLSchema),
+      { parser: 'graphql' }
+    ),
     prisma: await formatSchema({
       schema: prismaSchema,
     }),

diff --git a/packages/keystone/src/lib/core/prisma-schema.ts b/packages/keystone/src/lib/core/prisma-schema.ts
@@ -195,7 +195,10 @@ export function printPrismaSchema(
   provider: DatabaseProvider,
   clientDir: string
 ) {
-  let prismaSchema = `datasource ${provider} {
+  let prismaSchema = `// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
+datasource ${provider} {
   url = env("DATABASE_URL")
   provider = "${provider}"
 }

diff --git a/packages/keystone/src/scripts/tests/fixtures/basic-project/schema.graphql b/packages/keystone/src/scripts/tests/fixtures/basic-project/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Todo {
   id: ID!
   title: String

diff --git a/packages/keystone/src/scripts/tests/fixtures/basic-project/schema.prisma b/packages/keystone/src/scripts/tests/fixtures/basic-project/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"

diff --git a/tests/test-projects/basic/schema.graphql b/tests/test-projects/basic/schema.graphql
@@ -1,3 +1,6 @@
+# This file is automatically generated by Keystone, do not modify it manually.
+# Modify your Keystone config when you want to change this.
+
 type Task {
   id: ID!
   label: String

diff --git a/tests/test-projects/basic/schema.prisma b/tests/test-projects/basic/schema.prisma
@@ -1,3 +1,6 @@
+// This file is automatically generated by Keystone, do not modify it manually.
+// Modify your Keystone config when you want to change this.
+
 datasource sqlite {
   url      = env("DATABASE_URL")
   provider = "sqlite"