Installation

To install the application for generating folder and file structures for your domain in a NestJS project, you can use the @webmogilevtsev/nestjs-ddd-cli package. You can install it using the following command:

1npm install @webmogilevtsev/nestjs-ddd-cli --save-dev

After installing the package, you need to add a script to the package.json file to be able to run the generate:domain command. Add the following line to the "scripts" section:

1"scripts": {
2  ...
3  "generate:domain": "ddd-cli domain --",
4  "generate:command": "ddd-cli command",
5  "generate:query": "ddd-cli query",
6  "generate:event": "ddd-cli event"
7}
8

Global Installation

You can also install @webmogilevtsev/nestjs-ddd-cli globally to use the generate-domain command in any NestJS project. To do this, run the following command:

1npm install -g @webmogilevtsev/nestjs-ddd-cli

After the global installation, you can run the generate-domain command from any directory on your computer:

1generate-domain my-name

Description

This is an application for generating folder and file structure for a domain in a NestJS project. The generate:domain command generates the folder and file structure for a new domain, including the following directories:

• libs/domains/src/${name}-domain/application-services/commands
• libs/domains/src/${name}-domain/application-services/dto
• libs/domains/src/${name}-domain/application-services/events
• libs/domains/src/${name}-domain/application-services/facade
• libs/domains/src/${name}-domain/application-services/queries
• libs/domains/src/${name}-domain/domain/services
• libs/domains/src/${name}-domain/domain/repositories
• libs/domains/src/${name}-domain/domain/sagas
• libs/domains/src/${name}-domain/domain
• src/infrastructure/${name}-adapter/${name}-adapter.service
• src/infrastructure/infrastructure-module

Commands

generate:domain

Domain generation

Options:

#	Option Name	Short Name	Type	Required	Example	Description
1)	--name	-n	String	Yes	--name=my-name | -n my-name	Sets the domain name
2)	--format	-f	Boolean	No	--format=true | -f	Performs formatting using prettier and eslint

To generate a new domain, run the generate:domain command with the name argument, which sets the domain name:

1npm run generate:domain --name=my-name --format=true
2# Shortened notation
3npm run generate:domain my-name -f

generate:command

Command generation

Options:

#	Option Name	Short Name	Type	Required	Example	Description
1)	--name	-n	String	Yes	--name=my-name | -n my-name	Sets the command name
2)	--domain	-d	String	Yes	--domain=my-name | -d my-name	Specifies the domain for which to generate the command
3)	--format	-f	Boolean	No	--format=true | -f	Performs formatting using prettier and eslint

To generate a new command for a domain, run the generate:command command with the name, domain, and optional --format arguments:

1npm run generate:command --name=create-my-name -- --domain=my-name --format=true
2# Shortened notation
3npm run generate:command create-my-name -- -d my-name -f

generate:query

Query generation

Options:

#	Option Name	Short Name	Type	Required	Example	Description
1)	--name	-n	String	Yes	--name=my-name | -n my-name	Sets the query name
2)	--domain	-d	String	Yes	--domain=my-name | -d my-name	Specifies the domain for which to generate the query
3)	--format	-f	Boolean	No	--format=true | -f	Performs formatting using prettier and eslint

To generate a new query for a domain, run the generate:query command with the name, domain, and optional --format arguments:

1npm run generate:query --name=get-one-my-name -- --domain=my-name --format=true
2# Shortened notation
3npm run generate:query get-one-my-name -- -d my-name -f

generate:event

Event generation

Options:

#	Option Name	Short Name	Type	Required	Example	Description
1)	--name	-n	String	Yes	--name=my-name | -n my-name	Sets the event name
2)	--domain	-d	String	Yes	--domain=my-name | -d my-name	Specifies the domain for which to generate the event
3)	--format	-f	Boolean	No	--format=true | -f	Performs formatting using prettier and eslint

To generate a new event for a domain, run the generate:event command with the name, domain, and optional --format arguments:

1npm run generate:event --name=my-name-created -- --domain=my-name --format=true
2# Shortened notation
3npm run generate:event my-name-created -- -d my-name -f

Directory Structure

The folder and file structure created by the generate:domain command looks like this:

1libs/
2  domains/
3    src/
4      example-domain/
5        application-services/
6          commands/
7            index.ts
8          dto/
9            index.ts
10          events/
11            index.ts
12          facade/
13            example-facade.factory.ts
14            example-facade.service.ts
15          queries/
16            index.ts
17        domain/
18          services/
19            example-domain.service.ts
20          example-domain.interface.ts
21          example-domain.aggregate.ts
22          index.ts
23        repositories/
24          example-domain-repository.abstract.ts
25          index.ts
26        sagas/
27          example-domain-saga.service.ts
28        example-domain.module.ts
29        index.ts
30    index.ts
31src/
32  infrastructure/
33    example-adapter/
34      example-adapter.service
35    infrastructure-module.ts

• application-services/commands/ - directory with commands for managing the domain.
• application-services/dto/ - directory with data transfer objects for use in the application.
• application-services/events/ - directory with events emitted by the domain.
• application-services/facade/ - directory with facade classes that provide a simple interface for interacting with the domain.
• application-services/queries/ - directory with queries for retrieving data from the domain.
• domain/services/ - directory with domain services that implement business logic.
• domain/repositories/ - directory with domain repositories that provide access to data.
• domain/sagas/ - directory with sagas that coordinate complex workflows between domain components.
• domain/ - directory containing the domain interface, as well as aggregates and other components.
• example-domain.module.ts - module that combines all domain components.
• index.ts - file exporting all domains from the src/ folder.
• infrastructure/ - implementation layer