@nizza/core 0.5.6 → 0.5.7
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 +1 -87
- package/dist/index.cjs +6 -6
- package/dist/index.mjs +1628 -1629
- package/dist/lib/types/api-graphql-types.d.ts +0 -30
- package/dist/lib/types/nizza/chat.d.ts +0 -1
- package/dist/lib/utils/createLazyLogger.d.ts +3 -2
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,89 +1,3 @@
|
|
|
1
1
|
# Core
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Key Principle
|
|
6
|
-
|
|
7
|
-
The `core` library must not depend on any other libraries within the monorepo. This RULE must always be maintained to avoid circular dependency issues.
|
|
8
|
-
|
|
9
|
-
## Versioning
|
|
10
|
-
|
|
11
|
-
Manage library versioning using the `@jscutlery/semver` tool, which automates semantic versioning based on your git history:
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
pnpm nx run core:version
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
For more details, refer to the official [SemVer documentation](https://github.com/jscutlery/semver).
|
|
18
|
-
|
|
19
|
-
## Publishing
|
|
20
|
-
|
|
21
|
-
Publish the library, automatically applying the appropriate tag based on the target environment:
|
|
22
|
-
|
|
23
|
-
- For feature branches (alpha release):
|
|
24
|
-
```bash
|
|
25
|
-
pnpm nx run core:publish:feat
|
|
26
|
-
```
|
|
27
|
-
- For development (beta release):
|
|
28
|
-
```bash
|
|
29
|
-
pnpm nx run core:publish:dev
|
|
30
|
-
```
|
|
31
|
-
- For production releases (stable release):
|
|
32
|
-
```bash
|
|
33
|
-
pnpm nx run core:publish:prod
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
## Building
|
|
37
|
-
|
|
38
|
-
Build the library, specifying the target environment:
|
|
39
|
-
|
|
40
|
-
- For local development:
|
|
41
|
-
```bash
|
|
42
|
-
pnpm nx run core:build:local
|
|
43
|
-
```
|
|
44
|
-
- For development environment:
|
|
45
|
-
```bash
|
|
46
|
-
pnpm nx run core:build:dev
|
|
47
|
-
```
|
|
48
|
-
- For staging environment:
|
|
49
|
-
```bash
|
|
50
|
-
pnpm nx run core:build:staging
|
|
51
|
-
```
|
|
52
|
-
- For production:
|
|
53
|
-
```bash
|
|
54
|
-
pnpm nx run core:build:prod
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
## Generating GraphQL Types
|
|
58
|
-
|
|
59
|
-
Generate GraphQL types by connecting to the GraphQL API backend, utilizing [GraphQL Code Generator](https://the-guild.dev/graphql/codegen) for generating types based on your GraphQL schema:
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
pnpm nx run core:api-graphql-types
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
This process ensures that the frontend and backend are in sync by generating types that match the current schema.
|
|
66
|
-
|
|
67
|
-
## Cleaning
|
|
68
|
-
|
|
69
|
-
Clean up build artifacts to maintain a tidy workspace:
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
pnpm nx run core:clean
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
## Testing
|
|
76
|
-
|
|
77
|
-
Run unit tests for the library:
|
|
78
|
-
|
|
79
|
-
```bash
|
|
80
|
-
pnpm nx run core:test
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## Linting
|
|
84
|
-
|
|
85
|
-
Lint the project to ensure code quality and adherence to standards:
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
pnpm nx run core:lint
|
|
89
|
-
```
|
|
3
|
+
Library used to store reusable pieces of code that may or may not be necessary for libs and apps to work
|