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

Update docgen to latest experimental version #4569

Merged
merged 16 commits into from
Mar 9, 2025
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
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"check-recursive": "pnpm --recursive exec tsc -b tsconfig.json",
"lint": "eslint \"**/{src,test,examples,scripts,dtslint}/**/*.{ts,mjs}\"",
"lint-fix": "pnpm lint --fix",
"docgen": "pnpm --recursive --parallel exec docgen && node scripts/docs.mjs",
"docgen": "pnpm --recursive exec docgen && node scripts/docs.mjs",
"test-types": "tstyche",
"changeset-version": "changeset version && node scripts/version.mjs",
"changeset-publish": "pnpm codemod && pnpm build && TEST_DIST= pnpm vitest && changeset publish"
Expand All @@ -40,7 +40,7 @@
"@changesets/cli": "^2.27.7",
"@edge-runtime/vm": "^4.0.0",
"@effect/build-utils": "^0.7.7",
"@effect/docgen": "^0.5.2",
"@effect/docgen": "https://pkg.pr.new/Effect-TS/docgen/@effect/docgen@bdf507c",
"@effect/eslint-plugin": "^0.2.0",
"@effect/language-service": "^0.1.0",
"@effect/vitest": "workspace:^",
Expand Down
1 change: 1 addition & 0 deletions packages/ai/ai/docgen.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "../../../node_modules/@effect/docgen/schema.json",
"exclude": ["src/internal/**/*.ts"],
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/ai/ai/src/",
"examplesCompilerOptions": {
"noEmit": true,
"strict": true,
Expand Down
1 change: 1 addition & 0 deletions packages/ai/anthropic/docgen.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "../../../node_modules/@effect/docgen/schema.json",
"exclude": ["src/Generated.ts", "src/internal/**/*.ts"],
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/ai/anthropic/src/",
"examplesCompilerOptions": {
"noEmit": true,
"strict": true,
Expand Down
1 change: 1 addition & 0 deletions packages/ai/openai/docgen.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "../../../node_modules/@effect/docgen/schema.json",
"exclude": ["src/Generated.ts", "src/internal/**/*.ts"],
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/ai/openai/src/",
"examplesCompilerOptions": {
"noEmit": true,
"strict": true,
Expand Down
7 changes: 5 additions & 2 deletions packages/cli/docgen.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"exclude": ["src/internal/**/*.ts"],
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/cli/src/",
"examplesCompilerOptions": {
"noEmit": true,
"strict": true,
"skipLibCheck": true,
"moduleResolution": "Bundler",
"module": "ES2022",
"target": "ES2022",
"lib": ["ES2022", "DOM"],
"lib": ["ES2022", "DOM", "DOM.Iterable"],
"paths": {
"effect": ["../../../effect/src/index.js"],
"effect/*": ["../../../effect/src/*.js"],
Expand All @@ -27,7 +28,9 @@
"@effect/printer-ansi": ["../../../printer-ansi/src/index.js"],
"@effect/printer-ansi/*": ["../../../printer-ansi/src/*.js"],
"@effect/typeclass": ["../../../typeclass/src/index.js"],
"@effect/typeclass/*": ["../../../typeclass/src/*.js"]
"@effect/typeclass/*": ["../../../typeclass/src/*.js"],
"@effect/cli": ["../../../cli/src/index.js"],
"@effect/cli/*": ["../../../cli/src/*.js"]
}
}
}
6 changes: 4 additions & 2 deletions packages/cli/src/Options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,8 @@ export const boolean: (name: string, options?: Options.BooleanOptionsConfig) =>
* Constructs command-line `Options` that represent a choice between several
* inputs. The input will be mapped to it's associated value during parsing.
*
* @example
* **Example**
*
* ```ts
* import * as Options from "@effect/cli/Options"
*
Expand All @@ -175,7 +176,8 @@ export const choice: <A extends string, C extends ReadonlyArray<A>>(
* Constructs command-line `Options` that represent a choice between several
* inputs. The input will be mapped to it's associated value during parsing.
*
* @example
* **Example**
*
* ```ts
* import * as Options from "@effect/cli/Options"
* import * as Data from "effect/Data"
Expand Down
5 changes: 2 additions & 3 deletions packages/cli/src/Prompt.ts
Original file line number Diff line number Diff line change
Expand Up @@ -516,11 +516,10 @@ export declare namespace All {
* Supports either a tuple / iterable of prompts or a record / struct of prompts
* as an argument.
*
* @example
* **Example**
*
* ```ts
* import * as Prompt from "@effect/cli/Prompt"
* import * as NodeContext from "@effect/platform-node/NodeContext"
* import * as Runtime from "@effect/platform-node/NodeRuntime"
* import * as Effect from "effect/Effect"
*
* const username = Prompt.text({
Expand Down
1 change: 1 addition & 0 deletions packages/cluster-browser/docgen.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/cluster-browser/src/",
"exclude": [
"src/internal/**/*.ts"
]
Expand Down
1 change: 1 addition & 0 deletions packages/cluster-node/docgen.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/cluster-node/src/",
"exclude": [
"src/internal/**/*.ts"
]
Expand Down
1 change: 1 addition & 0 deletions packages/cluster-workflow/docgen.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/cluster-workflow/src/",
"exclude": [
"src/internal/**/*.ts"
]
Expand Down
1 change: 1 addition & 0 deletions packages/cluster/docgen.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/cluster/src/",
"exclude": [
"src/internal/**/*.ts"
]
Expand Down
1 change: 1 addition & 0 deletions packages/effect/docgen.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "../../node_modules/@effect/docgen/schema.json",
"exclude": ["src/internal/**/*.ts"],
"srcLink": "https://github.com/Effect-TS/effect/tree/main/packages/effect/src/",
"examplesCompilerOptions": {
"noEmit": true,
"strict": true,
Expand Down
Loading