Repository navigation
feat(cli): derive flag documentation from flag definitions #7700
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
Open
mdonnalley
wants to merge
5
commits into
develop
Choose a base branch
from
feat/cli-2685-flag-docs
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+582
−161
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
7a19e96
feat(cli): derive flag documentation from flag definitions
mdonnalley 55f286e
fix(cli): render flag defaults from their declarations
mdonnalley 9fee351
chore(cli): keep literal default helper internal
mdonnalley 24dd120
Merge branch 'develop' into feat/cli-2685-flag-docs
mdonnalley 6968900
Merge branch 'develop' into feat/cli-2685-flag-docs
mdonnalley File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| import { Context, Option } from "effect"; | ||
| import type { Param } from "effect/cli"; | ||
| import type { UnwrappedParam } from "./param-introspection.ts"; | ||
|
|
||
| export interface FlagDocumentationShape { | ||
| readonly defaultValue?: string; | ||
| readonly choices?: ReadonlyArray<string>; | ||
| readonly required?: boolean; | ||
| /** Website compatibility labels need not describe an actual runtime default. */ | ||
| readonly helpDefault?: string | false; | ||
| } | ||
|
|
||
| export class FlagDocumentation extends Context.Service<FlagDocumentation, FlagDocumentationShape>()( | ||
| "supabase/FlagDocumentation", | ||
| ) {} | ||
|
|
||
| export function flagDocumentation( | ||
| single: Param.Single<Param.ParamKind, unknown>, | ||
| ): FlagDocumentationShape { | ||
| return Context.getOption(single.annotations, FlagDocumentation).pipe( | ||
| Option.getOrElse(() => ({})), | ||
| ); | ||
| } | ||
|
|
||
| /** Only literal scalar and array defaults can be displayed without evaluating user code. */ | ||
| function literalDefault(value: unknown): string | undefined { | ||
| if (typeof value === "string") return value; | ||
| if (typeof value === "boolean" || (typeof value === "number" && Number.isFinite(value))) { | ||
| return String(value); | ||
| } | ||
| if (Array.isArray(value)) { | ||
| const values: unknown[] = value; | ||
| if ( | ||
| values.every( | ||
| (item) => | ||
| typeof item === "string" || | ||
| typeof item === "boolean" || | ||
| (typeof item === "number" && Number.isFinite(item)), | ||
| ) | ||
| ) { | ||
| return JSON.stringify(values); | ||
| } | ||
| } | ||
| return undefined; | ||
| } | ||
|
|
||
| export function flagDefault(unwrapped: UnwrappedParam): string | undefined { | ||
| return ( | ||
| flagDocumentation(unwrapped.single).defaultValue ?? | ||
| Option.flatMap(unwrapped.defaultValue, (value) => | ||
| Option.fromUndefinedOr(literalDefault(value)), | ||
| ).pipe(Option.getOrUndefined) | ||
| ); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.