czapp-shared 1.0.0 → 1.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 +31 -1
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -1,2 +1,32 @@
|
|
|
1
1
|
# Czapp Shared
|
|
2
|
-
This is a shared library for Czapp projects. It contains common
|
|
2
|
+
This is a shared library for Czapp projects. It contains common types and utils that is are needed by both client and
|
|
3
|
+
server repositories.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
To install:
|
|
7
|
+
```bash
|
|
8
|
+
npm install czapp-shared
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## To use
|
|
12
|
+
```typescript
|
|
13
|
+
import { MyType } from 'czapp-shared';
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Development
|
|
17
|
+
To build:
|
|
18
|
+
```bash
|
|
19
|
+
npm run build
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
To test:
|
|
23
|
+
```bash
|
|
24
|
+
npm run test
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
To release new version (bump version, commit, tag, push):
|
|
28
|
+
```bash
|
|
29
|
+
npm run release:bump
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "czapp-shared",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "This is a shared library for Czapp projects. It contains common code that is used across multiple projects.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
7
7
|
"typings": "dist/index.d.ts",
|
|
8
8
|
"scripts": {
|
|
9
9
|
"test:unit": "mocha --require ts-node/register/transpile-only test/**/*.ts",
|
|
10
|
-
"build": "tsup src/index.ts --clean --format=cjs,esm --dts"
|
|
10
|
+
"build": "tsup src/index.ts --clean --format=cjs,esm --dts",
|
|
11
|
+
"release:bump": "bumpp"
|
|
11
12
|
},
|
|
12
13
|
"repository": {
|
|
13
14
|
"type": "git",
|
|
@@ -21,6 +22,7 @@
|
|
|
21
22
|
"@types/mocha": "^10.0.6",
|
|
22
23
|
"@types/node": "^18.11.9",
|
|
23
24
|
"@types/sinon": "^10.0.13",
|
|
25
|
+
"bumpp": "^9.5.2",
|
|
24
26
|
"chai": "^3.0.0",
|
|
25
27
|
"mocha": "^10.5.2",
|
|
26
28
|
"mysql2": "^3.11.3",
|