@famgia/omnify-cli 0.0.1 → 0.0.2
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 +76 -0
- package/package.json +7 -6
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# @famgia/omnify-cli
|
|
2
|
+
|
|
3
|
+
CLI tool for the Omnify schema system. Generate Laravel migrations and TypeScript types from YAML schemas.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @famgia/omnify-cli
|
|
9
|
+
# or
|
|
10
|
+
npx @famgia/omnify-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Commands
|
|
14
|
+
|
|
15
|
+
### Initialize project
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
omnify init
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Creates `omnify.config.ts` and sample schema files.
|
|
22
|
+
|
|
23
|
+
### Validate schemas
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
omnify validate
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Generate migrations
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
omnify generate
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Generates:
|
|
36
|
+
- Laravel PHP migrations
|
|
37
|
+
- TypeScript type definitions
|
|
38
|
+
- Atlas HCL schemas
|
|
39
|
+
|
|
40
|
+
### Show diff
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
omnify diff
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Shows pending schema changes without generating files.
|
|
47
|
+
|
|
48
|
+
## Configuration
|
|
49
|
+
|
|
50
|
+
Create `omnify.config.ts`:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { defineConfig } from '@famgia/omnify-cli';
|
|
54
|
+
|
|
55
|
+
export default defineConfig({
|
|
56
|
+
schemaDir: './schemas',
|
|
57
|
+
outputDir: './generated',
|
|
58
|
+
migrations: {
|
|
59
|
+
outputDir: './database/migrations',
|
|
60
|
+
},
|
|
61
|
+
typescript: {
|
|
62
|
+
outputDir: './types',
|
|
63
|
+
},
|
|
64
|
+
});
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Related Packages
|
|
68
|
+
|
|
69
|
+
- [@famgia/omnify-core](https://www.npmjs.com/package/@famgia/omnify-core) - Core engine
|
|
70
|
+
- [@famgia/omnify-types](https://www.npmjs.com/package/@famgia/omnify-types) - Type definitions
|
|
71
|
+
- [@famgia/omnify-laravel](https://www.npmjs.com/package/@famgia/omnify-laravel) - Laravel generator
|
|
72
|
+
- [@famgia/omnify-atlas](https://www.npmjs.com/package/@famgia/omnify-atlas) - Atlas adapter
|
|
73
|
+
|
|
74
|
+
## License
|
|
75
|
+
|
|
76
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@famgia/omnify-cli",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"description": "CLI interface for omnify-schema",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -17,16 +17,17 @@
|
|
|
17
17
|
}
|
|
18
18
|
},
|
|
19
19
|
"files": [
|
|
20
|
-
"dist"
|
|
20
|
+
"dist",
|
|
21
|
+
"README.md"
|
|
21
22
|
],
|
|
22
23
|
"dependencies": {
|
|
23
24
|
"commander": "^14.0.2",
|
|
24
25
|
"jiti": "^2.6.1",
|
|
25
26
|
"picocolors": "^1.1.1",
|
|
26
|
-
"@famgia/omnify-atlas": "0.0.
|
|
27
|
-
"@famgia/omnify-core": "0.0.
|
|
28
|
-
"@famgia/omnify-laravel": "0.0.
|
|
29
|
-
"@famgia/omnify-types": "0.0.
|
|
27
|
+
"@famgia/omnify-atlas": "0.0.2",
|
|
28
|
+
"@famgia/omnify-core": "0.0.2",
|
|
29
|
+
"@famgia/omnify-laravel": "0.0.2",
|
|
30
|
+
"@famgia/omnify-types": "0.0.2"
|
|
30
31
|
},
|
|
31
32
|
"scripts": {
|
|
32
33
|
"build": "tsup",
|