redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-01 16:46:54 +03:00
Code Activity

fix generated documentation

Browse Source
This commit is contained in:
leibale
2021-12-13 14:21:02 -05:00
parent aa63580b4b
commit 7565ae349d
15 changed files with 1088 additions and 924 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/workflows/documentation.yml vendored
View File

@ -19,9 +19,5 @@ jobs:
run: npm ci run: npm ci
- name: Generate Documentation - name: Generate Documentation
run: npm run documentation run: npm run documentation
- name: Upload Documentation to Wiki - name: Upload
uses: SwiftDocOrg/github-wiki-publish-action@v1 run: npm run gh-pages
with:
path: documentation
env:
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.BOT_PERSONAL_ACCESS_TOKEN }}

1
.gitignore vendored
View File

@ -6,3 +6,4 @@ dist/
node_modules/ node_modules/
.DS_Store .DS_Store
dump.rdb dump.rdb
documentation/

12
README.md
View File

@ -307,12 +307,12 @@ Node Redis is supported with the following versions of Redis:
## Packages ## Packages
| Name | Description | | Name | Description |
|-----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [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) | | [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) |
| [@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) | | [@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/) |
| [@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 | | [@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 |
| [@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 | | [@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 |
## Contributing ## Contributing

1884
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

8
package.json
View File

@ -15,7 +15,9 @@
"build:tests-tools": "npm run build:client && npm run build:test-utils", "build:tests-tools": "npm run build:client && npm run build:test-utils",
"build:modules": "find ./packages -mindepth 1 -maxdepth 1 -type d ! -name 'client' ! -name 'test-utils' -exec npm run build -w {} \\;", "build:modules": "find ./packages -mindepth 1 -maxdepth 1 -type d ! -name 'client' ! -name 'test-utils' -exec npm run build -w {} \\;",
"build": "tsc", "build": "tsc",
"build-all": "npm run build:client && npm run build:test-utils && npm run build:modules && npm run build" "build-all": "npm run build:client && npm run build:test-utils && npm run build:modules && npm run build",
"documentation": "npm run documentation -ws --if-present",
"gh-pages": "gh-pages -d ./documentation -e ./documentation"
}, },
"dependencies": { "dependencies": {
"@node-redis/client": "^1.0.0", "@node-redis/client": "^1.0.0",
@ -24,8 +26,10 @@
}, },
"devDependencies": { "devDependencies": {
"@tsconfig/node12": "^1.0.9", "@tsconfig/node12": "^1.0.9",
"gh-pages": "^3.2.3",
"release-it": "^14.11.8", "release-it": "^14.11.8",
"typescript": "^4.5.2" "typedoc": "^0.22.10",
"typescript": "^4.5.3"
}, },
"repository": { "repository": {
"type": "git", "type": "git",

1
packages/client/.gitignore vendored
View File

@ -1 +0,0 @@
documentation/

14
packages/client/package.json
View File

@ -17,24 +17,22 @@
"yallist": "4.0.0" "yallist": "4.0.0"
}, },
"devDependencies": { "devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@node-redis/test-utils": "*", "@node-redis/test-utils": "*",
"@types/node": "^16.11.10", "@types/node": "^16.11.12",
"@types/redis-parser": "^3.0.0", "@types/redis-parser": "^3.0.0",
"@types/sinon": "^10.0.6", "@types/sinon": "^10.0.6",
"@types/yallist": "^4.0.1", "@types/yallist": "^4.0.1",
"@typescript-eslint/eslint-plugin": "^5.4.0", "@typescript-eslint/eslint-plugin": "^5.7.0",
"@typescript-eslint/parser": "^5.4.0", "@typescript-eslint/parser": "^5.7.0",
"eslint": "^8.3.0", "eslint": "^8.4.1",
"nyc": "^15.1.0", "nyc": "^15.1.0",
"release-it": "^14.11.8", "release-it": "^14.11.8",
"sinon": "^12.0.1", "sinon": "^12.0.1",
"source-map-support": "^0.5.21", "source-map-support": "^0.5.21",
"ts-node": "^10.4.0", "ts-node": "^10.4.0",
"typedoc": "^0.22.10", "typedoc": "^0.22.10",
"typedoc-github-wiki-theme": "^0.6.0", "typescript": "^4.5.3"
"typedoc-plugin-markdown": "^3.11.7",
"typescript": "^4.5.2"
}, },
"engines": { "engines": {
"node": ">=12" "node": ">=12"

3
packages/client/tsconfig.json
View File

@ -21,7 +21,6 @@
"./lib/ts-declarations", "./lib/ts-declarations",
"./lib/test-utils.ts" "./lib/test-utils.ts"
], ],
"theme": "./node_modules/typedoc-github-wiki-theme/dist", "out": "../../documentation/client"
"out": "documentation"
} }
} }

10
packages/json/package.json
View File

