Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Generate TypeDoc docs #236

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

[WIP] Generate TypeDoc docs #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
77bec99
Remove `tsconfig` package and update TypeScript to v5.1.6
TooTallNate Aug 22, 2023
4dd4804
Add `tsconfig.base.json`
TooTallNate Aug 22, 2023
7b3557c
[WIP] Generate TypeDoc docs
TooTallNate Aug 22, 2023
b2c0eff
.
TooTallNate Aug 22, 2023
12fb93b
Merge branch 'main' of https://github.com/TooTallNate/node-https-prox…
TooTallNate Aug 22, 2023
36584fe
.
TooTallNate Aug 22, 2023
543347e
Merge branch 'main' of https://github.com/TooTallNate/node-https-prox…
TooTallNate Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"private": true,
"name": "proxy-agent-monorepo",
"scripts": {
"docs": "typedoc",
"build": "turbo run build",
"lint": "turbo run lint",
"test": "turbo run test",
Expand All @@ -18,6 +19,7 @@
"eslint-config-prettier": "^8.8.0",
"eslint-config-turbo": "^1.9.3",
"prettier": "^2.8.8",
"turbo": "^1.10.8"
"turbo": "^1.10.8",
"typedoc": "^0.24.8"
}
}
3 changes: 1 addition & 2 deletions packages/agent-base/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
"async-listen": "^3.0.0",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4",
"typescript": "^5.1.6",
"ws": "^3.3.3"
},
"engines": {
Expand Down
12 changes: 8 additions & 4 deletions packages/agent-base/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/agent-base/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/data-uri-to-buffer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
"@types/node": "^14.18.45",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
}
}
12 changes: 8 additions & 4 deletions packages/data-uri-to-buffer/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/data-uri-to-buffer/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
1 change: 0 additions & 1 deletion packages/degenerator/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
"@types/node": "^14.18.52",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.1.6"
}
}
12 changes: 8 additions & 4 deletions packages/degenerator/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/degenerator/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/get-uri/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@
"jest": "^29.5.0",
"st": "^1.2.2",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"dependencies": {
"basic-ftp": "^5.0.2",
Expand Down
13 changes: 10 additions & 3 deletions packages/get-uri/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"strict": true,
"module": "CommonJS",
"target": "es2020",
"esModuleInterop": true,
"lib": ["esnext"],
"lib": [
"esnext"
],
"outDir": "dist",
"sourceMap": true,
"declaration": true,
Expand All @@ -13,6 +16,10 @@
"./node_modules/@types"
]
},
"include": ["src/**/*"],
"exclude": ["node_modules"]
"include": [
"src/**/*"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/get-uri/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/http-proxy-agent/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
"jest": "^29.5.0",
"proxy": "workspace:*",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"engines": {
"node": ">= 14"
Expand Down
12 changes: 8 additions & 4 deletions packages/http-proxy-agent/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/http-proxy-agent/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/https-proxy-agent/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
"jest": "^29.5.0",
"proxy": "workspace:*",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"engines": {
"node": ">= 14"
Expand Down
12 changes: 8 additions & 4 deletions packages/https-proxy-agent/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/https-proxy-agent/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/pac-proxy-agent/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@
"proxy": "workspace:*",
"socksv5": "0.0.6",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"engines": {
"node": ">= 14"
Expand Down
12 changes: 8 additions & 4 deletions packages/pac-proxy-agent/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/pac-proxy-agent/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
1 change: 0 additions & 1 deletion packages/pac-resolver/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
"@types/node": "^14.18.52",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.1.6"
},
"scripts": {
Expand Down
12 changes: 8 additions & 4 deletions packages/pac-resolver/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/pac-resolver/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/proxy-agent/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,7 @@
"proxy": "workspace:*",
"socksv5": "github:TooTallNate/socksv5#fix/dstSock-close-event",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4",
"typescript": "^5.1.6",
"ws": "^8.13.0"
}
}
12 changes: 8 additions & 4 deletions packages/proxy-agent/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/proxy-agent/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
3 changes: 1 addition & 2 deletions packages/proxy/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@
"async-listen": "^3.0.0",
"jest": "^29.5.0",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"engines": {
"node": ">= 14"
Expand Down
12 changes: 8 additions & 4 deletions packages/proxy/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
3 changes: 1 addition & 2 deletions packages/socks-proxy-agent/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,7 @@
"proxy": "workspace:*",
"socksv5": "github:TooTallNate/socksv5#fix/dstSock-close-event",
"ts-jest": "^29.1.0",
"tsconfig": "workspace:*",
"typescript": "^5.0.4"
"typescript": "^5.1.6"
},
"engines": {
"node": ">= 14"
Expand Down
12 changes: 8 additions & 4 deletions packages/socks-proxy-agent/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"extends": "tsconfig/base.json",
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"outDir": "dist",
"outDir": "dist"
},
"include": ["src"],
"exclude": ["node_modules"]
"include": [
"src"
],
"exclude": [
"node_modules"
]
}
4 changes: 4 additions & 0 deletions packages/socks-proxy-agent/typedoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"]
}
6 changes: 0 additions & 6 deletions packages/tsconfig/package.json
View file
Open in desktop

This file was deleted.

Loading