Skip to content

Commit 4de0638

Browse files
committed
docs: add documentation generation
1 parent 580e850 commit 4de0638

File tree

8 files changed

+238
-6
lines changed

8 files changed

+238
-6
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules
22
/.vscode
3+
/docs

package-lock.json

+211
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"scripts": {
77
"lint:format": "npx prettier --write .",
88
"lint:check": "npx prettier --check .",
9+
"docs": "typedoc",
910
"prepare": "husky install && npm run lint:check",
1011
"test": "echo \"Error: no test specified\" && exit 1"
1112
},
@@ -31,6 +32,7 @@
3132
"lerna": "^4.0.0",
3233
"lint-staged": "^11.1.0",
3334
"prettier": "2.3.2",
35+
"typedoc": "^0.21.5",
3436
"typescript": "^4.3.5"
3537
},
3638
"lint-staged": {

packages/client/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
bower_components
22
node_modules
3+
/lib/
34
/dist/

packages/client/package.json

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22
"name": "@nymphjs/client",
33
"version": "1.0.0-alpha.0",
44
"description": "NymphJS - Client",
5-
"main": "dist/index.js",
6-
"types": "dist/index.d.ts",
5+
"browser": "dist/index.js",
6+
"main": "lib/index.js",
7+
"types": "lib/index.d.ts",
78
"keywords": [
89
"nymph",
910
"ORM",
1011
"object relational mapper"
1112
],
1213
"scripts": {
13-
"build": "webpack",
14-
"watch": "webpack --watch",
14+
"build": "npm run build:ts && npm run build:js",
15+
"build:ts": "tsc",
16+
"build:js": "webpack",
17+
"watch:ts": "tsc --watch",
18+
"watch:js": "webpack --watch",
1519
"prepare": "npm run build",
1620
"test": "jest --detectOpenHandles",
1721
"test:watch": "jest --watch"

packages/client/tsconfig.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"noImplicitAny": true,
66
"removeComments": true,
77
"sourceMap": true,
8-
"outDir": "dist",
8+
"outDir": "lib",
99
"resolveJsonModule": true,
1010
"rootDir": "src/",
1111
"declaration": true

0 commit comments

Comments
 (0)