Skip to content

Commit 91fa041

Browse files
committed
WIP
Signed-off-by: alexmerlin <alex.merlin.1985@gmail.com>
1 parent b4b331d commit 91fa041

File tree

19 files changed

+82
-92
lines changed

19 files changed

+82
-92
lines changed

README.md

Lines changed: 7 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# dot-maker
22

3-
Dotkernel library for programmatically generating structured code files.
3+
Programmatically generate Dotkernel projects files and directories.
44

55
## Documentation
66

@@ -32,12 +32,12 @@ composer require-dev dotkernel/dot-maker
3232

3333
Once installed, `dot-maker` is ready for usage, no need for extra configurations.
3434

35-
### (Optional) Add `dot-maker` to composer.json
35+
### (Optional) Add dot-maker to composer.json
3636

37-
Open `composer.json` and locate the `scripts` section.
37+
Open your project's `composer.json` and locate the `scripts` section.
3838
If it does not exist, create it at the document's root level.
3939

40-
Register a new script by appending `"alias": "dot-maker"` to the `scripts` section, where **alias** can be any string you want; like, for example **make**.
40+
Register a new script by appending `"alias": "dot-maker"` to the `scripts` section, where **alias** can be any string you want; like, for example, **make**.
4141

4242
```json
4343
{
@@ -51,78 +51,7 @@ Register a new script by appending `"alias": "dot-maker"` to the `scripts` secti
5151

5252
Invoke `dot-maker` by executing:
5353

54-
- the bin file in your vendor directory, located at `./vendor/bin/dot-maker <component>`
55-
- the (optional) Composer script created at [Setup](#setup): `composer make <component>`
54+
- the bin file in your vendor directory `./vendor/bin/dot-maker`
55+
- the (optional) Composer script created during [Setup](#setup): `composer make`
5656

57-
where `<component>` is one of the following strings:
58-
59-
- `collection`: Creates a resource Collection (only when API)
60-
- `command`: Creates a CLI Command
61-
- `entity`: Creates a Doctrine Entity and the matching Repository
62-
- `form`: Creates a Laminas Form and the matching InputFilter (except when API)
63-
- `handler`: Creates the specified request Handlers (and additional files, based on the project type)
64-
- `input-filter`: Creates an InputFilter
65-
- `middleware`: Creates a Middleware
66-
- `module`: Creates an entire Module
67-
- `repository`: Creates a Doctrine Repository and the matching Entity
68-
- `service`: Creates a Service and the matching ServiceInterface
69-
70-
### Create Collection
71-
72-
```shell
73-
./vendor/bin/dot-maker collection
74-
```
75-
76-
### Create Command
77-
78-
```shell
79-
./vendor/bin/dot-maker command
80-
```
81-
82-
### Create Entity + Repository
83-
84-
```shell
85-
./vendor/bin/dot-maker entity
86-
```
87-
88-
### Create Form
89-
90-
```shell
91-
./vendor/bin/dot-maker form
92-
```
93-
94-
### Create Handler
95-
96-
```shell
97-
./vendor/bin/dot-maker handler
98-
```
99-
100-
### Create InputFilter
101-
102-
```shell
103-
./vendor/bin/dot-maker input-filter
104-
```
105-
106-
### Create Middleware
107-
108-
```shell
109-
./vendor/bin/dot-maker middleware
110-
```
111-
112-
### Create Module
113-
114-
```shell
115-
./vendor/bin/dot-maker module
116-
```
117-
118-
### Create Repository + Entity
119-
120-
```shell
121-
./vendor/bin/dot-maker repository
122-
```
123-
124-
### Create Service + ServiceInterface
125-
126-
```shell
127-
./vendor/bin/dot-maker service
128-
```
57+
Follow the instructions on the screen to create a specific Dotkernel project component.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Create Collection
2+
3+
> Collections can be created only in APIs.

docs/book/v1/component/command.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Command

docs/book/v1/component/entity.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Entity

docs/book/v1/component/form.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Create Form
2+
3+
> Forms cannot be created in APIs.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create InputFilter

docs/book/v1/component/input.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Input
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Middleware

docs/book/v1/component/module.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Module
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Create Repository

0 commit comments

Comments
 (0)