Skip to content

Commit 7565ae3

Browse files
leibaleleibale
committedDec 13, 2021
fix generated documentation
·
time-series@5.0.0-next.7bloom@1.0.0
1 parent aa63580 commit 7565ae3

15 files changed

+1109
-945
lines changed
 

‎.github/workflows/documentation.yml

+2-6
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,5 @@ jobs:
1919
run: npm ci
2020
- name: Generate Documentation
2121
run: npm run documentation
22-
- name: Upload Documentation to Wiki
23-
uses: SwiftDocOrg/github-wiki-publish-action@v1
24-
with:
25-
path: documentation
26-
env:
27-
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}
22+
- name: Upload
23+
run: npm run gh-pages

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ dist/
66
node_modules/
77
.DS_Store
88
dump.rdb
9+
documentation/

‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -307,12 +307,12 @@ Node Redis is supported with the following versions of Redis:
307307
308308
## Packages
309309

310-
| Name | Description |
311-
|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
312-
| [redis](./) | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis) [![Version](https://img.shields.io/npm/v/redis.svg)](https://www.npmjs.com/package/redis) |
313-
| [@node-redis/client](./packages/client) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Version](https://img.shields.io/npm/v/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) |
314-
| [@node-redis/json](./packages/json) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Version](https://img.shields.io/npm/v/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [Redis JSON](https://oss.redis.com/redisjson/) commands |
315-
| [@node-redis/search](./packages/search) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Version](https://img.shields.io/npm/v/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [Redis Search](https://oss.redis.com/redisearch/) commands |
310+
| Name | Description |
311+
|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
312+
| [redis](./) | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis) [![Version](https://img.shields.io/npm/v/redis.svg)](https://www.npmjs.com/package/redis) |
313+
| [@node-redis/client](./packages/client) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Version](https://img.shields.io/npm/v/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/client/) |
314+
| [@node-redis/json](./packages/json) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Version](https://img.shields.io/npm/v/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/json/) [Redis JSON](https://oss.redis.com/redisjson/) commands |
315+
| [@node-redis/search](./packages/search) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Version](https://img.shields.io/npm/v/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/search/) [Redis Search](https://oss.redis.com/redisearch/) commands |
316316

317317
## Contributing
318318

‎package-lock.json

+1,027-899
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
"build:tests-tools": "npm run build:client && npm run build:test-utils",
1616
"build:modules": "find ./packages -mindepth 1 -maxdepth 1 -type d ! -name 'client' ! -name 'test-utils' -exec npm run build -w {} \\;",
1717
"build": "tsc",
18-
"build-all": "npm run build:client && npm run build:test-utils && npm run build:modules && npm run build"
18+
"build-all": "npm run build:client && npm run build:test-utils && npm run build:modules && npm run build",
19+
"documentation": "npm run documentation -ws --if-present",
20+
"gh-pages": "gh-pages -d ./documentation -e ./documentation"
1921
},
2022
"dependencies": {
2123
"@node-redis/client": "^1.0.0",
@@ -24,8 +26,10 @@
2426
},
2527
"devDependencies": {
2628
"@tsconfig/node12": "^1.0.9",
29+
"gh-pages": "^3.2.3",
2730
"release-it": "^14.11.8",
28-
"typescript": "^4.5.2"
31+
"typedoc": "^0.22.10",
32+
"typescript": "^4.5.3"
2933
},
3034
"repository": {
3135
"type": "git",

‎packages/client/.gitignore

-1
This file was deleted.

‎packages/client/package.json

+6-8
Original file line numberDiff line numberDiff line change
@@ -17,24 +17,22 @@
1717
"yallist": "4.0.0"
1818
},
1919
"devDependencies": {
20-
"@istanbuljs/nyc-config-typescript": "^1.0.1",
20+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
2121
"@node-redis/test-utils": "*",
22-
"@types/node": "^16.11.10",
22+
"@types/node": "^16.11.12",
2323
"@types/redis-parser": "^3.0.0",
2424
"@types/sinon": "^10.0.6",
2525
"@types/yallist": "^4.0.1",
26-
"@typescript-eslint/eslint-plugin": "^5.4.0",
27-
"@typescript-eslint/parser": "^5.4.0",
28-
"eslint": "^8.3.0",
26+
"@typescript-eslint/eslint-plugin": "^5.7.0",
27+
"@typescript-eslint/parser": "^5.7.0",
28+
"eslint": "^8.4.1",
2929
"nyc": "^15.1.0",
3030
"release-it": "^14.11.8",
3131
"sinon": "^12.0.1",
3232
"source-map-support": "^0.5.21",
3333
"ts-node": "^10.4.0",
3434
"typedoc": "^0.22.10",
35-
"typedoc-github-wiki-theme": "^0.6.0",
36-
"typedoc-plugin-markdown": "^3.11.7",
37-
"typescript": "^4.5.2"
35+
"typescript": "^4.5.3"
3836
},
3937
"engines": {
4038
"node": ">=12"

‎packages/client/tsconfig.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
"./lib/ts-declarations",
2222
"./lib/test-utils.ts"
2323
],
24-
"theme": "./node_modules/typedoc-github-wiki-theme/dist",
25-
"out": "documentation"
24+
"out": "../../documentation/client"
2625
}
2726
}

‎packages/json/package.json

+6-4
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66
"types": "./dist/index.d.ts",
77
"scripts": {
88
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
9-
"build": "tsc"
9+
"build": "tsc",
10+
"documentation": "typedoc"
1011
},
1112
"peerDependencies": {
1213
"@node-redis/client": "^1.0.0"
1314
},
1415
"devDependencies": {
15-
"@istanbuljs/nyc-config-typescript": "^1.0.1",
16+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
1617
"@node-redis/test-utils": "*",
17-
"@types/node": "^16.11.10",
18+
"@types/node": "^16.11.12",
1819
"nyc": "^15.1.0",
1920
"release-it": "^14.11.8",
2021
"source-map-support": "^0.5.21",
2122
"ts-node": "^10.4.0",
22-
"typescript": "^4.5.2"
23+
"typedoc": "^0.22.10",
24+
"typescript": "^4.5.3"
2325
}
2426
}

‎packages/json/tsconfig.json

+12-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,16 @@
55
},
66
"include": [
77
"./lib/**/*.ts"
8-
]
8+
],
9+
"typedocOptions": {
10+
"entryPoints": [
11+
"./lib"
12+
],
13+
"entryPointStrategy": "expand",
14+
"exclude": [
15+
"./lib/test-utils.ts",
16+
"./lib/**/*.spec.ts"
17+
],
18+
"out": "../../documentation/json"
19+
}
920
}

‎packages/search/package.json

+6-4
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66
"types": "./dist/index.d.ts",
77
"scripts": {
88
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
9-
"build": "tsc"
9+
"build": "tsc",
10+
"documentation": "typedoc"
1011
},
1112
"peerDependencies": {
1213
"@node-redis/client": "^1.0.0"
1314
},
1415
"devDependencies": {
15-
"@istanbuljs/nyc-config-typescript": "^1.0.1",
16+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
1617
"@node-redis/test-utils": "*",
17-
"@types/node": "^16.11.10",
18+
"@types/node": "^16.11.12",
1819
"nyc": "^15.1.0",
1920
"release-it": "^14.11.8",
2021
"source-map-support": "^0.5.21",
2122
"ts-node": "^10.4.0",
22-
"typescript": "^4.5.2"
23+
"typedoc": "^0.22.10",
24+
"typescript": "^4.5.3"
2325
}
2426
}

‎packages/search/tsconfig.json

+12-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,16 @@
55
},
66
"include": [
77
"./lib/**/*.ts"
8-
]
8+
],
9+
"typedocOptions": {
10+
"entryPoints": [
11+
"./lib"
12+
],
13+
"entryPointStrategy": "expand",
14+
"exclude": [
15+
"./lib/test-utils.ts",
16+
"./lib/**/*.spec.ts"
17+
],
18+
"out": "../../documentation/search"
19+
}
920
}

‎packages/test-utils/package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@
1010
"@node-redis/client": "^1.0.0"
1111
},
1212
"devDependencies": {
13-
"@istanbuljs/nyc-config-typescript": "^1.0.1",
13+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
1414
"@types/mocha": "^9.0.0",
15-
"@types/node": "^16.11.10",
15+
"@types/node": "^16.11.12",
1616
"@types/yargs": "^17.0.7",
1717
"mocha": "^9.1.3",
1818
"nyc": "^15.1.0",
1919
"release-it": "^14.11.8",
2020
"source-map-support": "^0.5.21",
2121
"ts-node": "^10.4.0",
22-
"typescript": "^4.5.2",
23-
"yargs": "^17.2.1"
22+
"typescript": "^4.5.3",
23+
"yargs": "^17.3.0"
2424
}
2525
}

‎packages/time-series/package.json

+8-6
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,21 @@
66
"types": "./dist/index.d.ts",
77
"scripts": {
88
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
9-
"build": "tsc"
9+
"build": "tsc",
10+
"documentation": "typedoc"
1011
},
1112
"peerDependencies": {
1213
"@node-redis/client": "^1.0.0"
1314
},
1415
"devDependencies": {
15-
"@istanbuljs/nyc-config-typescript": "^1.0.1",
16+
"@istanbuljs/nyc-config-typescript": "^1.0.2",
1617
"@node-redis/test-utils": "*",
17-
"@types/node": "^16.11.7",
18+
"@types/node": "^16.11.12",
1819
"nyc": "^15.1.0",
19-
"release-it": "^14.11.7",
20-
"source-map-support": "^0.5.20",
20+
"release-it": "^14.11.8",
21+
"source-map-support": "^0.5.21",
2122
"ts-node": "^10.4.0",
22-
"typescript": "^4.4.4"
23+
"typedoc": "^0.22.10",
24+
"typescript": "^4.5.3"
2325
}
2426
}

‎packages/time-series/tsconfig.json

+12-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,16 @@
55
},
66
"include": [
77
"./lib/**/*.ts"
8-
]
8+
],
9+
"typedocOptions": {
10+
"entryPoints": [
11+
"./lib"
12+
],
13+
"entryPointStrategy": "expand",
14+
"exclude": [
15+
"./lib/test-utils.ts",
16+
"./lib/**/*.spec.ts"
17+
],
18+
"out": "../../documentation/time-series"
19+
}
920
}

0 commit comments

Comments
 (0)
Please sign in to comment.