Skip to content

Commit

Permalink
chore(config): cosmetic changes (prisma#26328)
Browse files Browse the repository at this point in the history
* chore(config): rename Effect "schemas" as "shapes"

* chore(config): rename PrismaConfig -> PrismaConfigInternal, PrismaConfigInput -> PrismaConfig; minor cosmetic changes to defaultConfig

* fix(config): turn PrismaConfigInternal into a nominal type

* chore(config): address review commment

* chore(config): fix lint

* chore: re-trigger CI

---------

Co-authored-by: jkomyno <[email protected]>
  • Loading branch information
jkomyno and jkomyno authored Feb 13, 2025
1 parent 74ed575 commit 9b8a021
Show file tree
Hide file tree
Showing 53 changed files with 172 additions and 164 deletions.
4 changes: 2 additions & 2 deletions packages/cli/src/CLI.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { ensureBinariesExist } from '@prisma/engines'
import type { Command, Commands } from '@prisma/internals'
import { arg, drawBox, format, HelpError, isError, link, logger, unknownCommand } from '@prisma/internals'
Expand All @@ -16,7 +16,7 @@ export class CLI implements Command {

private constructor(private readonly cmds: Commands, private readonly ensureBinaries: string[]) {}

async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/DebugInfo.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import type { Command } from '@prisma/internals'
import {
arg,
Expand Down Expand Up @@ -37,7 +37,7 @@ export class DebugInfo implements Command {
--schema Custom path to your Prisma schema
`)

async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Format.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import fs from 'node:fs/promises'
import path from 'node:path'

import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, format, formatms, formatSchema, HelpError, validate } from '@prisma/internals'
import { getSchemaPathAndPrint } from '@prisma/migrate'
import { bold, dim, red, underline } from 'kleur/colors'
Expand Down Expand Up @@ -37,7 +37,7 @@ Or specify a Prisma schema path
`)

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const before = Math.round(performance.now())
const args = arg(argv, {
'--help': Boolean,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Generate.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { enginesVersion } from '@prisma/engines'
import { SqlQueryOutput } from '@prisma/generator-helper'
import {
Expand Down Expand Up @@ -103,7 +103,7 @@ ${bold('Examples')}
this.logText += message.join('\n')
})

public async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Init.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { confirm, input, select } from '@inquirer/prompts'
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import type { ConnectorType } from '@prisma/generator-helper'
import {
arg,
Expand Down Expand Up @@ -221,7 +221,7 @@ export class Init implements Command {
${dim('$')} prisma init --with-model
`)

async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Studio.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import Debug from '@prisma/debug'
import { enginesVersion } from '@prisma/engines'
import {
Expand Down Expand Up @@ -79,7 +79,7 @@ ${bold('Examples')}
* @param argv Array of all arguments
* @param _config The loaded Prisma config
*/
public async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
6 changes: 3 additions & 3 deletions packages/cli/src/SubCommand.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { getCommand } from '@antfu/ni'
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import type { Command } from '@prisma/internals'
import { command } from 'execa'
import { existsSync } from 'fs'
Expand All @@ -9,7 +9,7 @@ import { tmpdir } from 'os'
* Sub-CLIs that are installed on demand need to implement this interface
*/
type Runnable = {
run: (args: string[], config: PrismaConfig) => Promise<void>
run: (args: string[], config: PrismaConfigInternal) => Promise<void>
}

/**
Expand All @@ -22,7 +22,7 @@ export class SubCommand implements Command {
this.pkg = pkg
}

async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
// we accept forcing a version with @, eg. prisma policy @1.0.0 --help
const [version, ...args] = argv[0]?.startsWith('@') ? argv : ['@latest', ...argv]
const pkg = `${this.pkg}${version}`
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Validate.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import path from 'node:path'

import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import {
arg,
Command,
Expand Down Expand Up @@ -51,7 +51,7 @@ ${bold('Examples')}
`)

public async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/Version.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { enginesVersion, getCliQueryEngineBinaryType } from '@prisma/engines'
import { getBinaryTargetForCurrentPlatform } from '@prisma/get-platform'
import type { Command } from '@prisma/internals'
Expand Down Expand Up @@ -47,7 +47,7 @@ export class Version implements Command {
--json Output JSON
`)

async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
'--help': Boolean,
'-h': '--help',
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/$.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command, Commands, link } from '@prisma/internals'

import { EarlyAccessFlagError } from '../utils/errors'
Expand Down Expand Up @@ -37,7 +37,7 @@ export class $ implements Command {
],
})

public async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
const isHasEarlyAccessFeatureFlag = Boolean(argv.find((_) => _.match(/early-access/)))
if (!isHasEarlyAccessFeatureFlag) throw new EarlyAccessFlagError()

Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/_lib/cli/dispatchToSubCommand.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Commands, HelpError, link } from '@prisma/internals'

export const dispatchToSubCommand = async (commands: Commands, argv: string[], config: PrismaConfig) => {
export const dispatchToSubCommand = async (commands: Commands, argv: string[], config: PrismaConfigInternal) => {
const commandName = argv[0]
if (!commandName) return new HelpError(`Unknown command.`)
const command = commands[commandName]
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/_lib/cli/namespace.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command, Commands } from '@prisma/internals'

import { dispatchToSubCommand } from './dispatchToSubCommand'
Expand All @@ -11,7 +11,7 @@ export const createNamespace = () => {

private constructor(public readonly commands: Commands) {}

public async parse(argv: string[], config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], config: PrismaConfigInternal): Promise<string | Error> {
return await dispatchToSubCommand(this.commands, argv, config)
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/accelerate/disable.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'

import { argOrThrow, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Disable implements Command {
return new Disable()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.environment,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/accelerate/enable.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError, link } from '@prisma/internals'

import { getOptionalParameter, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Enable implements Command {
return new Enable()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.environment,
'--url': String,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/auth/login.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { select } from '@inquirer/prompts'
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import Debug from '@prisma/debug'
import { arg, Command, getCommandWithExecutor, isError, link } from '@prisma/internals'
import listen from 'async-listen'
Expand Down Expand Up @@ -29,7 +29,7 @@ export class Login implements Command {
return new Login()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
// internal optimize flag to track signup attribution
'--optimize': Boolean,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/auth/show.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'
import { green } from 'kleur/colors'

Expand All @@ -12,7 +12,7 @@ export class Show implements Command {
return new Show()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.global,
'--sensitive': Boolean,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/environment/create.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'

import { argOrThrow, getOptionalParameter, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Create implements Command {
return new Create()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.project,
'--name': String,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/environment/delete.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError } from '@prisma/internals'

import { getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Delete implements Command {
return new Delete()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.environment,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/environment/show.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError } from '@prisma/internals'

import { getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Show implements Command {
return new Show()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.project,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/project/create.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'

import { argOrThrow, getOptionalParameter, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Create implements Command {
return new Create()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.workspace,
'--name': String,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/project/delete.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError } from '@prisma/internals'

import { getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Delete implements Command {
return new Delete()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.project,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/project/show.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError } from '@prisma/internals'

import { getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Show implements Command {
return new Show()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.workspace,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/pulse/disable.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'

import { argOrThrow, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Disable implements Command {
return new Disable()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.environment,
})
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/pulse/enable.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { arg, Command, isError, link } from '@prisma/internals'

import { getOptionalParameter, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -11,7 +11,7 @@ export class Enable implements Command {
return new Enable()
}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = arg(argv, {
...platformParameters.environment,
'--url': String,
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/platform/serviceToken/create.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PrismaConfig } from '@prisma/config'
import type { PrismaConfigInternal } from '@prisma/config'
import { Command } from '@prisma/internals'

import { argOrThrow, getOptionalParameter, getRequiredParameterOrThrow } from '../_lib/cli/parameters'
Expand All @@ -13,7 +13,7 @@ export class Create implements Command {

constructor(private readonly legacy: boolean = false) {}

public async parse(argv: string[], _config: PrismaConfig): Promise<string | Error> {
public async parse(argv: string[], _config: PrismaConfigInternal): Promise<string | Error> {
const args = argOrThrow(argv, {
...platformParameters.environment,
'--name': String,
Expand Down
Loading

0 comments on commit 9b8a021

Please sign in to comment.