Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConstraintsCheckCommand

Hierarchy

Properties

Methods

Properties

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

fix

fix: boolean = Option.Boolean(`--fix`, false, {description: `Attempt to automatically fix unambiguous issues, following a multi-pass process`,})

Static paths

paths: string[][] = [[`constraints`],]

Static usage

usage: Usage = Command.Usage({category: `Constraints-related commands`,description: `check that the project constraints are met`,details: `This command will run constraints on your project and emit errors for each one that is found but isn't met. If any error is emitted the process will exit with a non-zero exit code.If the \`--fix\` flag is used, Yarn will attempt to automatically fix the issues the best it can, following a multi-pass process (with a maximum of 10 iterations). Some ambiguous patterns cannot be autofixed, in which case you'll have to manually specify the right resolution.For more information as to how to write constraints, please consult our dedicated page on our website: https://yarnpkg.com/features/constraints.`,examples: [[`Check that all constraints are satisfied`,`yarn constraints`,], [`Autofix all unmet constraints`,`yarn constraints --fix`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc