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.

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

chore: Change typedoc setup to use monorepo. #261

Merged
merged 5 commits into from
Aug 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion actions/ci/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ runs:

- name: Build Docs
shell: bash
run: yarn workspace ${{ inputs.workspace_name }} doc
run: yarn build:doc -- ${{ inputs.workspace_path }}
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"clean": "yarn workspaces foreach -pt run clean",
"build": "yarn workspaces foreach -p --topological-dev run build",
"//": "When using build:doc you need to specify the workspace. 'yarn run build:doc packages/shared/common' for example.",
"build:doc": "./scripts/build-doc.sh $1",
"build:doc": "npx typedoc --options $1/typedoc.json",
"lint": "npx eslint . --ext .ts",
"lint:fix": "yarn run lint -- --fix",
"test": "echo Please run tests for individual packages.",
Expand All @@ -43,7 +43,7 @@
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-prettier": "^5.0.0",
"prettier": "^3.0.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
},
"packageManager": "[email protected]"
Expand Down
3 changes: 1 addition & 2 deletions packages/sdk/akamai-base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
"dist"
],
"scripts": {
"doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts",
"build": "rollup -c rollup.config.js && ../../../scripts/replace-version.sh .",
"clean": "rimraf dist",
"tsw": "yarn tsc --watch",
Expand Down Expand Up @@ -69,7 +68,7 @@
"rollup": "^3.23.0",
"rollup-plugin-generate-package-json": "^3.2.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
},
"dependencies": {
Expand Down
5 changes: 5 additions & 0 deletions packages/sdk/akamai-base/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/sdk/akamai-edgekv/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
"dist"
],
"scripts": {
"doc": "npx typedoc --name \"$(../../../scripts/doc-name.sh .)\" --readme none --entryPointStrategy resolve src/index.ts",
"build": "rollup -c rollup.config.js && ../../../scripts/replace-version.sh .",
"clean": "rimraf dist",
"tsw": "yarn tsc --watch",
Expand Down Expand Up @@ -69,7 +68,7 @@
"rollup": "^3.23.0",
"rollup-plugin-generate-package-json": "^3.2.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
},
"dependencies": {
Expand Down
5 changes: 5 additions & 0 deletions packages/sdk/akamai-edgekv/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/sdk/cloudflare/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
"dist"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"build": "../../../scripts/build-package.sh",
"clean": "rimraf dist",
"tsw": "yarn tsc --watch",
Expand Down Expand Up @@ -60,7 +59,7 @@
"prettier": "^3.0.0",
"rimraf": "^5.0.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/sdk/cloudflare/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/sdk/server-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
"client"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"clean": "npx tsc --build --clean",
"//": "We run the tests in-band because the FS tests work best sequential.",
"test": "npx jest --ci --runInBand",
Expand Down Expand Up @@ -65,7 +64,7 @@
"launchdarkly-js-test-helpers": "^2.2.0",
"prettier": "^3.0.0",
"ts-jest": "^29.0.5",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/sdk/server-node/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/sdk/vercel/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"dist"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"build": "../../../scripts/build-package.sh && ../../../scripts/replace-version.sh .",
"clean": "rimraf dist",
"tsw": "yarn tsc --watch",
Expand Down Expand Up @@ -58,7 +57,7 @@
"prettier": "^3.0.0",
"rimraf": "^5.0.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/sdk/vercel/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/shared/akamai-edgeworker-sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
"dist"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"test": "npx jest --ci",
"build": "npx tsc",
"clean": "npx tsc --build --clean",
Expand Down Expand Up @@ -51,7 +50,7 @@
"rollup": "^3.23.0",
"rollup-plugin-generate-package-json": "^3.2.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
},
"dependencies": {
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/akamai-edgeworker-sdk/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"entryPoints": ["src/index.ts"],
"out": "docs",
"skipErrorChecking": true
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typedoc cannot handle the package.json inclusion. This makes it ignore it.

}
3 changes: 1 addition & 2 deletions packages/shared/common/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"client"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"test": "npx jest --ci",
"build": "npx tsc",
"clean": "npx tsc --build --clean",
Expand All @@ -42,7 +41,7 @@
"launchdarkly-js-test-helpers": "^2.2.0",
"prettier": "^3.0.0",
"ts-jest": "^29.0.5",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/shared/common/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/shared/sdk-server-edge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"dist"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"build": "../../../scripts/build-package.sh",
"tsw": "yarn tsc --watch",
"clean": "rimraf dist",
Expand Down Expand Up @@ -59,7 +58,7 @@
"prettier": "^3.0.0",
"rimraf": "^5.0.0",
"ts-jest": "^29.1.0",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/shared/sdk-server-edge/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
3 changes: 1 addition & 2 deletions packages/shared/sdk-server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
"client"
],
"scripts": {
"doc": "../../../scripts/build-doc.sh .",
"test": "npx jest --ci",
"build": "npx tsc",
"clean": "npx tsc --build --clean",
Expand Down Expand Up @@ -48,7 +47,7 @@
"launchdarkly-js-test-helpers": "^2.2.0",
"prettier": "^3.0.0",
"ts-jest": "^29.0.5",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
5 changes: 5 additions & 0 deletions packages/shared/sdk-server/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
5 changes: 2 additions & 3 deletions packages/store/node-server-sdk-dynamodb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
"test": "npx jest --ci --runInBand",
"build": "npx tsc",
"lint": "npx eslint . --ext .ts",
"lint:fix": "yarn run lint --fix",
"doc": "../../../scripts/build-doc.sh ."
"lint:fix": "yarn run lint --fix"
},
"dependencies": {
"ioredis": "^5.3.2"
Expand All @@ -51,7 +50,7 @@
"launchdarkly-js-test-helpers": "^2.2.0",
"prettier": "^3.0.0",
"ts-jest": "^29.0.5",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
7 changes: 7 additions & 0 deletions packages/store/node-server-sdk-dynamodb/tsconfig.ref.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"composite": true
}
}
5 changes: 5 additions & 0 deletions packages/store/node-server-sdk-dynamodb/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
5 changes: 2 additions & 3 deletions packages/store/node-server-sdk-redis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@
"test": "npx jest --ci --runInBand",
"build": "npx tsc",
"lint": "npx eslint . --ext .ts",
"lint:fix": "yarn run lint --fix",
"doc": "../../../scripts/build-doc.sh ."
"lint:fix": "yarn run lint --fix"
},
"dependencies": {
"ioredis": "^5.3.2"
Expand All @@ -49,7 +48,7 @@
"launchdarkly-js-test-helpers": "^2.2.0",
"prettier": "^3.0.0",
"ts-jest": "^29.0.5",
"typedoc": "0.24.8",
"typedoc": "0.25.0",
"typescript": "5.1.6"
}
}
7 changes: 7 additions & 0 deletions packages/store/node-server-sdk-redis/tsconfig.ref.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "./tsconfig.json",
"include": ["src/**/*"],
"compilerOptions": {
"composite": true
}
}
5 changes: 5 additions & 0 deletions packages/store/node-server-sdk-redis/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": ["../../../typedoc.base.json"],
"entryPoints": ["src/index.ts"],
"out": "docs"
}
12 changes: 0 additions & 12 deletions scripts/build-doc.sh

This file was deleted.

6 changes: 6 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@
},
{
"path": "./packages/sdk/akamai-base/tsconfig.ref.json"
},
{
"path": "./packages/store/node-server-sdk-redis/tsconfig.ref.json"
},
{
"path": "./packages/store/node-server-sdk-dynamodb/tsconfig.ref.json"
}
]
}
5 changes: 5 additions & 0 deletions typedoc.base.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"readme": "none"
}