@postxl/generator 0.0.9 → 0.0.11

package/changelog.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.0.11
+
+### Added
+
+- Add skipping of generators by remove path in generator config
+
+## 0.0.10
+
+### Fixes
+
+- Generated files now do not cause linting errors from Prettier as newline is added at the end of the file
+- Moved data service and module to root of data module
+
 ## 0.0.9
 
 ### Fixes

package/dist/src/generator.js

@@ -58,6 +58,45 @@ const stubs_generator_1 = require("./generators/indices/stubs.generator");
 const seed_generator_2 = require("./generators/indices/seed.generator");
 const types_generator_3 = require("./generators/indices/types.generator");
 const testdataservice_generator_1 = require("./generators/indices/testdataservice.generator");
+const zod_1 = require("zod");
+const configDecoder = zod_1.z
+    .object({
+    project: zod_1.z.string(),
+    pathToTypes: zod_1.z.string().optional(),
+    pathToDataLib: zod_1.z.string().optional(),
+    pathToSeedLib: zod_1.z.string().optional(),
+    trpcRoutesFolder: zod_1.z.string().optional(),
+    reactFolderOutput: zod_1.z.string().optional(),
+    randomSeed: zod_1.z
+        .string()
+        .optional()
+        .transform((v) => (v === undefined ? 1 : parseInt(v))),
+    force: zod_1.z
+        .string()
+        .optional()
+        .transform((v) => (v === undefined ? false : v === 'true')),
+})
+    .transform((s) => {
+    return {
+        project: s.project,
+        paths: {
+            dataLibPath: (0, types_1.toPath)(s.pathToDataLib || 'repos'),
+            reactFolderPath: (0, types_1.toPath)(s.reactFolderOutput || 'react'),
+            modelTypeDefinitionsPath: (0, types_1.toPath)(s.pathToTypes || 'types'),
+            seedPath: (0, types_1.toPath)(s.pathToSeedLib || 'seed'),
+            trpcRoutesFolderPath: (0, types_1.toPath)(s.trpcRoutesFolder || 'trpc'),
+        },
+        randomSeed: s.randomSeed,
+        force: s.force,
+        disableGenerators: {
+            types: s.pathToTypes === undefined,
+            data: s.pathToDataLib === undefined,
+            seed: s.pathToSeedLib === undefined,
+            trpc: s.trpcRoutesFolder === undefined,
+            react: s.reactFolderOutput === undefined,
+        },
+    };
+});
 (0, generator_helper_1.generatorHandler)({
     onManifest() {
         internals_1.logger.info(`PXL Registered`);
@@ -70,18 +109,11 @@ const testdataservice_generator_1 = require("./generators/indices/testdataservic
     onGenerate: ({ generator, otherGenerators, dmmf }) => __awaiter(void 0, void 0, void 0, function* () {
         internals_1.logger.info(`PXL started generating code...`);
         const prismaClientPath = (0, client_path_1.getClientImportPath)(otherGenerators);
-        const config = {
-            project: generator.config['project'] || 'pxl',
-            paths: {
-                dataLibPath: (0, types_1.toPath)(generator.config['pathToDataLib'] || 'repos'),
-                reactFolderPath: (0, types_1.toPath)(generator.config['reactFolderOutput'] || 'react'),
-                modelTypeDefinitionsPath: (0, types_1.toPath)(generator.config['pathToTypes'] || 'types'),
-                seedPath: (0, types_1.toPath)(generator.config['pathToSeedLib'] || 'seed'),
-                trpcRoutesFolderPath: (0, types_1.toPath)(generator.config['trpcRoutesFolder'] || 'trpc'),
-            },
-            randomSeed: parseInt(generator.config['randomSeed']) || 1,
-            force: generator.config['force'] === 'true',
-        };
+        const decodedConfig = configDecoder.safeParse(generator.config);
+        if (!decodedConfig.success) {
+            throw new Error(`Invalid generator config: ${decodedConfig.error.message}`);
+        }
+        const config = decodedConfig.data;
         internals_1.logger.log(`Parsing DMMF...`);
         const { models, enums } = (0, parse_1.parsePrismaSchema)({ datamodel: dmmf.datamodel, config });
         internals_1.logger.log(`Generating...`);
@@ -99,36 +131,58 @@ const generate = ({ models, enums, config, prismaClientPath, logger, }) => __awa
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
         // Types
-        vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_1.generateModelTypes)({ model, meta }));
+        if (!config.disableGenerators.types) {
+            vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_1.generateModelTypes)({ model, meta }));
+        }
         // Seed
-        vfs.write(`/${meta.seed.filePath}.ts`, (0, seed_generator_1.generateSeedModel)({ model, itemCount: 5, meta }));
+        if (!config.disableGenerators.seed) {
+            vfs.write(`/${meta.seed.filePath}.ts`, (0, seed_generator_1.generateSeedModel)({ model, itemCount: 5, meta }));
+        }
         // Generate Repositories
-        vfs.write(`/${meta.data.stubFilePath}.ts`, (0, stub_generator_1.generateStub)({ model, meta }));
-        vfs.write(`/${meta.data.repoFilePath}.ts`, (0, repository_generator_1.generateRepository)({ model, meta }));
+        if (!config.disableGenerators.data) {
+            vfs.write(`/${meta.data.stubFilePath}.ts`, (0, stub_generator_1.generateStub)({ model, meta }));
+            vfs.write(`/${meta.data.repoFilePath}.ts`, (0, repository_generator_1.generateRepository)({ model, meta }));
+        }
         // Routes
-        vfs.write(`/${meta.trpc.routerFilePath}.ts`, (0, route_generator_1.generateRoute)({ model, meta }));
+        if (!config.disableGenerators.trpc) {
+            vfs.write(`/${meta.trpc.routerFilePath}.ts`, (0, route_generator_1.generateRoute)({ model, meta }));
+        }
         // React
-        vfs.copy((0, react_generator_1.generateReactComponentsForModel)({ model, meta }), meta.react.folderPath);
+        if (!config.disableGenerators.react) {
+            vfs.copy((0, react_generator_1.generateReactComponentsForModel)({ model, meta }), meta.react.folderPath);
+        }
         logger.log(`✅ ${model.name} generated!`);
     }
     // Generate Enums
     for (const enumerator of enums.values()) {
         const meta = (0, meta_1.getEnumMetadata)({ enumerator });
-        vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_2.generateEnumType)({ enumerator, prismaClientPath, meta }));
-        vfs.copy((0, react_generator_2.generateEnumReactComponents)({ enumerator, meta }), meta.react.folderPath);
+        if (!config.disableGenerators.types) {
+            vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_2.generateEnumType)({ enumerator, prismaClientPath, meta }));
+        }
+        if (!config.disableGenerators.react) {
+            vfs.copy((0, react_generator_2.generateEnumReactComponents)({ enumerator, meta }), meta.react.folderPath);
+        }
     }
     // Generate Index Files and Services
     const meta = (0, meta_1.getSchemaMetadata)({ config });
