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

makes @defaultValue usages consistent (and correct) #9012

Merged
merged 2 commits into from
Aug 14, 2024
Merged

makes @defaultValue usages consistent (and correct) #9012

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32f30d2
@defaultValue uses inline code
dimitropoulos Aug 14, 2024
1ff9ae7
adds missing `@defaultValue`s
dimitropoulos Aug 14, 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
40 changes: 22 additions & 18 deletions packages/turbo-types/src/types/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export type LegacySchema = LegacyRootSchema | LegacyWorkspaceSchema;
export type SchemaV1 = RootSchemaV1 | WorkspaceSchemaV1;

export interface BaseSchema {
/** @defaultValue https://turbo.build/schema.json */
/** @defaultValue `https://turbo.build/schema.json` */
$schema?: string;
/**
* An object representing the task dependency graph of your project. turbo interprets
Expand Down Expand Up @@ -49,7 +49,7 @@ export interface WorkspaceSchema extends BaseSchema {
*
* Currently, only the "//" value is allowed.
*
* @defaultValue ["//"]
* @defaultValue `["//"]`
*/
extends: Array<string>;
}
Expand Down Expand Up @@ -79,7 +79,7 @@ export interface RootSchema extends BaseSchema {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globaldependencies
*
* @defaultValue []
* @defaultValue `[]`
*/
globalDependencies?: Array<string>;

Expand All @@ -90,7 +90,7 @@ export interface RootSchema extends BaseSchema {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalenv
*
* @defaultValue []
* @defaultValue `[]`
*/
globalEnv?: Array<EnvWildcard>;

Expand All @@ -100,7 +100,7 @@ export interface RootSchema extends BaseSchema {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalpassthroughenv
*
* @defaultValue null
* @defaultValue `null`
*/
globalPassThroughEnv?: null | Array<EnvWildcard>;

Expand All @@ -110,7 +110,7 @@ export interface RootSchema extends BaseSchema {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#globalDotEnv
*
* @defaultValue null
* @defaultValue `null`
*/
globalDotEnv?: null | Array<AnchoredUnixPath>;

Expand Down Expand Up @@ -139,6 +139,8 @@ export interface RootSchema extends BaseSchema {
* configuration to infer the correct package manager.
*
* Some turbo features are disabled if this is set to true.
*
* @defaultValue `false`
*/
dangerouslyDisablePackageManagerCheck?: boolean;
}
Expand All @@ -162,7 +164,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#dependson
*
* @defaultValue []
* @defaultValue `[]`
*/
dependsOn?: Array<string>;

Expand All @@ -176,7 +178,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#env
*
* @defaultValue []
* @defaultValue `[]`
*/
env?: Array<EnvWildcard>;

Expand All @@ -187,7 +189,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#passthroughenv
*
* @defaultValue null
* @defaultValue `null`
*/
passThroughEnv?: null | Array<EnvWildcard>;

Expand All @@ -197,7 +199,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#dotEnv
*
* @defaultValue null
* @defaultValue `null`
*/
dotEnv?: null | Array<AnchoredUnixPath>;

Expand All @@ -210,7 +212,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#outputs
*
* @defaultValue []
* @defaultValue `[]`
*/
outputs?: Array<string>;

Expand All @@ -221,7 +223,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#cache
*
* @defaultValue true
* @defaultValue `true`
*/
cache?: boolean;

Expand All @@ -238,7 +240,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#inputs
*
* @defaultValue []
* @defaultValue `[]`
*/
inputs?: Array<string>;

Expand All @@ -257,7 +259,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/run#--output-logs-option
*
* @defaultValue full
* @defaultValue `"full"`
*/
outputLogs?: OutputMode;

Expand All @@ -268,7 +270,7 @@ export interface Pipeline {
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#persistent
*
* @defaultValue false
* @defaultValue `false`
*/
persistent?: boolean;

Expand All @@ -278,6 +280,8 @@ export interface Pipeline {
* they receive from stdin can change the outcome of the task.
*
* Documentation: https://turbo.build/repo/docs/reference/configuration#interactive
*
* @defaultValue `false`
*/
interactive?: boolean;
}
Expand All @@ -289,7 +293,7 @@ export interface RemoteCache {
* variable `TURBO_REMOTE_CACHE_SIGNATURE_KEY`. Turborepo will reject any downloaded artifacts
* that have an invalid signature or are missing a signature.
*
* @defaultValue false
* @defaultValue `false`
*/
signature?: boolean;

Expand All @@ -299,7 +303,7 @@ export interface RemoteCache {
* is enabled, but still requires the user to login and link their repo to a remote cache.
* Documentation: https://turbo.build/repo/docs/core-concepts/remote-caching
*
* @defaultValue true
* @defaultValue `true`
*/
enabled?: boolean;
}
Expand All @@ -310,7 +314,7 @@ export type OutputMode =
| "new-only"
| "errors-only"
| "none";

export type EnvMode = "strict" | "loose";
export type UI = "tui" | "stream";

export type AnchoredUnixPath = string;
Expand Down
Loading