Function formatSchema

packages/internals/src/engine-commands/formatSchema.ts:13–61

(
  { schemas }: FormatSchemaParams,
  inputFormattingOptions?: Partial<DocumentFormattingParams['options']>,
)

type FormatSchemaParams = { schemas: MultipleSchemas }

export async function formatSchema(
  { schemas }: FormatSchemaParams,
  inputFormattingOptions?: Partial<DocumentFormattingParams['options']>,
): Promise<MultipleSchemas> {
  if (process.env.FORCE_PANIC_PRISMA_SCHEMA) {
    handleFormatPanic(() => {
      prismaSchemaWasm.debug_panic()
    })
  }

  const defaultFormattingOptions: DocumentFormattingParams['options'] = {
    tabSize: 2,
    insertSpaces: true,
  }

  const documentFormattingParams = {
    textDocument: { uri: 'file:/dev/null' },
    options: {
      ...defaultFormattingOptions,
      ...inputFormattingOptions,
    },
  } as DocumentFormattingParams

  /**
   * Note:
   * - Given an invalid schema, `formatWasm` returns a formatted schema regardless (when it doesn't panic).
   * - Given an invalid schema, `lintSchema` returns a list of warnings/errors regardless (when it doesn't panic).
   *   Warnings must be filtered out from the other diagnostics.
   * - Validation errors aren't checked/shown here.
   *   They appear when calling `getDmmf` on the formatted schema in Format.ts.
   *   If we called `getConfig` instead, we wouldn't have any validation check.
   */
  const { formattedMultipleSchemas, lintDiagnostics } = handleFormatPanic(() => {
    // the only possible error here is a Rust panic
    const formattedMultipleSchemasRaw = formatWasm(JSON.stringify(schemas), documentFormattingParams)
    const formattedMultipleSchemas = JSON.parse(formattedMultipleSchemasRaw) as MultipleSchemas

    const lintDiagnostics = lintSchema({ schemas: formattedMultipleSchemas })
    return { formattedMultipleSchemas, lintDiagnostics }
  })

  const lintWarnings = getLintWarningsAsText(lintDiagnostics)
  if (lintWarnings && logger.should.warn()) {
    // Output warnings to stderr
    console.warn(lintWarnings)
  }

  return Promise.resolve(formattedMultipleSchemas)
}

function handleFormatPanic<T>(tryCb: () => T) {
  try {