-    vfs.write(`/${meta.data.dataMockModuleFilePath}.ts`, (0, datamockmodule_generator_1.generateDataMockModule)({ models, meta }));
-    vfs.write(`/${meta.data.dataModuleFilePath}.ts`, (0, datamodule_generator_1.generateDataModule)({ models, meta }));
-    vfs.write(`/${meta.data.dataServiceFilePath}.ts`, (0, dataservice_generator_1.generateDataService)({ models, meta }));
-    vfs.write(`/${meta.data.testDataServiceFilePath}.ts`, (0, testdataservice_generator_1.generateTestDataService)({ meta }));
-    vfs.write(`/${meta.data.repositoriesConstFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesArray)({ models, meta }));
-    vfs.write(`/${meta.data.repositoriesIndexFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesIndex)({ models, meta }));
-    vfs.write(`/${meta.data.stubIndexFilePath}.ts`, (0, stubs_generator_1.generateStubsIndex)({ models, meta }));
-    vfs.write(`/${meta.seed.indexFilePath}.ts`, (0, seed_generator_2.generateSeedIndex)({ models, meta }));
-    vfs.write(`/${meta.trpc.routesFilePath}.ts`, (0, route_generator_1.generateRoutesIndex)({ models, meta }));
-    vfs.write(`/${meta.types.indexFilePath}.ts`, (0, types_generator_3.generateTypesIndex)({ models, enums, meta }));
+    if (!config.disableGenerators.data) {
+        vfs.write(`/${meta.data.dataMockModuleFilePath}.ts`, (0, datamockmodule_generator_1.generateDataMockModule)({ models, meta }));
+        vfs.write(`/${meta.data.dataModuleFilePath}.ts`, (0, datamodule_generator_1.generateDataModule)({ models, meta }));
+        vfs.write(`/${meta.data.dataServiceFilePath}.ts`, (0, dataservice_generator_1.generateDataService)({ models, meta }));
+        vfs.write(`/${meta.data.testDataServiceFilePath}.ts`, (0, testdataservice_generator_1.generateTestDataService)({ meta }));
+        vfs.write(`/${meta.data.repositoriesConstFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesArray)({ models, meta }));
+        vfs.write(`/${meta.data.repositoriesIndexFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesIndex)({ models, meta }));
+        vfs.write(`/${meta.data.stubIndexFilePath}.ts`, (0, stubs_generator_1.generateStubsIndex)({ models, meta }));
+    }
+    if (!config.disableGenerators.seed) {
+        vfs.write(`/${meta.seed.indexFilePath}.ts`, (0, seed_generator_2.generateSeedIndex)({ models, meta }));
+    }
+    if (!config.disableGenerators.trpc) {
+        vfs.write(`/${meta.trpc.routesFilePath}.ts`, (0, route_generator_1.generateRoutesIndex)({ models, meta }));
+    }
+    if (!config.disableGenerators.types) {
+        vfs.write(`/${meta.types.indexFilePath}.ts`, (0, types_generator_3.generateTypesIndex)({ models, enums, meta }));
+    }
     // -------------------------------------------------------------------------
     // Add disclaimer and format.
     const prettierConfig = yield prettier.resolveConfig(process.cwd());

