@domain-first/project-structure 2.0.1 → 2.2.0

package/dist/config-file.d.ts

@@ -10,6 +10,7 @@ declare const configSchema: z.ZodObject<{
     }>>;
     defaultPersistenceLayerImplementation: z.ZodString;
     useReact: z.ZodBoolean;
+    testingLibrary: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 export declare class ConfigFile {
     readonly data: z.infer<typeof configSchema>;

package/dist/index.cjs

@@ -125,7 +125,8 @@ const configSchema = external_zod_default().object({
         '@domain-first/handlers-rest'
     ])),
     defaultPersistenceLayerImplementation: external_zod_default().string(),
-    useReact: external_zod_default().boolean()
+    useReact: external_zod_default().boolean(),
+    testingLibrary: external_zod_default().string().optional()
 });
 class ConfigFile {
     data;
@@ -170,11 +171,20 @@ const initializeUseCase = async ()=>{
     const useReact = await (0, prompts_namespaceObject.confirm)({
         message: 'Use React'
     });
+    let testingLibrary;
+    const withTests = await (0, prompts_namespaceObject.confirm)({
+        message: 'Scaffold unit tests'
+    });
+    if (withTests) testingLibrary = await (0, prompts_namespaceObject.input)({
+        message: 'Unit testing library:',
+        default: 'vitest'
+    });
     ConfigFile.write({
         rootFolder: rootFolderName,
         domainFirstPackages,
         defaultPersistenceLayerImplementation,
-        useReact
+        useReact,
+        testingLibrary
     });
     const { path } = new ProjectRoot();
     const rootFolder = new Folder(path);
@@ -225,12 +235,19 @@ class UnknownFormatNaming {
     get ClassName() {
         return this.PascalCase;
     }
+    get withSpaces() {
+        return this.fileName.replaceAll('-', ' ');
+    }
 }
 const scaffoldNewAggregateUseCase = async (boundedContextFolder)=>{
     const aggregateName = await (0, prompts_namespaceObject.input)({
         message: 'Aggregate name:'
     });
     const aggregateNaming = new UnknownFormatNaming(aggregateName);
+    let scaffoldUnitTests;
+    if (ConfigFile.Instance.data.testingLibrary) scaffoldUnitTests = await (0, prompts_namespaceObject.confirm)({
+        message: 'Scaffold unit-tests'
+    });
     const withRepository = await (0, prompts_namespaceObject.confirm)({
         message: 'With Repository'
     });
@@ -246,9 +263,42 @@ export class ${aggregateNaming.ClassName} extends domainType() {
 
 }`.trim() : `export class ${aggregateNaming.ClassName} {}`);
     const barrelFile = aggregatesFolder.createFile("index.ts", `export * from './${aggregateNaming.fileName}.aggregate-root'`);
+    if (scaffoldUnitTests) aggregatesFolder.createFile(`${aggregateNaming.fileName}.aggregate-root.spec.ts`, `
+import { describe, test, expect, beforeEach } from '${ConfigFile.Instance.data.testingLibrary}'
+import { ${aggregateNaming.ClassName} } from './${aggregateNaming.fileName}.aggregate-root'
+
+let ${aggregateNaming.variableName}: ${aggregateNaming.ClassName}
+
+beforeEach(() => {
+    ${aggregateNaming.variableName} = new ${aggregateNaming.ClassName}()
+})
+
+describe('${aggregateNaming.withSpaces}', () => {
+    test('can be instantiated via constructor', () => {
+        expect(${aggregateNaming.variableName}).toBeDefined()
+    })
+})
+            `);
     if (withRepository) {
         aggregatesFolder.createFile(`${aggregateNaming.fileName}-repository.ts`, `export abstract class ${aggregateNaming.ClassName}Repository { }`);
         barrelFile.addLine(`export * from './${aggregateNaming.fileName}-repository'`);
+        if (scaffoldUnitTests) aggregatesFolder.createFile(`${aggregateNaming.fileName}-repository.spec.ts`, `
+import { describe, test, expect, beforeEach } from '${ConfigFile.Instance.data.testingLibrary}'
+import { wire${aggregateNaming.ClassName}Repository } from '../../../wiring/repositories/wire-${aggregateNaming.fileName}-repository'
+import type { ${aggregateNaming.ClassName}Repository } from './${aggregateNaming.fileName}-repository'
+
+let ${aggregateNaming.variableName}Repository: ${aggregateNaming.ClassName}Repository
+
+beforeEach(() => {
+    ${aggregateNaming.variableName}Repository = wire${aggregateNaming.ClassName}Repository()
+})
+
+describe('${aggregateNaming.withSpaces} repository', () => {
+    test('can be wired', () => {
+        expect(${aggregateNaming.variableName}Repository).toBeDefined()
+    })
+})
+                `.trim());
         const infrastructureImplementationType = await (0, prompts_namespaceObject.input)({
             message: 'Repository infrastructure implementation type:',
             default: 'prisma'
@@ -895,6 +945,23 @@ export const wire${naming.ClassName}UseCase = wireClass(
 
 `.trim());
 };
+const scaffoldReactPage = async (presentationReactFolder)=>{
+    const name = await (0, prompts_namespaceObject.input)({
+        message: 'Provide name:'
+    });
+    const { ClassName, fileName } = new UnknownFormatNaming(name);
+    presentationReactFolder.subitem([
+        'pages'
+    ]).createFile(`${fileName}-page.tsx`, `
+import { type FC } from 'react'
+
+export type ${ClassName}PageProps = {}
+
+export const ${ClassName}Page: FC<${ClassName}PageProps> = (props) => {
+    return <></>
+}
+        `.trim());
+};
 const scaffoldReactWidget = async (presentationReactFolder)=>{
     const widgetName = await (0, prompts_namespaceObject.input)({
         message: 'Name: '
@@ -1032,19 +1099,23 @@ const main = async ()=>{
     switch(action){
         case 'Scaffold React module':
             {
+                const reactFolder = new Folder(rootPath).subitem([
+                    ConfigFile.Instance.data.rootFolder,
+                    'presentation',
+                    'react'
+                ]);
                 const action = await (0, prompts_namespaceObject.select)({
                     message: 'Module: ',
                     choices: [
-                        'New widget'
+                        'New widget',
+                        'New page'
                     ]
                 });
                 switch(action){
                     case 'New widget':
-                        return void await scaffoldReactWidget(new Folder(rootPath).subitem([
-                            ConfigFile.Instance.data.rootFolder,
-                            'presentation',
-                            'react'
-                        ]));
+                        return void await scaffoldReactWidget(reactFolder);
+                    case 'New page':
+                        return void await scaffoldReactPage(reactFolder);
                     default:
                         return;
                 }

package/dist/index.js

@@ -95,7 +95,8 @@ const configSchema = zod.object({
         '@domain-first/handlers-rest'
     ])),
     defaultPersistenceLayerImplementation: zod.string(),
-    useReact: zod.boolean()
+    useReact: zod.boolean(),
+    testingLibrary: zod.string().optional()
 });
 class ConfigFile {
     data;
@@ -140,11 +141,20 @@ const initializeUseCase = async ()=>{
     const useReact = await prompts_confirm({
         message: 'Use React'
     });
+    let testingLibrary;
+    const withTests = await prompts_confirm({
+        message: 'Scaffold unit tests'
+    });
+    if (withTests) testingLibrary = await input({
+        message: 'Unit testing library:',
+        default: 'vitest'
+    });
     ConfigFile.write({
         rootFolder: rootFolderName,
         domainFirstPackages,
         defaultPersistenceLayerImplementation,
-        useReact
+        useReact,
+        testingLibrary
     });
     const { path } = new ProjectRoot();
     const rootFolder = new Folder(path);
@@ -195,12 +205,19 @@ class UnknownFormatNaming {
     get ClassName() {
         return this.PascalCase;
     }
+    get withSpaces() {
+        return this.fileName.replaceAll('-', ' ');
+    }
 }
 const scaffoldNewAggregateUseCase = async (boundedContextFolder)=>{
     const aggregateName = await input({
         message: 'Aggregate name:'
     });
     const aggregateNaming = new UnknownFormatNaming(aggregateName);
+    let scaffoldUnitTests;
+    if (ConfigFile.Instance.data.testingLibrary) scaffoldUnitTests = await prompts_confirm({
+        message: 'Scaffold unit-tests'
+    });
     const withRepository = await prompts_confirm({
         message: 'With Repository'
     });
@@ -216,9 +233,42 @@ export class ${aggregateNaming.ClassName} extends domainType() {
 
 }`.trim() : `export class ${aggregateNaming.ClassName} {}`);
     const barrelFile = aggregatesFolder.createFile("index.ts", `export * from './${aggregateNaming.fileName}.aggregate-root'`);
+    if (scaffoldUnitTests) aggregatesFolder.createFile(`${aggregateNaming.fileName}.aggregate-root.spec.ts`, `
+import { describe, test, expect, beforeEach } from '${ConfigFile.Instance.data.testingLibrary}'
+import { ${aggregateNaming.ClassName} } from './${aggregateNaming.fileName}.aggregate-root'
+
+let ${aggregateNaming.variableName}: ${aggregateNaming.ClassName}
+
+beforeEach(() => {
+    ${aggregateNaming.variableName} = new ${aggregateNaming.ClassName}()
+})
+
+describe('${aggregateNaming.withSpaces}', () => {
+    test('can be instantiated via constructor', () => {
+        expect(${aggregateNaming.variableName}).toBeDefined()
+    })
+})
+            `);
     if (withRepository) {
         aggregatesFolder.createFile(`${aggregateNaming.fileName}-repository.ts`, `export abstract class ${aggregateNaming.ClassName}Repository { }`);
         barrelFile.addLine(`export * from './${aggregateNaming.fileName}-repository'`);
+        if (scaffoldUnitTests) aggregatesFolder.createFile(`${aggregateNaming.fileName}-repository.spec.ts`, `
+import { describe, test, expect, beforeEach } from '${ConfigFile.Instance.data.testingLibrary}'
+import { wire${aggregateNaming.ClassName}Repository } from '../../../wiring/repositories/wire-${aggregateNaming.fileName}-repository'
+import type { ${aggregateNaming.ClassName}Repository } from './${aggregateNaming.fileName}-repository'
+
+let ${aggregateNaming.variableName}Repository: ${aggregateNaming.ClassName}Repository
+
+beforeEach(() => {
+    ${aggregateNaming.variableName}Repository = wire${aggregateNaming.ClassName}Repository()
+})
+
+describe('${aggregateNaming.withSpaces} repository', () => {
+    test('can be wired', () => {
+        expect(${aggregateNaming.variableName}Repository).toBeDefined()
+    })
+})
+                `.trim());
         const infrastructureImplementationType = await input({
             message: 'Repository infrastructure implementation type:',
             default: 'prisma'
@@ -865,6 +915,23 @@ export const wire${naming.ClassName}UseCase = wireClass(
 
 `.trim());
 };
+const scaffoldReactPage = async (presentationReactFolder)=>{
+    const name = await input({
+        message: 'Provide name:'
+    });
+    const { ClassName, fileName } = new UnknownFormatNaming(name);
+    presentationReactFolder.subitem([
+        'pages'
+    ]).createFile(`${fileName}-page.tsx`, `
+import { type FC } from 'react'
+
+export type ${ClassName}PageProps = {}
+
+export const ${ClassName}Page: FC<${ClassName}PageProps> = (props) => {
+    return <></>
+}
+        `.trim());
+};
 const scaffoldReactWidget = async (presentationReactFolder)=>{
     const widgetName = await input({
         message: 'Name: '
@@ -1002,19 +1069,23 @@ const main = async ()=>{
     switch(action){
         case 'Scaffold React module':
             {
+                const reactFolder = new Folder(rootPath).subitem([
+                    ConfigFile.Instance.data.rootFolder,
+                    'presentation',
+                    'react'
+                ]);
                 const action = await prompts_select({
                     message: 'Module: ',
                     choices: [
-                        'New widget'
+                        'New widget',
+                        'New page'
                     ]
                 });
                 switch(action){
                     case 'New widget':
-                        return void await scaffoldReactWidget(new Folder(rootPath).subitem([
-                            ConfigFile.Instance.data.rootFolder,
-                            'presentation',
-                            'react'
-                        ]));
+                        return void await scaffoldReactWidget(reactFolder);
+                    case 'New page':
+                        return void await scaffoldReactPage(reactFolder);
                     default:
                         return;
                 }

package/dist/unknown-format-naming.d.ts

@@ -6,4 +6,5 @@ export declare class UnknownFormatNaming {
     get fileName(): string;
     get variableName(): string;
     get ClassName(): string;
+    get withSpaces(): string;
 }

package/dist/use-cases/index.d.ts

@@ -8,4 +8,5 @@ export * from './scaffold-new-error';
 export * from './scaffold-new-handlers-rest-endpoint';
 export * from './scaffold-new-query';
 export * from './scaffold-new-use-case';
+export * from './scaffold-react-page';
 export * from './scaffold-react-widget';

package/dist/use-cases/scaffold-react-page.d.ts

@@ -0,0 +1,2 @@
+import type { Folder } from '../file-system';
+export declare const scaffoldReactPage: (presentationReactFolder: Folder) => Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@domain-first/project-structure",
     "description": "Build and manage your Domain-First project structure with CLI",
-    "version": "2.0.1",
+    "version": "2.2.0",
     "type": "module",
     "repository": {
         "type": "git",