@ -6,19 +6,21 @@
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"scripts": { "scripts": {
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'", "test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
"build": "tsc" "build": "tsc",
"documentation": "typedoc"
}, },
"peerDependencies": { "peerDependencies": {
"@node-redis/client": "^1.0.0" "@node-redis/client": "^1.0.0"
}, },
"devDependencies": { "devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@node-redis/test-utils": "*", "@node-redis/test-utils": "*",
"@types/node": "^16.11.10", "@types/node": "^16.11.12",
"nyc": "^15.1.0", "nyc": "^15.1.0",
"release-it": "^14.11.8", "release-it": "^14.11.8",
"source-map-support": "^0.5.21", "source-map-support": "^0.5.21",
"ts-node": "^10.4.0", "ts-node": "^10.4.0",
"typescript": "^4.5.2" "typedoc": "^0.22.10",
"typescript": "^4.5.3"
} }
} }

13
packages/json/tsconfig.json
View File

@ -5,5 +5,16 @@
}, },
"include": [ "include": [
"./lib/**/*.ts" "./lib/**/*.ts"
] ],
"typedocOptions": {
"entryPoints": [
"./lib"
],
"entryPointStrategy": "expand",
"exclude": [
"./lib/test-utils.ts",
"./lib/**/*.spec.ts"
],
"out": "../../documentation/json"
}
} }

10
packages/search/package.json
View File

@ -6,19 +6,21 @@
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"scripts": { "scripts": {
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'", "test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
"build": "tsc" "build": "tsc",
"documentation": "typedoc"
}, },
"peerDependencies": { "peerDependencies": {
"@node-redis/client": "^1.0.0" "@node-redis/client": "^1.0.0"
}, },
"devDependencies": { "devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@node-redis/test-utils": "*", "@node-redis/test-utils": "*",
"@types/node": "^16.11.10", "@types/node": "^16.11.12",
"nyc": "^15.1.0", "nyc": "^15.1.0",
"release-it": "^14.11.8", "release-it": "^14.11.8",
"source-map-support": "^0.5.21", "source-map-support": "^0.5.21",
"ts-node": "^10.4.0", "ts-node": "^10.4.0",
"typescript": "^4.5.2" "typedoc": "^0.22.10",
"typescript": "^4.5.3"
} }
} }

13
packages/search/tsconfig.json
View File

@ -5,5 +5,16 @@
}, },
"include": [ "include": [
"./lib/**/*.ts" "./lib/**/*.ts"
] ],
"typedocOptions": {
"entryPoints": [
"./lib"
],
"entryPointStrategy": "expand",
"exclude": [
"./lib/test-utils.ts",
"./lib/**/*.spec.ts"
],
"out": "../../documentation/search"
}
} }

8
packages/test-utils/package.json
View File

@ -10,16 +10,16 @@
"@node-redis/client": "^1.0.0" "@node-redis/client": "^1.0.0"
}, },
"devDependencies": { "devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@types/mocha": "^9.0.0", "@types/mocha": "^9.0.0",
"@types/node": "^16.11.10", "@types/node": "^16.11.12",
"@types/yargs": "^17.0.7", "@types/yargs": "^17.0.7",
"mocha": "^9.1.3", "mocha": "^9.1.3",
"nyc": "^15.1.0", "nyc": "^15.1.0",
"release-it": "^14.11.8", "release-it": "^14.11.8",
"source-map-support": "^0.5.21", "source-map-support": "^0.5.21",
"ts-node": "^10.4.0", "ts-node": "^10.4.0",
"typescript": "^4.5.2", "typescript": "^4.5.3",
"yargs": "^17.2.1" "yargs": "^17.3.0"
} }
} }

14
packages/time-series/package.json
View File

@ -6,19 +6,21 @@
"types": "./dist/index.d.ts", "types": "./dist/index.d.ts",
"scripts": { "scripts": {
"test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'", "test": "nyc -r text-summary -r lcov mocha -r source-map-support/register -r ts-node/register './lib/**/*.spec.ts'",
"build": "tsc" "build": "tsc",
"documentation": "typedoc"
}, },
"peerDependencies": { "peerDependencies": {
"@node-redis/client": "^1.0.0" "@node-redis/client": "^1.0.0"
}, },
"devDependencies": { "devDependencies": {
"@istanbuljs/nyc-config-typescript": "^1.0.1", "@istanbuljs/nyc-config-typescript": "^1.0.2",
"@node-redis/test-utils": "*", "@node-redis/test-utils": "*",
"@types/node": "^16.11.7", "@types/node": "^16.11.12",
"nyc": "^15.1.0", "nyc": "^15.1.0",
"release-it": "^14.11.7", "release-it": "^14.11.8",
"source-map-support": "^0.5.20", "source-map-support": "^0.5.21",
"ts-node": "^10.4.0", "ts-node": "^10.4.0",
"typescript": "^4.4.4" "typedoc": "^0.22.10",
"typescript": "^4.5.3"
} }
} }

13
packages/time-series/tsconfig.json
View File

@ -5,5 +5,16 @@
}, },
"include": [ "include": [
"./lib/**/*.ts" "./lib/**/*.ts"
] ],
"typedocOptions": {
"entryPoints": [
"./lib"
],
"entryPointStrategy": "expand",
"exclude": [
"./lib/test-utils.ts",
"./lib/**/*.spec.ts"
],
"out": "../../documentation/time-series"
}
} }