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

fix(config): add descriptions to JSON schema properties #56

Merged
merged 2 commits into from
Jan 9, 2025
Merged

fix(config): add descriptions to JSON schema properties #56

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3bc570
fix(config): add descriptions to JSON schema properties
Keyrxng Nov 26, 2024
1a37aec
chore: config examples
Keyrxng Nov 27, 2024
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
18 changes: 9 additions & 9 deletions src/types/plugin-input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,33 @@ export const pluginSettingsSchema = T.Object(
{
globalConfigUpdate: T.Optional(
T.Object({
excludeRepos: T.Array(T.String()),
})
excludeRepos: T.Array(T.String(), { examples: ["repo-name", "no-owner-required"], description: "List of repositories to exclude from being updated" }),
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is properly formatted is it?

}, { description: "Updates all price labels across all tasks based on `baseRateMultiplier` changes within the config file." }),
),
labels: T.Object(
{
time: T.Array(
T.Object({
name: T.String({ description: "The display name of the label" }),
collaboratorOnly: T.Boolean({ default: false, description: "Whether the label is only available to collaborators" }),
name: T.String({ examples: ["Time: <2 Hours", "Time: <1 Week"], description: "The display name of the label representing estimated task length" }),
collaboratorOnly: T.Boolean({ default: false, description: "Whether the task is only available for collaborators to be assigned" }),
}),
{ default: [] }
),
priority: T.Array(
T.Object({
name: T.String(),
collaboratorOnly: T.Boolean({ default: false }),
name: T.String({ examples: ["Priority: 1 (Normal)", "Priority: 5 (Emergency)"], description: "The display name of the label representing task priority" }),
collaboratorOnly: T.Boolean({ default: false, description: "Whether the task is only available for collaborators to be assigned" }),
}),
{ default: [] }
),
},
{ default: {} }
),
basePriceMultiplier: T.Number({ default: 1 }),
basePriceMultiplier: T.Number({ examples: [1.5], default: 1, description: "The base price multiplier for all tasks" }),
publicAccessControl: T.Object(
{
setLabel: T.Boolean({ default: false }),
fundExternalClosedIssue: T.Boolean({ default: false }),
setLabel: T.Boolean({ default: false, description: "Whether to allow anyone to set labels, false to perform permission validation" }),
fundExternalClosedIssue: T.Boolean({ default: false, description: "Whether to allow funding external closed issues" }),
},
{ default: {} }
),
Expand Down