@postxl/generator 0.5.0 → 0.6.1

package/dist/{src/generator.js → generator.js}

@@ -32,22 +32,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
 const faker_1 = require("@faker-js/faker");
+const lock_1 = require("@postxl/lock");
 const generator_helper_1 = require("@prisma/generator-helper");
 const internals_1 = require("@prisma/internals");
 const prettier = __importStar(require("prettier"));
 const zod_1 = require("zod");
-const chalk_1 = __importDefault(require("chalk"));
 const react_generator_1 = require("./generators/enums/react.generator");
 const types_generator_1 = require("./generators/enums/types.generator");
 const datamockmodule_generator_1 = require("./generators/indices/datamockmodule.generator");
 const datamodule_generator_1 = require("./generators/indices/datamodule.generator");
 const dataservice_generator_1 = require("./generators/indices/dataservice.generator");
+const emptydatabasemigration_generator_1 = require("./generators/indices/emptydatabasemigration.generator");
 const repositories_generator_1 = require("./generators/indices/repositories.generator");
 const seed_generator_1 = require("./generators/indices/seed.generator");
 const stubs_generator_1 = require("./generators/indices/stubs.generator");
@@ -61,10 +59,8 @@ const stub_generator_1 = require("./generators/models/stub.generator");
 const types_generator_3 = require("./generators/models/types.generator");
 const meta_1 = require("./lib/meta");
 const types_1 = require("./lib/schema/types");
-const vfs_1 = require("./lib/vfs");
 const client_path_1 = require("./prisma/client-path");
 const parse_1 = require("./prisma/parse");
-const emptydatabasemigration_generator_1 = require("./generators/indices/emptydatabasemigration.generator");
 const configDecoder = zod_1.z
     .object({
     project: zod_1.z.string(),
@@ -133,102 +129,89 @@ const configDecoder = zod_1.z
  * Generates PXL files and flushes them to disk.
  */
 const generate = ({ models, enums, config, prismaClientPath, logger, }) => __awaiter(void 0, void 0, void 0, function* () {
-    const vfs = new vfs_1.VirtualFS();
+    const root = yield lock_1.LockUtils.findProjectRoot();
+    if (root == undefined) {
+        throw new Error(`Could not find lock file. Make sure you are running the generator in a project folder.`);
+    }
     faker_1.faker.seed(config.randomSeed);
+    const vfs = yield lock_1.VirtualFS.fromLockFile(root);
+    const generated = new lock_1.VirtualFS();
     // Generate Models
     for (const model of models) {
         const meta = (0, meta_1.getModelMetadata)({ model });
         // Types
         if (!config.disableGenerators.types) {
-            vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_3.generateModelTypes)({ model, meta }));
+            generated.write(`/${meta.types.filePath}.ts`, (0, types_generator_3.generateModelTypes)({ model, meta }));
         }
         // Seed
         if (!config.disableGenerators.seed) {
-            vfs.write(`/${meta.seed.filePath}.ts`, (0, seed_generator_2.generateSeedModel)({ model, itemCount: 5, meta }));
+            generated.write(`/${meta.seed.filePath}.ts`, (0, seed_generator_2.generateSeedModel)({ model, itemCount: 5, meta }));
         }
         // Generate Repositories
         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 }));
+            generated.write(`/${meta.data.stubFilePath}.ts`, (0, stub_generator_1.generateStub)({ model, meta }));
+            generated.write(`/${meta.data.repoFilePath}.ts`, (0, repository_generator_1.generateRepository)({ model, meta }));
         }
         // Routes
         if (!config.disableGenerators.trpc) {
-            vfs.write(`/${meta.trpc.routerFilePath}.ts`, (0, route_generator_1.generateRoute)({ model, meta }));
+            generated.write(`/${meta.trpc.routerFilePath}.ts`, (0, route_generator_1.generateRoute)({ model, meta }));
         }
         // React
         if (!config.disableGenerators.react) {
-            vfs.copy((0, react_generator_2.generateReactComponentsForModel)({ model, meta }), meta.react.folderPath);
+            generated.copy((0, react_generator_2.generateReactComponentsForModel)({ model, meta }), meta.react.folderPath);
         }