package/dist/src/generators/indices/datamockmodule.generator.js

@@ -61,7 +61,7 @@ function generateDataMockModule({ models, meta }) {
 import { DynamicModule } from '@nestjs/common'
 import { DbModule } from '@${meta.config.project}/db'
 
-import { provideMockRepository } from '../mock.repository'
+import { provideMockRepository } from './mock.repository'
 
 ${imports.generate()}
 

package/dist/src/generators/indices/datamodule.generator.js

@@ -51,7 +51,7 @@ function generateDataModule({ models, meta }) {
 import { DynamicModule, Provider, Type } from '@nestjs/common'
 import { DbModule, DbService } from '@${meta.config.project}/db'
 
-import { AsyncInit, Repository } from '../repository.type'
+import { AsyncInit, Repository } from './repository.type'
 
 ${imports.generate()}
 

package/dist/src/lib/meta.js

@@ -32,10 +32,10 @@ const string_1 = require("./utils/string");
 function getSchemaMetadata({ config }) {
     return {
         data: {
-            dataModuleFilePath: Types.toPath(`${config.paths.dataLibPath}services/data.module`),
-            dataMockModuleFilePath: Types.toPath(`${config.paths.dataLibPath}services/data.mock.module`),
-            testDataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}services/test-data.service`),
-            dataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}services/data.service`),
+            dataModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.module`),
+            dataMockModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.mock.module`),
+            testDataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}test-data.service`),
+            dataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}data.service`),
             repositoriesConstFilePath: Types.toPath(`${config.paths.dataLibPath}repositories/repositories`),
             repositoriesIndexFilePath: Types.toPath(`${config.paths.dataLibPath}repositories/index`),
             stubIndexFilePath: Types.toPath(`${config.paths.dataLibPath}stubs/index`),

package/dist/src/lib/schema/schema.d.ts

@@ -11,6 +11,31 @@ export type SchemaConfig = {
      * Project scope to use in TypeScript imports (e.g. `mca` for `@mca/types`).
      */
     project: string;
+    /**
+     * Indicates whether the generator should be ignored
+     */
+    disableGenerators: {
+        /**
+         * If true, type definitions for models will not be generated.
+         */
+        types: boolean;
+        /**
+         * If true, data module will not be generated.
+         */
+        data: boolean;
+        /**
+         * If true, seed data will not be generated.
+         */
+        seed: boolean;
+        /**
+         * If true, React components will not be generated.
+         */
+        react: boolean;
+        /**
+         * If true, trpc routes will not be generated.
+         */
+        trpc: boolean;
+    };
     paths: {
         /**
          * Path to the directory containing model type definitions.

package/dist/src/lib/vfs.js

@@ -294,7 +294,10 @@ class VirtualFS {
      */
     _appendChecksumToContent(content) {
         const checksum = this._calculateContentChecksum(content);
-        return content + '\n' + VirtualFS.CHECKSUM_PREFIX + checksum;
+        // NOTE: We add a newline character to make Prettier happy.
+        // According to POSIX standard, files should end with a newline - and Prettier obeys that.
+        // As the checksum is added after we ran Prettier, we need to add the newline manually
+        return content + '\n' + VirtualFS.CHECKSUM_PREFIX + checksum + '\n';
     }
     /**
      * Adds arbitrary meta information to the given content.