Add --quiet flag to keystone CLI (#9682)

Co-authored-by: Daniel Cousens <dcousens@users.noreply.github.com>

Author: dcousens

.changeset/add-quiet.md

@@ -0,0 +1,5 @@
+---
+"@keystone-6/core": minor
+---
+
+Add a `--quiet' flag to `keystone` CLI commands, suppressing most output except for errors

packages/core/src/___internal-do-not-use-will-break-in-patch/artifacts.ts

@@ -1,5 +1,5 @@
-export { createExpressServer } from '../lib/createExpressServer'
-export { createSystem } from '../lib/createSystem'
+export { buildArtifacts, generateArtifacts } from '../artifacts'
+export { createExpressServer } from '../lib/express'
 export { withMigrate } from '../lib/migrations'
-export { generateArtifacts, getArtifacts } from '../artifacts'
+export { createSystem } from '../lib/system'
 export { ExitError } from '../scripts/utils'

packages/core/src/admin-ui/system/generateAdminUI.ts

@@ -1,11 +1,12 @@
+import { type Entry, walk as _walk } from '@nodelib/fs.walk'
+import fse from 'fs-extra'
+import fs from 'node:fs/promises'
 import Path from 'node:path'
 import { promisify } from 'node:util'
-import fs from 'node:fs/promises'
-import fse from 'fs-extra'
-import { type Entry, walk as _walk } from '@nodelib/fs.walk'
+
+import type { AdminMetaSource } from '../../lib/admin-meta'
 import type { AdminFileToWrite, KeystoneConfig } from '../../types'
 import { writeAdminFiles } from '../templates'
-import type { AdminMetaSource } from '../../lib/create-admin-meta'
 
 const walk = promisify(_walk)
 

packages/core/src/admin-ui/templates/app.ts

@@ -1,7 +1,7 @@
-import Path from 'path'
+import Path from 'node:path'
 import resolve from 'resolve'
 
-import type { AdminMetaSource } from '../../lib/create-admin-meta'
+import type { AdminMetaSource } from '../../lib/admin-meta'
 import type { KeystoneConfig } from '../../types'
 
 function doesConfigExist(path: string[]) {

packages/core/src/admin-ui/templates/index.ts

@@ -1,13 +1,14 @@
-import path from 'path'
+import path from 'node:path'
+
+import type { AdminMetaSource } from '../../lib/admin-meta'
 import type { KeystoneConfig } from '../../types'
-import type { AdminMetaSource } from '../../lib/create-admin-meta'
 import { appTemplate } from './app'
+import { createItemTemplate } from './create-item'
 import { homeTemplate } from './home'
-import { listTemplate } from './list'
 import { itemTemplate } from './item'
-import { noAccessTemplate } from './no-access'
-import { createItemTemplate } from './create-item'
+import { listTemplate } from './list'
 import { nextConfigTemplate } from './next-config'
+import { noAccessTemplate } from './no-access'
 
 const pkgDir = path.dirname(require.resolve('@keystone-6/core/package.json'))
 

packages/core/src/artifacts.ts

@@ -1,13 +1,11 @@
+import type { ChildProcess } from 'node:child_process'
 import fs from 'node:fs/promises'
 import path from 'node:path'
-import type { ChildProcess } from 'node:child_process'
 
+import { formatSchema, getGenerators } from '@prisma/internals'
 import { printSchema } from 'graphql'
-import { getGenerators, formatSchema } from '@prisma/internals'
-import { ExitError } from './scripts/utils'
-import { initialiseLists } from './lib/core/initialise-lists'
-import { type System, getSystemPaths } from './lib/createSystem'
 import { printPrismaSchema } from './lib/core/prisma-schema-printer'
+import type { System } from './lib/system'
 import { printGeneratedTypes } from './lib/typescript-schema-printer'
 
 export function getFormattedGraphQLSchema(schema: string) {
@@ -30,32 +28,29 @@ async function readFileOrUndefined(path: string) {
 
 export async function validateArtifacts(cwd: string, system: System) {
   const paths = system.getPaths(cwd)
-  const artifacts = await getArtifacts(system)
+  const artifacts = await buildArtifacts(system)
   const [writtenGraphQLSchema, writtenPrismaSchema] = await Promise.all([
     readFileOrUndefined(paths.schema.graphql),
     readFileOrUndefined(paths.schema.prisma),
   ])
 
   if (writtenGraphQLSchema !== artifacts.graphql && writtenPrismaSchema !== artifacts.prisma) {
-    console.error('Your Prisma and GraphQL schemas are not up to date')
-    throw new ExitError(1)
+    throw new Error('Your Prisma and GraphQL schemas are not up to date')
   }
 
   if (writtenGraphQLSchema !== artifacts.graphql) {
-    console.error('Your GraphQL schema is not up to date')
-    throw new ExitError(1)
+    throw new Error('Your GraphQL schema is not up to date')
   }
 
   if (writtenPrismaSchema !== artifacts.prisma) {
-    console.error('Your Prisma schema is not up to date')
-    throw new ExitError(1)
+    throw new Error('Your Prisma schema is not up to date')
   }
 }
 
-export async function getArtifacts(system: System) {
-  const lists = initialiseLists(system.config)
+// exported for tests
+export async function buildArtifacts(system: System) {
   const prismaSchema = await formatSchema({
-    schemas: [[system.config.db.prismaSchemaPath, printPrismaSchema(system.config, lists)]],
+    schemas: [[system.config.db.prismaSchemaPath, printPrismaSchema(system.config, system.lists)]],
   })
 
   return {
@@ -65,15 +60,15 @@ export async function getArtifacts(system: System) {
 }
 
 export async function generateArtifacts(cwd: string, system: System) {
-  const paths = getSystemPaths(cwd, system.config)
-  const artifacts = await getArtifacts(system)
+  const paths = system.getPaths(cwd)
+  const artifacts = await buildArtifacts(system)
   await fs.writeFile(paths.schema.graphql, artifacts.graphql)
   await fs.writeFile(paths.schema.prisma, artifacts.prisma)
   return artifacts
 }
 
 export async function generateTypes(cwd: string, system: System) {
-  const paths = getSystemPaths(cwd, system.config)
+  const paths = system.getPaths(cwd)
   const schema = printGeneratedTypes(
     paths.types.relativePrismaPath,
     system.graphQLSchemaSudo,
@@ -84,7 +79,7 @@ export async function generateTypes(cwd: string, system: System) {
 }
 
 export async function generatePrismaClient(cwd: string, system: System) {
-  const paths = getSystemPaths(cwd, system.config)
+  const paths = system.getPaths(cwd)
   const generators = await getGenerators({
     schemaPath: paths.schema.prisma,
   })

packages/core/src/context.ts

@@ -1,11 +1 @@
-import type { BaseKeystoneTypeInfo, KeystoneConfig, KeystoneContext } from './types'
-import { createSystem } from './lib/createSystem'
-
-export function getContext<TypeInfo extends BaseKeystoneTypeInfo>(
-  config: KeystoneConfig<TypeInfo>,
-  PrismaModule: unknown
-): KeystoneContext<TypeInfo> {
-  const system = createSystem(config)
-  const { context } = system.getKeystone(PrismaModule)
-  return context
-}
+export { getContext } from './lib/system'

packages/core/src/fields/types/relationship/index.ts

@@ -1,8 +1,5 @@
 import { g } from '../../..'
-import {
-  type ListMetaSource,
-  getAdminMetaForRelationshipField,
-} from '../../../lib/create-admin-meta'
+import { type ListMetaSource, getAdminMetaForRelationshipField } from '../../../lib/admin-meta'
 import type { JSONValue } from '../../../types'
 import {
   type BaseListTypeInfo,

packages/core/src/lib/create-admin-meta.ts renamed to packages/core/src/lib/admin-meta.ts

@@ -1,7 +1,8 @@
-import type { GraphQLSchema, VariableDefinitionNode, GraphQLInputType, GraphQLError } from 'graphql'
+import type { GraphQLError, GraphQLInputType, GraphQLSchema, VariableDefinitionNode } from 'graphql'
 import { Kind } from 'graphql'
 import { getVariableValues } from 'graphql/execution/values'
-import { getTypeNodeForType } from './context/executeGraphQLFieldToSource'
+
+import { getTypeNodeForType } from './context/graphql'
 
 const argName = 'where'