Properties
all
all: boolean = Option.Boolean(`-A,--all`, false, {description: `Apply the operation to all workspaces from the current project`,})
cwd
cwd: undefined | string = Option.String(`--cwd`, {hidden: true})
mode
mode
: undefined | UpdateLockfile | SkipBuild = Option.String(`--mode`, {description: `Change what artifacts installs generate`,validator: t.isEnum(InstallMode),})patterns
patterns: string[] = Option.Rest()
Static paths
paths: string[][] = [[`remove`],]
Static usage
usage
: Usage = Command.Usage({description: `remove dependencies from the project`,details: `This command will remove the packages matching the specified patterns from the current workspace.If the \`--mode=<mode>\` option is set, Yarn will change which artifacts are generated. The modes currently supported are:- \`skip-build\` will not run the build scripts at all. Note that this is different from setting \`enableScripts\` to false because the latter will disable build scripts, and thus affect the content of the artifacts generated on disk, whereas the former will just disable the build step - but not the scripts themselves, which just won't run.- \`update-lockfile\` will skip the link step altogether, and only fetch packages that are missing from the lockfile (or that have no associated checksums). This mode is typically used by tools like Renovate or Dependabot to keep a lockfile up-to-date without incurring the full install cost.This command accepts glob patterns as arguments (if valid Idents and supported by [micromatch](https://github.com/micromatch/micromatch)). Make sure to escape the patterns, to prevent your own shell from trying to expand them.`,examples: [[`Remove a dependency from the current project`,`$0 remove lodash`,], [`Remove a dependency from all workspaces at once`,`$0 remove lodash --all`,], [`Remove all dependencies starting with \`eslint-\``,`$0 remove 'eslint-*'`,], [`Remove all dependencies with the \`@babel\` scope`,`$0 remove '@babel/*'`,], [`Remove all dependencies matching \`react-dom\` or \`react-helmet\``,`$0 remove 'react-{dom,helmet}'`,]],})