Skip to content

refactor: merge core plugins #939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The ZModel language's definition, including its syntax definition and parser/lin

### `schema`

The `zenstack` CLI and ZModel VSCode extension implementation. The package also contains several built-in plugins: `@core/prisma`, `@core/model-meta`, `@core/access-policy`, and `core/zod`.
The `zenstack` CLI and ZModel VSCode extension implementation. The package also contains several built-in plugins: `@core/prisma`, `@core/enhancer`, and `core/zod`.

### `runtime`

Expand Down
8 changes: 3 additions & 5 deletions packages/plugins/openapi/src/generator-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@ import type { DMMF } from '@prisma/generator-helper';
import { PluginError, PluginOptions, getDataModels, hasAttribute } from '@zenstackhq/sdk';
import { Model } from '@zenstackhq/sdk/ast';
import type { OpenAPIV3_1 as OAPI } from 'openapi-types';
import semver from 'semver';
import { fromZodError } from 'zod-validation-error';
import { name } from '.';
import { SecuritySchemesSchema } from './schema';
import semver from 'semver';

export abstract class OpenAPIGeneratorBase {
protected readonly DEFAULT_SPEC_VERSION = '3.1.0';
Expand Down Expand Up @@ -91,10 +92,7 @@ export abstract class OpenAPIGeneratorBase {
if (securitySchemes) {
const parsed = SecuritySchemesSchema.safeParse(securitySchemes);
if (!parsed.success) {
throw new PluginError(
this.options.name,
`"securitySchemes" option is invalid: ${fromZodError(parsed.error)}`
);
throw new PluginError(name, `"securitySchemes" option is invalid: ${fromZodError(parsed.error)}`);
}
return parsed.data;
}
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/openapi/src/rpc-generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -721,7 +721,7 @@ export class RPCOpenAPIGenerator extends OpenAPIGeneratorBase {
return this.wrapArray(this.wrapNullable(this.ref(def.type, false), !def.isRequired), def.isList);

default:
throw new PluginError(this.options.name, `Unsupported field kind: ${def.kind}`);
throw new PluginError(name, `Unsupported field kind: ${def.kind}`);
}
}

Expand Down
2 changes: 0 additions & 2 deletions packages/plugins/swr/src/generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.

await generateModelMeta(project, models, {
output: path.join(outDir, '__model_meta.ts'),
compile: false,
preserveTsFiles: true,
generateAttributes: false,
});

Expand Down
7 changes: 6 additions & 1 deletion packages/plugins/swr/tests/swr.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@ ${sharedModel}
{
provider: 'postgresql',
pushDb: false,
extraDependencies: [`${origDir}/dist`, 'react@18.2.0', '@types/react@18.2.0', 'swr@^2'],
extraDependencies: [
path.resolve(__dirname, '../dist'),
'react@18.2.0',
'@types/react@18.2.0',
'swr@^2',
],
compile: true,
}
);
Expand Down
9 changes: 2 additions & 7 deletions packages/plugins/tanstack-query/src/generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,21 +34,16 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.

const target = requireOption<string>(options, 'target', name);
if (!supportedTargets.includes(target)) {
throw new PluginError(
options.name,
`Unsupported target "${target}", supported values: ${supportedTargets.join(', ')}`
);
throw new PluginError(name, `Unsupported target "${target}", supported values: ${supportedTargets.join(', ')}`);
}

const version = typeof options.version === 'string' ? options.version : 'v4';
if (version !== 'v4' && version !== 'v5') {
throw new PluginError(options.name, `Unsupported version "${version}": use "v4" or "v5"`);
throw new PluginError(name, `Unsupported version "${version}": use "v4" or "v5"`);
}

await generateModelMeta(project, models, {
output: path.join(outDir, '__model_meta.ts'),
compile: false,
preserveTsFiles: true,
generateAttributes: false,
});

Expand Down
12 changes: 6 additions & 6 deletions packages/plugins/tanstack-query/tests/plugin.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['react@18.2.0', '@types/react@18.2.0', '@tanstack/react-query@4.29.7'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand All @@ -83,7 +83,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['react@18.2.0', '@types/react@18.2.0', '@tanstack/react-query@^5.0.0'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand All @@ -104,7 +104,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['vue@^3.3.4', '@tanstack/vue-query@4.37.0'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand All @@ -126,7 +126,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['vue@^3.3.4', '@tanstack/vue-query@latest'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand All @@ -147,7 +147,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['svelte@^3.0.0', '@tanstack/svelte-query@4.29.7'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand All @@ -169,7 +169,7 @@ ${sharedModel}
provider: 'postgresql',
pushDb: false,
extraDependencies: ['svelte@^3.0.0', '@tanstack/svelte-query@^5.0.0'],
copyDependencies: [`${origDir}/dist`],
copyDependencies: [path.resolve(__dirname, '../dist')],
compile: true,
}
);
Expand Down
25 changes: 15 additions & 10 deletions packages/plugins/trpc/tests/trpc.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ model Foo {
{
provider: 'postgresql',
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
}
Expand Down Expand Up @@ -98,7 +98,7 @@ model Foo {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
}
Expand Down Expand Up @@ -128,7 +128,7 @@ model Post {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
customSchemaFilePath: 'zenstack/schema.zmodel',
Expand All @@ -153,7 +153,7 @@ model Post {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
customSchemaFilePath: 'zenstack/schema.zmodel',
Expand Down Expand Up @@ -183,7 +183,7 @@ model Post {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
customSchemaFilePath: 'zenstack/schema.zmodel',
Expand Down Expand Up @@ -229,7 +229,12 @@ model Post {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server', '@trpc/react-query'],
extraDependencies: [
path.resolve(__dirname, '../dist'),
'@trpc/client',
'@trpc/server',
'@trpc/react-query',
],
compile: true,
fullZod: true,
}
Expand All @@ -249,7 +254,7 @@ model Post {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server', '@trpc/next'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server', '@trpc/next'],
compile: true,
fullZod: true,
}
Expand Down Expand Up @@ -279,7 +284,7 @@ model post_item {
`,
{
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
fullZod: true,
}
Expand Down Expand Up @@ -326,7 +331,7 @@ model Foo {
{
addPrelude: false,
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
}
);
Expand Down Expand Up @@ -397,7 +402,7 @@ model Foo {
{
addPrelude: false,
pushDb: false,
extraDependencies: [`${origDir}/dist`, '@trpc/client', '@trpc/server'],
extraDependencies: [path.resolve(__dirname, '../dist'), '@trpc/client', '@trpc/server'],
compile: true,
}
);
Expand Down
Loading