Skip to content

Commit

Permalink
Add prisma (withfig#347)
Browse files Browse the repository at this point in the history 
* Add prisma
Based on CLI docs
https://www.prisma.io/docs/reference/api-reference/command-reference/

* Add prisma via npx

* Refacto, and add some icons

* Apply recommendation from @QuiiBz
Add isDangerous, when data could be lost.

* Add prisma on yarn file

* Schema args is NOT optional
  • Loading branch information
@xlanex6
xlanex6 authored Jul 7, 2021
1 parent c6c5e9a commit d2f99dd
Show file tree
Hide file tree
Showing 3 changed files with 277 additions and 1 deletion.
6 changes: 6 additions & 0 deletions dev/npx.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ export const completionSpec: Fig.Spec = {
icon: "https://raw.githubusercontent.com/pmndrs/branding/master/logo.svg",
loadSpec: "gltfjsx",
},
{
name: "prisma",
icon:
"https://raw.githubusercontent.com/prisma/docs/main/src/images/favicon-16x16.png",
loadSpec: "prisma",
},
],
options: [
{
Expand Down
270 changes: 270 additions & 0 deletions dev/prisma.ts
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,270 @@
const commonOptions: Fig.Option = {
name: ["-h", "--help"],
description: "Display this help message",
};
const schemaOptions: Fig.Option = {
name: "--schema",
description: "Custom path to your Prisma schema",
args: {
name: "Schema path",
template: "filepaths",
},
};
const skipOptions: Fig.Option[] = [
{
name: "--skip-seed",
description: "Skip triggering seed",
},
{
name: "--skip-generate",
description: "Skip triggering generators (e.g. Prisma Client)",
},
];

export const completionSpec: Fig.Spec = {
name: "prisma",
description:
"Prisma is a modern DB toolkit to query, migrate and model your database",
icon:
"https://raw.githubusercontent.com/prisma/docs/main/src/images/favicon-16x16.png",
subcommands: [
{
name: "init",
description: "Setup Prisma for your app",
options: [
commonOptions,
{
name: "--datasource-provider",
description: "Define the datasource provider to use",
args: {
description: "Choose provider",
suggestions: ["PostgreSQL", "MySQL", "SQLServer", "SQLite"],
default: "PostgreSQL",
},
},
{
name: "--url",
description: "Define a custom datasource url",
args: {
name: "full url",
template: "filepaths",
isOptional: false,
},
},
],
},
{
name: "introspect",
description: "Get the datamodel of your database",
options: [
commonOptions,
{
name: "--force",
description: "Ignore current Prisma schema file",
isDangerous: true,
},
{
name: "--print",
description: "Print the introspected Prisma schema to stdout",
},
schemaOptions,
],
},
{
name: "generate",
description: "Generate artifacts",
options: [
commonOptions,
schemaOptions,
{
name: "--watch",
description: "Watch the Prisma schema and rerun after a change",
},
],
},
{
name: "studio",
description: "Open Prisma Studio",
options: [
commonOptions,
schemaOptions,
{
name: ["-p", "--port"],
description: "Port to start Studio on",
args: {
name: "port",
},
},
{
name: ["-b", "--browser"],
description: "Browser to open Studio in",
args: {
name: "Browser choice",
suggestions: ["firefox", "chrome", "safari", "none"],
},
},
{
name: ["-n", "--hostname"],
description: "Hostname to bind the Express server to",
args: {
name: "port",
},
},
],
},
{
name: "format",
description: "Format your schema",
isDangerous: true,
options: [commonOptions, schemaOptions],
},
{
name: "migrate",
description: "Migrate your database",
subcommands: [
{
name: "dev",
icon: "💻",
description:
"The migrate dev command updates your database using migrations during development",
options: [
commonOptions,
schemaOptions,
...skipOptions,
{
name: "--create-only",
description:
"Create a new migration but do not apply it. The migration will be empty if there are no changes in Prisma schema",
},
{
name: ["-n", "--name"],
description:
"The name of the migration. If no name is provided, the CLI will prompt you.",
args: {
name: "filename",
isOptional: true,
},
},
],
},
{
name: "reset",
icon: "🔃",
description:
"The migrate dev command updates your database using migrations during development",
options: [
commonOptions,
schemaOptions,
...skipOptions,
{
name: ["-f", "--force"],
description: "Skip the confirmation prompt",
isDangerous: true,
},
],
},
{
name: "deploy",
icon: "🚀",
description:
"Apply pending migrations to update the database schema in production/staging",
options: [commonOptions, schemaOptions],
},
{
name: "resolve",
description:
"Resolve issues with database migrations in deployment databases",
options: [
commonOptions,
schemaOptions,
{
name: "--applied",
description: " Record a specific migration as applied",
args: {
name: "migration file path",
template: "filepaths",
},
},
{
name: "--rolled-back",
description: "Record a specific migration as rolled back",
args: {
name: "migration file path",
template: "filepaths",
},
},
],
},
{
name: "status",
description: "Check the status of your database migrations",
options: [commonOptions, schemaOptions],
},
],
},
{
name: "db",
description: "Manage your database schema and lifecycle (Preview)",
subcommands: [
{
name: "pull",
options: [
commonOptions,
schemaOptions,
{
name: "--force",
description: "Ignore current Prisma schema file",
isDangerous: true,
},
{
name: "--print",
description: "Print the introspected Prisma schema to stdout",
},
],
},
{
name: "push",
description:
"This command pushes the state of your Prisma schema file to the database without using migrations",
options: [
commonOptions,
schemaOptions,
{
name: "--skip-generate",
description: "Skip generation of artifacts such as Prisma Client",
},
{
name: "--force-reset",
description:
"Resets the database and then updates the schema - useful if you need to start from scratch due to unexecutable migrations.",
isDangerous: true,
},
{
name: "--accept-data-loss",
description:
"Ignore data loss warnings. This option is required if as a result of making the schema changes, data may be lost.",
isDangerous: true,
},
],
},
{
name: "seed",
isDangerous: true,
description: "Seed your database",
options: [commonOptions, schemaOptions],
},
],
},

{
name: ["version", "-v"],
description: "Print current version of Prisma components",
subcommands: [
{
name: "--json",
description: "Output JSON",
},
],
},
],
};
2 changes: 1 addition & 1 deletion dev/yarn.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ export const completionSpec: Fig.Spec = {
await executeShellCommand(script as string)
).map(({ name }) => name as string);

const cli = ["vue", "nuxt", "expo", "jest", "next", "electron"];
const cli = ["vue", "nuxt", "expo", "jest", "next", "electron", "prisma"];
const subcommands = packages
.filter((name) => cli.includes(name))
.map((name) => ({
Expand Down

0 comments on commit d2f99dd

Please sign in to comment.