Skip to content
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

Add api generator watch mode #3447

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open
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
420 changes: 0 additions & 420 deletions demo/admin/src/products/future/generated/ProductsGrid.tsx

This file was deleted.

1 change: 1 addition & 0 deletions demo/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"scripts": {
"api-generator": "rimraf 'src/*/generated' && comet-api-generator generate",
"api-generator:watch": "rimraf 'src/*/generated' && comet-api-generator generate --watch",
"prebuild": "rimraf dist",
"build": "nest build",
"console": "NODE_OPTIONS='--max-old-space-size=256' dotenv -e .env.secrets -e .env.local -e .env -e .env.site-configs -- ts-node --transpile-only -r tsconfig-paths/register src/console.ts",
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/1-getting-started/4-crud-generator/1-api-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,28 @@ Now you can run the generator with `npm run api-generator`. The generated files
Although this is generated code, it should still be checked into the repository. This enables a quick start of the API.
:::

### Watch Mode

The api-generator script also supports the `-w` or `--watch` flag. This will watch for changes in the .entity.ts files and regenerate the corresponding files.

```json
{
...
"scripts": {
"api-generator:watch": "rimraf 'src/*/generated' && comet api-generator --watch",
...
}
}
```

### Generate only for specific entities

If you want to generate only for specific entities, you can pass a file path to an .entity.ts file with the `-f` or `--file` flag

```json
npm exec comet api-generator -f src/products/entities/product.entity.ts
```

## Register generated resolvers and services

The resolvers and services created by the API Generator must be registered in the corresponding module:
Expand Down
1 change: 1 addition & 0 deletions packages/api/api-generator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
},
"dependencies": {
"@comet/cms-api": "workspace:*",
"chokidar": "^4.0.3",
"commander": "^9.5.0",
"pluralize": "^8.0.0",
"ts-morph": "^25.0.1",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,39 +1,24 @@
import { type CrudGeneratorOptions, type CrudSingleGeneratorOptions } from "@comet/cms-api";
import { CLIHelper } from "@mikro-orm/cli";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { Command } from "commander";

import { generateCrud } from "./generateCrud/generate-crud";
import { generateCrudSingle } from "./generateCrudSingle/generate-crud-single";
import { writeGeneratedFiles } from "./utils/write-generated-files";
import { generateFiles } from "./generateFiles/generateFiles";
import { watchMode } from "./watchMode/watchMode";

export const generateCommand = new Command("generate").action(async (options) => {
const orm = await CLIHelper.getORM(undefined, undefined, { dbName: "generator" });
type GenerateOptions = {
watch: boolean;
file?: string;
};

const entities = orm.em.getMetadata().getAll();
LazyMetadataStorage.load();
export const generateCommand = new Command("generate")
.action(async (options: GenerateOptions) => {
if (options.watch) {
await generateFiles();
console.log("API generator in watch mode ...");

for (const name in entities) {
const entity = entities[name];
if (!entity.class) {
// Ignore e.g. relation entities that don't have a class
continue;
await watchMode();
} else {
console.log(`API generator in ${options.file ? "file mode" : "all mode"}...`);
generateFiles(options.file);
}
{
const generatorOptions = Reflect.getMetadata(`data:crudGeneratorOptions`, entity.class) as CrudGeneratorOptions | undefined;
if (generatorOptions) {
const files = await generateCrud(generatorOptions, entity);
await writeGeneratedFiles(files, { targetDirectory: generatorOptions.targetDirectory });
}
}
{
const generatorOptions = Reflect.getMetadata(`data:crudSingleGeneratorOptions`, entity.class) as CrudSingleGeneratorOptions | undefined;
if (generatorOptions) {
const files = await generateCrudSingle(generatorOptions, entity);
await writeGeneratedFiles(files, { targetDirectory: generatorOptions.targetDirectory });
}
}
}

await orm.close(true);
});
})
.option("-f, --file <file>", "path to entity file")
.option("--watch", "Watch for changes");
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { Field, InputType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { type GeneratedFile } from "../../utils/write-generated-files";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { type GeneratedFile } from "../../../utils/write-generated-files";
import { generateCrud } from "../generate-crud";

@Embeddable()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Field, registerEnumType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

export enum TestEnum {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Field, registerEnumType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

export enum TestEnum {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Field, registerEnumType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

export enum TestEnum {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storage
import { Min } from "class-validator";
import { v4 as uuid } from "uuid";

import { formatSource, parseSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../../generateCrudInput/generate-crud-input";
import { formatSource, parseSource } from "../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import {
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { GeneratedFile } from "../../utils/write-generated-files";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { GeneratedFile } from "../../../utils/write-generated-files";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToMany, MikroORM, Pri
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BaseEntity, defineConfig, Entity, MikroORM, PrimaryKey } from "@mikro-orm/postgresql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { BaseEntity, defineConfig, Embeddable, Embedded, Entity, MikroORM, Prima
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import { Field, registerEnumType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { GeneratedFile } from "../../utils/write-generated-files";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { GeneratedFile } from "../../../utils/write-generated-files";
import { generateCrud } from "../generate-crud";

export enum TestEntity1Status {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, defineConfig, Embeddable, Embedded, Entity, MikroORM, Prima
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Embeddable()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, defineConfig, Entity, MikroORM, PrimaryKey, Property } from
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";
import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../generate-crud";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ import { type EntityMetadata, ReferenceKind } from "@mikro-orm/postgresql";
import * as path from "path";
import { singular } from "pluralize";

import { buildNameVariants, classNameToInstanceName } from "../../utils/build-name-variants";
import { integerTypes } from "../../utils/constants";
import { generateImportsCode, type Imports } from "../../utils/generate-imports-code";
import { findBlockImportPath, findBlockName, findEnumImportPath, findEnumName, morphTsProperty } from "../../utils/ts-morph-helper";
import { type GeneratedFile } from "../../utils/write-generated-files";
import { generateCrudInput } from "../generateCrudInput/generate-crud-input";
import { buildNameVariants, classNameToInstanceName } from "../utils/build-name-variants";
import { integerTypes } from "../utils/constants";
import { generateImportsCode, type Imports } from "../utils/generate-imports-code";
import { findBlockImportPath, findBlockName, findEnumImportPath, findEnumName, morphTsProperty } from "../utils/ts-morph-helper";
import { type GeneratedFile } from "../utils/write-generated-files";

// TODO move into own file
export function buildOptions(metadata: EntityMetadata<any>, generatorOptions: CrudGeneratorOptions) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Field } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatSource, parseSource } from "../../utils/test-helper";
import { formatSource, parseSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../generate-crud-input";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ import { Field, Int } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../../generateCrud/generate-crud";
import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";

@Entity()
class TestEntityWithIntegerTypes extends BaseEntity {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { InputType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatSource, parseSource } from "../../utils/test-helper";
import { formatSource, parseSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../generate-crud-input";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { BaseEntity, defineConfig, Entity, MikroORM, PrimaryKey } from "@mikro-orm/postgresql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";

import { formatSource } from "../../utils/test-helper";
import { formatSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../generate-crud-input";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { BaseEntity, Collection, defineConfig, Entity, ManyToOne, MikroORM, OneT
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatSource, parseSource } from "../../utils/test-helper";
import { formatSource, parseSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../generate-crud-input";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import {
} from "class-validator";
import { v4 as uuid } from "uuid";

import { formatGeneratedFiles, parseSource } from "../../../utils/test-helper";
import { generateCrud } from "../../generateCrud/generate-crud";
import { formatGeneratedFiles, parseSource } from "../../utils/test-helper";

export const IsTrueAsString = (validationOptions?: ValidationOptions) => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { Field, ObjectType, registerEnumType } from "@nestjs/graphql";
import { LazyMetadataStorage } from "@nestjs/graphql/dist/schema-builder/storages/lazy-metadata.storage";
import { v4 as uuid } from "uuid";

import { formatSource, parseSource } from "../../utils/test-helper";
import { formatSource, parseSource } from "../../../utils/test-helper";
import { generateCrudInput } from "../generate-crud-input";

@Entity()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@ import { hasCrudFieldFeature } from "@comet/cms-api";
import { type EntityMetadata } from "@mikro-orm/postgresql";
import { getMetadataStorage } from "class-validator";

import { buildOptions } from "../generateCrud/generate-crud";
import { buildNameVariants } from "../utils/build-name-variants";
import { integerTypes } from "../utils/constants";
import { generateImportsCode, type Imports } from "../utils/generate-imports-code";
import { buildNameVariants } from "../../utils/build-name-variants";
import { integerTypes } from "../../utils/constants";
import { generateImportsCode, type Imports } from "../../utils/generate-imports-code";
import {
findBlockImportPath,
findBlockName,
Expand All @@ -14,8 +13,9 @@ import {
findInputClassImportPath,
findValidatorImportPath,
morphTsProperty,
} from "../utils/ts-morph-helper";
import { type GeneratedFile } from "../utils/write-generated-files";
} from "../../utils/ts-morph-helper";
import { type GeneratedFile } from "../../utils/write-generated-files";
import { buildOptions } from "../generateCrud/generate-crud";

function tsCodeRecordToString(object: Record<string, string | undefined>) {
const filteredEntries = Object.entries(object).filter(([key, value]) => value !== undefined);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { type CrudSingleGeneratorOptions, hasCrudFieldFeature } from "@comet/cms
import { type EntityMetadata } from "@mikro-orm/postgresql";
import * as path from "path";

import { type GeneratedFile } from "../../utils/write-generated-files";
import { generateCrudInput } from "../generateCrudInput/generate-crud-input";
import { type GeneratedFile } from "../utils/write-generated-files";

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export async function generateCrudSingle(generatorOptions: CrudSingleGeneratorOptions, metadata: EntityMetadata<any>): Promise<GeneratedFile[]> {
Expand Down
Loading
Loading