@0xsquid/squid-types 0.1.44 → 0.1.46
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 +43 -1
- package/package.json +1 -6
package/README.md
CHANGED
|
@@ -1,3 +1,45 @@
|
|
|
1
1
|
# Squid Types
|
|
2
2
|
|
|
3
|
-
Squid types used on the graph, api and sdk
|
|
3
|
+
Squid types used on the graph, api and sdk.
|
|
4
|
+
|
|
5
|
+
### LINTER & PRETTIER
|
|
6
|
+
|
|
7
|
+
This project has installed prettier and linter rules, with husky we ensure pre-commit and pre-push validation.
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
yarn lint
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
yarn lint:fix
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
yarn format
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### VSCODE
|
|
22
|
+
|
|
23
|
+
Create `.vscode/setting.json` for auto-saving linter and prettier format
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
{
|
|
27
|
+
"editor.formatOnSave": true,
|
|
28
|
+
"editor.codeActionsOnSave": {
|
|
29
|
+
"source.fixAll.eslint": true
|
|
30
|
+
},
|
|
31
|
+
"[json]": {
|
|
32
|
+
"editor.defaultFormatter": "esbenp.prettier-vscode"
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
# RELEASE
|
|
38
|
+
|
|
39
|
+
NPM package publish is automated with github actions, follow these steps:
|
|
40
|
+
|
|
41
|
+
1 - Create a PR to `develop` branch updating `package.json` version. (review, approve and merge)
|
|
42
|
+
|
|
43
|
+
2 - Create a PR from `develop` to `main`. (review, approve and merge)
|
|
44
|
+
|
|
45
|
+
Once the PR to `main` is merged, this commit on this branch gonna trigger automatically the release to NPM, please make sure you update correctly the version.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@0xsquid/squid-types",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.46",
|
|
4
4
|
"description": "JS and TS types relating to 0xsquid related projects.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -72,11 +72,6 @@
|
|
|
72
72
|
"release": true,
|
|
73
73
|
"tokenRef": "GITHUB_AUTH"
|
|
74
74
|
},
|
|
75
|
-
"git": {
|
|
76
|
-
"tagName": "squid-types-v${version}",
|
|
77
|
-
"pushRepo": "https://github.com/0xsquid/squid-types.git",
|
|
78
|
-
"commitMessage": "chore: branch cut release for squid-types v${version}"
|
|
79
|
-
},
|
|
80
75
|
"npm": {
|
|
81
76
|
"publish": false
|
|
82
77
|
}
|