@nexus-ioc/cli 0.1.3 → 0.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +133 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1 +1,133 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
|
+
# Nexus IoC CLI
|
|
3
|
+
|
|
4
|
+
`@nexus-ioc/cli` is a command-line interface (CLI) tool for working with the Nexus IoC library. It helps developers create services, modules, and other components, simplifying the development and setup process.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
### Global Installation
|
|
9
|
+
|
|
10
|
+
You can install the CLI globally using npm:
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g @nexus-ioc/cli
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
### Using with `npx`
|
|
17
|
+
|
|
18
|
+
You can also use the CLI without global installation using `npx`:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @nexus-ioc/cli <command> [options]
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Commands
|
|
25
|
+
|
|
26
|
+
### `generate` (or `g`)
|
|
27
|
+
|
|
28
|
+
Generates a new component, such as a service or module.
|
|
29
|
+
|
|
30
|
+
#### Syntax
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
nexus-cli generate <type> <name> [path]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
or the shorthand form:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
nexus-cli g <type> <name> [path]
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
- `<type>`: The type of component to generate (e.g., `service`, `module`).
|
|
43
|
+
- `<name>`: The name of the new component.
|
|
44
|
+
- `[path]`: (Optional) The path where the new component will be created.
|
|
45
|
+
|
|
46
|
+
#### Examples
|
|
47
|
+
|
|
48
|
+
Creating a new `auth` service in the `./apps/auth` folder:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
nexus-cli generate service auth ./apps/auth
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
or
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
nexus-cli g service auth ./apps/auth
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Creating a new `user` module in the current directory:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
nexus-cli generate module user
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### `install` (or `i`)
|
|
67
|
+
|
|
68
|
+
Installs the Nexus IoC package.
|
|
69
|
+
|
|
70
|
+
#### Syntax
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
nexus-cli install
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
or the shorthand form:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
nexus-cli i
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Installs `nexus-ioc` in your project.
|
|
83
|
+
|
|
84
|
+
#### Example
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
nexus-cli install
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Options
|
|
91
|
+
|
|
92
|
+
- `--help`: Shows help for using the command.
|
|
93
|
+
- `--version`: Shows the CLI version.
|
|
94
|
+
|
|
95
|
+
## Usage Examples
|
|
96
|
+
|
|
97
|
+
1. **Check the CLI version:**
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
nexus-cli --version
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
2. **Get help for the generate command:**
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
nexus-cli generate --help
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
3. **Generate a new service:**
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
nexus-cli g service auth ./apps/auth
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
This project is licensed under the MIT License. See the LICENSE file for details.
|
|
118
|
+
|
|
119
|
+
## Author
|
|
120
|
+
|
|
121
|
+
Isqanderm (Aleksandr Melnik) - [LinkedIn](www.linkedin.com/in/isqander-melnik)
|
|
122
|
+
|
|
123
|
+
## Contributing
|
|
124
|
+
|
|
125
|
+
Contributions are welcome! Please open an issue or submit a pull request.
|
|
126
|
+
|
|
127
|
+
## Acknowledgements
|
|
128
|
+
|
|
129
|
+
Special thanks to the developers of Angular and NestJS for the inspiration.
|
|
130
|
+
|
|
131
|
+
## Wiki
|
|
132
|
+
|
|
133
|
+
For more detailed documentation, please visit the [Wiki](https://github.com/Isqanderm/ioc/wiki/Testing).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nexus-ioc/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.5",
|
|
4
4
|
"description": "CLI tools for Nexus IoC",
|
|
5
5
|
"author": "Isqanderm <aleksandr.melnik.personal@gmail.com> (https://www.linkedin.com/in/isqander-melnik)",
|
|
6
6
|
"homepage": "https://github.com/Isqanderm/ioc#readme",
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
"nexus-ioc-testing": "^0.2.0"
|
|
49
49
|
},
|
|
50
50
|
"dependencies": {
|
|
51
|
+
"tslib": "^2.6.3",
|
|
51
52
|
"prettier": "^3.3.3",
|
|
52
53
|
"ts-morph": "^23.0.0",
|
|
53
54
|
"commander": "^12.1.0"
|