-        logger.log(`✅ ${model.name} generated!`);
+        logger.log(`- ${model.name} processed`);
     }
     // Generate Enums
     for (const enumerator of enums.values()) {
         const meta = (0, meta_1.getEnumMetadata)({ enumerator });
         if (!config.disableGenerators.types) {
-            vfs.write(`/${meta.types.filePath}.ts`, (0, types_generator_1.generateEnumType)({ enumerator, prismaClientPath, meta }));
+            generated.write(`/${meta.types.filePath}.ts`, (0, types_generator_1.generateEnumType)({ enumerator, prismaClientPath, meta }));
         }
         if (!config.disableGenerators.react) {
-            vfs.copy((0, react_generator_1.generateEnumReactComponents)({ enumerator, meta }), meta.react.folderPath);
+            generated.copy((0, react_generator_1.generateEnumReactComponents)({ enumerator, meta }), meta.react.folderPath);
         }
     }
     // Generate Index Files and Services
     const meta = (0, meta_1.getSchemaMetadata)({ config });
     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 }));
-        vfs.write(`/${meta.migrationsPath}/emptyDatabase.template.sql`, (0, emptydatabasemigration_generator_1.generateEmptyDatabaseStoredProcedure)({ models, meta }));
+        generated.write(`/${meta.data.dataMockModuleFilePath}.ts`, (0, datamockmodule_generator_1.generateDataMockModule)({ models, meta }));
+        generated.write(`/${meta.data.dataModuleFilePath}.ts`, (0, datamodule_generator_1.generateDataModule)({ models, meta }));
+        generated.write(`/${meta.data.dataServiceFilePath}.ts`, (0, dataservice_generator_1.generateDataService)({ models, meta }));
+        generated.write(`/${meta.data.testDataServiceFilePath}.ts`, (0, testdataservice_generator_1.generateTestDataService)({ meta }));
+        generated.write(`/${meta.data.repositoriesConstFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesArray)({ models, meta }));
+        generated.write(`/${meta.data.repositoriesIndexFilePath}.ts`, (0, repositories_generator_1.generateRepositoriesIndex)({ models, meta }));
+        generated.write(`/${meta.data.stubIndexFilePath}.ts`, (0, stubs_generator_1.generateStubsIndex)({ models, meta }));
+        generated.write(`/${meta.migrationsPath}/emptyDatabase.template.sql`, (0, emptydatabasemigration_generator_1.generateEmptyDatabaseStoredProcedure)({ models, meta }));
     }
     if (!config.disableGenerators.seed) {
-        vfs.write(`/${meta.seed.indexFilePath}.ts`, (0, seed_generator_1.generateSeedIndex)({ models, meta }));
+        generated.write(`/${meta.seed.indexFilePath}.ts`, (0, seed_generator_1.generateSeedIndex)({ models, meta }));
     }
     if (!config.disableGenerators.trpc) {
-        vfs.write(`/${meta.trpc.routesFilePath}.ts`, (0, route_generator_1.generateRoutesIndex)({ models, meta }));
+        generated.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_2.generateTypesIndex)({ models, enums, meta }));
+        generated.write(`/${meta.types.indexFilePath}.ts`, (0, types_generator_2.generateTypesIndex)({ models, enums, meta }));
     }
     // -------------------------------------------------------------------------
     // Add disclaimer and format.
     const prettierConfig = yield prettier.resolveConfig(process.cwd());
-    vfs.transform((path, content) => `${DISCLAIMER}\n${content}`);
-    vfs.format(prettierConfig);
-    const entries = yield vfs.flush(process.cwd(), config.force);
-    const changes = entries.filter((e) => e.status === 'WRITTEN');
-    const skipped = entries.filter((e) => e.status === 'SKIPPED');
-    const unchanged = entries.filter((e) => e.status === 'UNCHANGED');
-    if (skipped.length > 0) {
-        logger.info(`PXL ${chalk_1.default.magenta(`skipped ${skipped.length} files`)} because checksums didn't match.`);
-    }
-    if (unchanged.length > 0) {
-        logger.info(`PXL ${chalk_1.default.dim(`skipped ${unchanged.length} files`)} because no change occurded since last generation.`);
-    }
-    if (changes.length === 0) {
-        logger.info(`PXL generated no files.`);
-        return;
-    }
-    logger.info(`PXL ${chalk_1.default.green(`generated the following ${changes.length}`)} files:`);
-    for (const file of changes) {
-        logger.info(`+ [generated] ${file.path}`);
-    }
-    logger.info(`PXL finished! 🚀`);
+    generated.transformUTF8Files((path, content) => `${DISCLAIMER}\n${content}`);
+    generated.format(prettierConfig);
+    // -------------------------------------------------------------------------
+    // Merge with existing files.
+    vfs.copy(generated, './');
+    // Flush to disk.
+    const changes = yield vfs.flush(process.cwd(), { force: config.force });
+    const log = lock_1.ConsoleUtils.getFilesChangelog(changes);
+    console.info(log);
 });
 exports.generate = generate;
