Class CommandFeatureSelector

Represents a selector for enabling or disabling command features.

Hierarchy

CommandFeatureSelector

Index

Constructors

Properties

cmd isAppDataEnabled isAutoAssignMissingOptionFlagsEnabled isAutoAssignSubCommandAliasesEnabled isConfigEnabled isPresetsEnabled

Methods

appData autoAssignMissingOptionFlags autoAssignSubCommandAliases config inheritFrom presets setProperty

Constructors

constructor

new CommandFeatureSelector(cmd): CommandFeatureSelector
Creates a new instance of the CommandFeatureSelector class.
Parameters
- cmd: CommandBuilder<unknown[], OptionValues>
  
  The command builder instance.
Returns CommandFeatureSelector
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:36

Properties

`Protected` `Readonly` cmd

cmd: CommandBuilder<unknown[], OptionValues>

The command builder instance.

isAppDataEnabled

isAppDataEnabled: boolean = false

Indicates whether the app data feature is enabled.

isAutoAssignMissingOptionFlagsEnabled

isAutoAssignMissingOptionFlagsEnabled: boolean = false

Indicates whether the auto assign missing option flags feature is enabled.

isAutoAssignSubCommandAliasesEnabled

isAutoAssignSubCommandAliasesEnabled: boolean = false

Indicates whether the auto assign sub command aliases feature is enabled.

isConfigEnabled

isConfigEnabled: boolean = false

Indicates whether the config feature is enabled.

isPresetsEnabled

isPresetsEnabled: boolean = false

Indicates whether the presets feature is enabled.

Methods

appData

appData(boolean?): CommandFeatureSelector
Enables or disables the app data feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the app data feature should be enabled or disabled.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.

Throws
Error if the command is native and the app data feature is being configured.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:56

autoAssignMissingOptionFlags

autoAssignMissingOptionFlags(boolean?): CommandFeatureSelector
Enables or disables the auto assign missing option flags feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the auto assign missing option flags feature should be enabled or disabled.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:85

autoAssignSubCommandAliases

autoAssignSubCommandAliases(boolean?): CommandFeatureSelector
Enables or disables the auto assign sub command aliases feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the auto assign sub command aliases feature should be enabled or disabled.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:94

config

config(boolean?): CommandFeatureSelector
Enables or disables the config feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the config feature should be enabled or disabled.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.

Throws
Error if the command is native and the config feature is being configured.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:66

inheritFrom

inheritFrom(parentFeatures): void
Inherits the feature settings from a parent CommandFeatureSelector instance.
Parameters
- parentFeatures: CommandFeatureSelector
  
  The parent CommandFeatureSelector instance to inherit from.
Returns void
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:42

presets

presets(boolean?): CommandFeatureSelector
Enables or disables the presets feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the presets feature should be enabled or disabled.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.

Throws
Error if the command is native and the presets feature is being configured.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:76

`Protected` setProperty

setProperty(boolean?, prop, method, throwIfNative): CommandFeatureSelector
Helper method to enable or disable a feature.
Parameters
- boolean: boolean = true
  
  Indicates whether the auto assign sub command aliases feature should be enabled or disabled.
- prop: keyof CommandFeatureSelector
  
  The property name to set.
- method: string
  
  The method name to output in the debug message.
- throwIfNative: boolean
  
  Indicates whether an error should be thrown if the command is native.
Returns CommandFeatureSelector
The current CommandFeatureSelector instance.
- Defined in packages/cli/src/cmd/CommandFeatureSelector.ts:106

Class CommandFeatureSelector

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

cmd: CommandBuilder<unknown[], OptionValues>

Returns CommandFeatureSelector

Properties

Protected Readonly cmd

isAppDataEnabled

isAutoAssignMissingOptionFlagsEnabled

isAutoAssignSubCommandAliasesEnabled

isConfigEnabled

isPresetsEnabled

Methods

appData

Parameters

boolean: boolean = true

Returns CommandFeatureSelector

Throws

autoAssignMissingOptionFlags

Parameters

boolean: boolean = true

Returns CommandFeatureSelector

autoAssignSubCommandAliases

Parameters

boolean: boolean = true

Returns CommandFeatureSelector

config

Parameters

boolean: boolean = true

Returns CommandFeatureSelector

Throws

inheritFrom

Parameters

parentFeatures: CommandFeatureSelector

Returns void

presets

Parameters

boolean: boolean = true

Returns CommandFeatureSelector

Throws

Protected setProperty

Parameters

boolean: boolean = true

prop: keyof CommandFeatureSelector

method: string

throwIfNative: boolean

Returns CommandFeatureSelector

Settings

Member Visibility

Theme

On This Page

`Protected` `Readonly` cmd

`Protected` setProperty