@retroachievements/api 1.0.0-rc.5 → 1.0.0
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/LICENSE.md +1 -1
- package/README.md +7 -13
- package/package.json +8 -7
package/LICENSE.md
CHANGED
package/README.md
CHANGED
|
@@ -10,24 +10,14 @@
|
|
|
10
10
|
<br />
|
|
11
11
|
</p>
|
|
12
12
|
|
|
13
|
-
<p align="center">
|
|
14
|
-
<a href="https://github.com/prettier/prettier">
|
|
15
|
-
<img src="https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square" alt="Styled with Prettier" />
|
|
16
|
-
</a>
|
|
17
|
-
<a href="https://github.com/semantic-release/semantic-release">
|
|
18
|
-
<img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="Semantic Release" />
|
|
19
|
-
</a>
|
|
20
|
-
</p>
|
|
21
|
-
|
|
22
13
|
<hr />
|
|
23
14
|
|
|
24
15
|
## Features
|
|
25
16
|
|
|
26
|
-
✅ Modular by design
|
|
17
|
+
✅ Modular by design and supports tree-shaking.
|
|
27
18
|
✅ Officially-supported, aligns 1:1 with the RAWeb API.
|
|
28
|
-
✅ Backwards-compatible
|
|
29
|
-
✅ Supports Node environments (
|
|
30
|
-
✅ Supports browsers.
|
|
19
|
+
✅ Backwards-compatible, easy migration path to API v2.
|
|
20
|
+
✅ Supports Node environments (16 and above).
|
|
31
21
|
✅ Ships with TypeScript support and types.
|
|
32
22
|
✅ Correctly maps types and properties from RAWeb PHP calls.
|
|
33
23
|
✅ Small, <3Kb.
|
|
@@ -137,6 +127,10 @@ TODO
|
|
|
137
127
|
|
|
138
128
|
Let us know about yours by [opening an issue](https://github.com/RetroAchievements/retroachievements-api-js/issues/new)!
|
|
139
129
|
|
|
130
|
+
## How to Contribute
|
|
131
|
+
|
|
132
|
+
Check out [CONTRIBUTING.md](https://github.com/RetroAchievements/retroachievements-api-js/blob/main/CONTRIBUTING.md) for how to get started.
|
|
133
|
+
|
|
140
134
|
## Contributors
|
|
141
135
|
|
|
142
136
|
<!-- prettier-ignore-start -->
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"raweb",
|
|
11
11
|
"retro gaming"
|
|
12
12
|
],
|
|
13
|
-
"version": "1.0.0
|
|
13
|
+
"version": "1.0.0",
|
|
14
14
|
"typings": "dist/index.d.ts",
|
|
15
15
|
"exports": {
|
|
16
16
|
".": {
|
|
@@ -37,14 +37,15 @@
|
|
|
37
37
|
"format:check": "prettier --check . '**/*.{json,md,js,ts,tsx}'",
|
|
38
38
|
"lint": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx .",
|
|
39
39
|
"lint:fix": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx . --fix",
|
|
40
|
-
"test": "jest --selectProjects UNIT",
|
|
40
|
+
"test": "NODE_OPTIONS='--no-experimental-fetch' jest --selectProjects UNIT",
|
|
41
41
|
"test:coverage": "jest --selectProjects UNIT --coverage",
|
|
42
|
-
"verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size",
|
|
42
|
+
"verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size && yarn docs:build",
|
|
43
43
|
"size": "size-limit",
|
|
44
44
|
"start": "microbundle watch",
|
|
45
45
|
"docs:dev": "vitepress dev docs",
|
|
46
46
|
"docs:build": "vitepress build docs",
|
|
47
|
-
"docs:preview": "vitepress preview docs"
|
|
47
|
+
"docs:preview": "vitepress preview docs",
|
|
48
|
+
"npm:release": "yarn build && npm publish --access public"
|
|
48
49
|
},
|
|
49
50
|
"dependencies": {
|
|
50
51
|
"isomorphic-unfetch": "^3.1.0"
|
|
@@ -70,10 +71,10 @@
|
|
|
70
71
|
"eslint-plugin-simple-import-sort": "^10.0.0",
|
|
71
72
|
"eslint-plugin-sonarjs": "^0.18.0",
|
|
72
73
|
"eslint-plugin-unicorn": "^45.0.2",
|
|
73
|
-
"husky": "
|
|
74
|
+
"husky": "4.3.8",
|
|
74
75
|
"jest": "^29.4.1",
|
|
75
76
|
"microbundle": "^0.15.1",
|
|
76
|
-
"msw": "^1.0.
|
|
77
|
+
"msw": "^1.0.1",
|
|
77
78
|
"prettier": "2.8.3",
|
|
78
79
|
"pretty-quick": "3.1.3",
|
|
79
80
|
"size-limit": "^8.1.2",
|
|
@@ -105,7 +106,7 @@
|
|
|
105
106
|
}
|
|
106
107
|
},
|
|
107
108
|
"engines": {
|
|
108
|
-
"node": ">=
|
|
109
|
+
"node": ">=16",
|
|
109
110
|
"npm": "please-use-yarn",
|
|
110
111
|
"yarn": ">= 1.19.1"
|
|
111
112
|
},
|