-const DISCLAIMER = `/**
-* DO NOT EDIT THIS FILE!  
+const DISCLAIMER = `
+/**
+* This file was generated by PostXL generator.
 *
-* This file was generated by generator.
-* Any manual changes will be overwritten.
-* To modify this file, edit the Prisma schema file and run 
-* \`prisma generate\` or \`pnpm prisma generate\`
-* again!
-* 
-* If you need to modify the structure of this file, please edit the generator
-* at \`packages/generator/\`
-* 
+* Feel free to manually edit it. The generator will not overwrite it. We suggest you 
+* remove the disclaimer to avoid confusion.
 **/
 `;

package/dist/{src/generators → generators}/enums/react.generator.d.ts

@@ -1,6 +1,6 @@
+import { VirtualFS } from '@postxl/lock';
 import { EnumMetaData } from '../../lib/meta';
 import { Enum } from '../../lib/schema/schema';
-import { VirtualFS } from '../../lib/vfs';
 /**
  * Generates React components for a given enumerator.
  */

package/dist/{src/generators → generators}/enums/react.generator.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateEnumReactComponents = void 0;
+const lock_1 = require("@postxl/lock");
 const imports_1 = require("../../lib/imports");
-const vfs_1 = require("../../lib/vfs");
 /**
  * Generates React components for a given enumerator.
  */
 function generateEnumReactComponents({ enumerator, meta }) {
-    const vfs = new vfs_1.VirtualFS({
+    const vfs = new lock_1.VirtualFS({
         'index.ts': `
 			export * from './Select'
 		`,

package/dist/{src/generators → generators}/models/react.generator/index.d.ts

@@ -1,6 +1,6 @@
+import { VirtualFS } from '@postxl/lock';
 import { ModelMetaData } from '../../../lib/meta';
 import { Model } from '../../../lib/schema/schema';
-import { VirtualFS } from '../../../lib/vfs';
 /**
  * Generates generic React components for a given model.
  */

package/dist/{src/generators → generators}/models/react.generator/index.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateReactComponentsForModel = void 0;
+const lock_1 = require("@postxl/lock");
 const exports_1 = require("../../../lib/exports");
-const vfs_1 = require("../../../lib/vfs");
 const context_generator_1 = require("./context.generator");
 const library_generator_1 = require("./library.generator");
 const lookup_generator_1 = require("./lookup.generator");
@@ -11,7 +11,7 @@ const modals_generator_1 = require("./modals.generator");
  * Generates generic React components for a given model.
  */
 function generateReactComponentsForModel({ model, meta }) {
-    const vfs = new vfs_1.VirtualFS({});
+    const vfs = new lock_1.VirtualFS({});
     const exports = exports_1.ExportsGenerator.fromRoot()
         .exportEverythingFromFile('./CreateModal')
         .exportEverythingFromFile('./EditModal')

package/dist/{src/lib → lib}/schema/types.d.ts

@@ -2,7 +2,7 @@
  * Name of a Typescript type, e.g. "Aggregation".
  */
 export type TypeName = string & {
-    readonly typeName: unique symbol;
+    readonly ___type: 'TypeName';
 };
 /**
  * Brands a raw string to a TypeScript Type identifier.
@@ -12,7 +12,7 @@ export declare const toTypeName: (t: string) => TypeName;
  * The name of a function (e.g. "toAggregation").
  */
 export type Function = string & {
-    readonly functionName: unique symbol;
+    readonly ___type: 'FunctionName';
 };
 /**
  * Converts a string to a branded function name.
@@ -22,7 +22,7 @@ export declare const toFunction: (t: string) => Function;
  * The name of a class, e.g. "AggregationRepository".
  */
 export type ClassName = string & {
-    readonly className: unique symbol;
+    readonly ___type: 'ClassName';
 };
 /**
  * Converts a raw string to a branded ClassName.
@@ -32,7 +32,7 @@ export declare const toClassName: (t: string) => ClassName;
  * The name of a variable or a property in the generated code.
  */
 export type VariableName = string & {
-    readonly variableName: unique symbol;
+    readonly ___type: 'VariableName';
 };
 /**
  * Converts a string to a branded VariableName.
@@ -42,7 +42,7 @@ export declare const toVariableName: (t: string) => VariableName;
  * A name of the file without a file extension, e.g. "aggregation.type".
  */
 export type FileName = string & {
-    readonly fileName: unique symbol;
+    readonly ___type: 'FileName';
 };
 /**
  * Lets you brand a string value as a name of the file.
@@ -54,7 +54,7 @@ export declare const toFileName: (t: string) => FileName;
  * A name of the folder without the trailing and leading slash (e.g. "aggregation").
  */
 export type FolderName = string & {
-    readonly folderName: unique symbol;
+    readonly ___type: 'FolderName';
 };
 /**
  * Converts a string to a branded FolderName.
@@ -64,7 +64,7 @@ export declare const toFolderName: (t: string) => FolderName;
  * A relative or absolute path to a file or folder.
  */
 export type Path = string & {
-    readonly fileName: unique symbol;
+    readonly ___type: 'FileName';
 };
 /**
  * Converts a string to a branded FileName.

package/dist/{src/lib → lib}/utils/string.js

@@ -33,6 +33,32 @@ const toPascalCase = (str) => {
     return s.charAt(0).toUpperCase() + s.slice(1);
 };
 exports.toPascalCase = toPascalCase;
+const irregularPlurals = {
+    alumnus: 'alumni',
+    analysis: 'analyses',
+    appendix: 'appendices',
+    axis: 'axes',
+    basis: 'bases',
+    child: 'children',
+    crisis: 'crises',
+    criterion: 'criteria',
+    data: 'data',
+    datum: 'data',
+    diagnosis: 'diagnoses',
+    focus: 'foci',
+    hypothesis: 'hypotheses',
+    index: 'indices',
+    matrix: 'matrices',
+    medium: 'media',
+    parenthesis: 'parentheses',
+    phenomenon: 'phenomena',
+    prognosis: 'prognoses',
+    radius: 'radii',
+    suffix: 'suffixes',
+    syllabus: 'syllabi',
+    synopsis: 'synopses',
+    thesis: 'theses',
+};
 /**
  * Returns a pluralized version of the given string based on the count.
  */
@@ -50,6 +76,13 @@ const pluralize = (s, count = 2) => {
     if (s.endsWith('s')) {
         return s;
     }
+    //check if word ends with any irregular plurals
+    const lower = s.toLowerCase();
+    for (const [irregularPlural, irregularSingular] of Object.entries(irregularPlurals)) {
+        if (lower.endsWith(irregularPlural)) {
+            return s.slice(0, -irregularPlural.length + 1) + irregularSingular.slice(1);
+        }
+    }
     return s + 's';
 };
 exports.pluralize = pluralize;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@postxl/generator",
-  "version": "0.5.0",
-  "main": "./dist/src/generator.js",
-  "typings": "./dist/src/generator.d.ts",
+  "version": "0.6.1",
+  "main": "./dist/generator.js",
+  "typings": "./dist/generator.d.ts",
   "bin": {
-    "@postxl/generator": "./dist/src/generator.js"
+    "@postxl/generator": "./dist/generator.js"
   },
   "files": [
     "dist"
@@ -17,11 +17,11 @@
     "@faker-js/faker": "7.6.0",
     "@prisma/generator-helper": "4.12.0",
     "@prisma/internals": "^4.12.0",
-    "chalk": "^4.1.2",
     "fast-glob": "^3.2.12",
     "prettier": "^2.8.7",
     "remeda": "1.9.4",
-    "zod": "3.21.4"
+    "zod": "3.21.4",
+    "@postxl/lock": "0.1.1"
   },
   "devDependencies": {
     "@prisma/client": "4.12.0",
@@ -46,8 +46,10 @@
     "prepublish": "tsc -b",
     "dev": "tsc -b -w",
     "test": "jest",
+    "test:watch": "jest --watch",
     "test:types": "tsc --noEmit",
-    "testgen:mca": "pnpm run build && prisma generate --schema ./tests/schemas/mca/mca.prisma",
-    "testgen:la": "pnpm run build && prisma generate --schema ./tests/schemas/la/la.prisma"
+    "testgen:simple": "cd ./tests/schemas/simple/ && prisma generate",
+    "testgen:mca": "cd ./tests/schemas/mca/ && prisma generate",
+    "testgen:la": "cd ./tests/schemas/la/ && prisma generate"
   }
 }

package/dist/jest.config.d.ts

@@ -1,3 +0,0 @@
-import type { Config } from 'jest';
-declare const config: Config;
-export default config;

package/dist/jest.config.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// import { pathsToModuleNameMapper } from 'ts-jest'
-// import { compilerOptions } from './tsconfig.json'
-const config = {
-    verbose: true,
-    // roots: ['<rootDir>/tests', '<rootDir>/src'],
-    testEnvironment: 'node',
-    transform: {
-        '^.+\\.tsx?$': 'ts-jest',
-    },
-    testRegex: '(\\.|/)test\\.tsx?$',
-    testPathIgnorePatterns: ['/node_modules/', '/__fixtures__/'],
-    moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
-    // moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/src/' }),
-};
-exports.default = config;

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

@@ -1,137 +0,0 @@
-import * as prettier from 'prettier';
-type FileWriteError = 'EIP' | 'EISDIR';
-type FileReadError = 'ENF' | 'EISDIR';
-type FileStatus = 'UNCHANGED' | 'WRITTEN' | 'SKIPPED';
-/**
- * A utility class that helps you manage a collection of files.
- */
-export declare class VirtualFS {
-    /**
-     * Human readable messages for file write errors.
-     */
-    static WRITE_ERROR_MESSAGES: {
-        [Key in FileWriteError]: string;
-    };
-    /**
-     * Human readable messages for file read errors.
-     */
-    static READ_ERROR_MESSAGES: {
-        [Key in FileReadError]: string;
-    };
-    private _files;
-    constructor(files?: {
-        [key: string]: string;
-    });
-    /**
-     * Returns the chunks of the resolved path.
-     */
-    private _parse;
-    /**
-     * Writes the given contents to the given path. Path should be a relative path from the root
-     * of the virtual file system with no special characters.
-     */
-    write(path: string, content: string): {
-        ok: true;
-    } | {
-        ok: false;
-        path: string;
-        err: FileWriteError;
-    };
-    /**
-     * Appends given content to the file at a given path if it exists.
-     */
-    append(path: string, content: string): {
-        ok: true;
-    } | {
-        ok: false;
-        path: string;
-        err: FileWriteError | FileReadError;
-    };
-    /**
-     * Copies given files to the given path.
-     */
-    copy(files: VirtualFS, path: string): void;
-    /**
-     * Lists all files and folders in the given path.
-     */
-    list(path: string): {
-        kind: 'FILE' | 'FOLDER';
-        name: string;
-    }[];
-    /**
-     * Returns a dictionary of all files in the virtual file system indexed by their paths.
-     */
-    files(): {
-        [path: string]: string;
-    };
-    /**
-     * Lets you read the contents of a file in the given path.
-     */
-    read(path: string): {
-        ok: true;
-        content: string;
-    } | {
-        ok: false;
-        path: string;
-        err: FileReadError;
-    };
-    /**
-     * Writes files to the given path, overriding managed files and ignoring
-     * detached files (i.e. files that don't have a checksum value).
-     *
-     * Returns a list of paths that were written.
-     */
-    flush(relativeOutPath: string, force?: boolean): Promise<{
-        status: FileStatus;
-        path: string;
-    }[]>;
-    /**
-     * Writes the contents of the file to a given path. If there's already a file there,
-     * it checks the checksum and overrides it if the content hasn't changed.
-     *
-     * Returns `true` if the file was written, `false` if it wasn't.
-     */
-    private _safeWriteUTF8File;
-    /**
-     * Tries to read a file at a given path and surpresses the error if it fails to do so.
-     */
-    private _safeReadUTF8File;
-    private static CHECKSUM_PREFIX;
-    private static META_PREFIX;
-    /**
-     * Returns the checksum of the given content, ignoring
-     * the line containing the checksum if present.
-     */
-    private _calculateContentChecksum;
-    /**
-     * Adds the checksum indicator to the given content.
-     */
-    private _appendChecksumToContent;
-    /**
-     * Adds arbitrary meta information to the given content.
-     *
-     * NOTE: This only changes when the content changes regardless of the change of the meta value.
-     */
-    private _appendMetaToContent;
-    /**
-     * Extracts the checksum from the given content.
-     */
-    private _extractChecksumFromContent;
-    /**
-     * Creates a new file system from the given directory.
-     */
-    static fromDirectory(cwd: string): Promise<VirtualFS>;
-    /**
-     * Walks the file tree, calling the given function for each file.
-     */
-    walk(fn: (path: string, content: string) => void): void;
-    /**
-     * Transforms files in the file system.
-     */
-    transform(fn: (path: string, content: string) => string): void;
-    /**
-     * Formats the file system using configuration in the given directory.
-     */
-    format(options?: prettier.Options | null): void;
-}
-export {};