Class default

Serializes MsgResource objects to XLIFF 2.2 files in l10n/xliff on a per-project basis.

Hierarchy

Command
- default

Index

Constructors

constructor

new default(argv: string[], config: Config): default
Parameters
- argv: string[]
- config: Config
Returns default
Inherited from Command.constructor
- Defined in node_modules/@oclif/core/lib/command.d.ts:76

Properties

argv

argv: string[]

config

config: Config

`Protected`debug

debug: (...args: any[]) => void

id

id: string | undefined

`Static`aliases

aliases: string[]

An array of aliases for this command.

`Static`args

args: ArgInput

An order-dependent object of arguments for the command

`Static`baseFlags

baseFlags: FlagInput

`Static` `Optional`deprecateAliases

deprecateAliases?: boolean

Emit deprecation warning when a command alias is used

`Static` `Optional`deprecationOptions

deprecationOptions?: Deprecation

`Static`description

description: string = "Serialize msg resources in i18n/resources to XLIFF 2.2 files in l10n/xliff (per project)"

A full description of how to use the command.

If no summary, the first line of the description will be used as the summary.

`Static`enableJsonFlag

enableJsonFlag: boolean

`Static`examples

examples: Example[]

An array of examples to show at the end of the command's help.

IF only a string is provided, it will try to look for a line that starts with the cmd.bin as the example command and the rest as the description. If found, the command will be formatted appropriately.

EXAMPLES:
  A description of a particular use case.

    $ <%= config.bin => command flags

`Static`flags

flags: {
help: BooleanFlag<void>;
project: OptionFlag<string | undefined, CustomOptions>;
} = ...

A hash of flags for the command

`Static`hasDynamicHelp

hasDynamicHelp: boolean

`Static`help

help: string | undefined

`Static`hidden

hidden: boolean

Hide the command from help

`Static`hiddenAliases

hiddenAliases: string[]

An array of aliases for this command that are hidden from help.

`Static`id

id: string

A command ID, used mostly in error or verbose reporting.

`Static`plugin

plugin: Plugin | undefined

`Static` `Optional` `Readonly`pluginAlias

pluginAlias?: string

`Static` `Optional` `Readonly`pluginName

pluginName?: string

`Static` `Optional` `Readonly`pluginType

pluginType?: string

`Static` `Optional`state

state?: string

Mark the command as a given state (e.g. beta or deprecated) in help

`Static`strict

strict: boolean

When set to false, allows a variable amount of arguments

`Static` `Optional`summary

summary?: string

The tweet-sized description for your class, used in a parent-commands sub-command listing and as the header for the command help.

`Static`usage

usage: string | string[] | undefined

An override string (or strings) for the default usage documentation.

Accessors

`Protected`ctor

get ctor(): typeof Command
Returns typeof Command
Inherited from Command.ctor
- Defined in node_modules/@oclif/core/lib/command.d.ts:90

Methods

`Protected`_run

_run<T>(): Promise<T>
Type Parameters
- T
Returns Promise<T>
Inherited from Command._run
- Defined in node_modules/@oclif/core/lib/command.d.ts:118

`Protected`catch

catch(err: CommandError): Promise<any>
Parameters
- err: CommandError
Returns Promise<any>
Inherited from Command.catch
- Defined in node_modules/@oclif/core/lib/command.d.ts:91

error

error(
input: string | Error,
options: { code?: string; exit: false } & PrettyPrintableError,
): void
Parameters
- input: string | Error
- options: { code?: string; exit: false } & PrettyPrintableError
Returns void
Inherited from Command.error
- Defined in node_modules/@oclif/core/lib/command.d.ts:92
error(
input: string | Error,
options?: { code?: string; exit?: number } & PrettyPrintableError,
): never
Parameters
- input: string | Error
- Optionaloptions: { code?: string; exit?: number } & PrettyPrintableError
Returns never
Inherited from Command.error
- Defined in node_modules/@oclif/core/lib/command.d.ts:96

exit

exit(code?: number): never
Parameters
- Optionalcode: number
Returns never
Inherited from Command.exit
- Defined in node_modules/@oclif/core/lib/command.d.ts:100

`Protected`finally

finally(_: Error | undefined): Promise<any>
Parameters
- _: Error | undefined
Returns Promise<any>
Inherited from Command.finally
- Defined in node_modules/@oclif/core/lib/command.d.ts:101

`Protected`init

init(): Promise<any>
Returns Promise<any>
Inherited from Command.init
- Defined in node_modules/@oclif/core/lib/command.d.ts:102

jsonEnabled

jsonEnabled(): boolean
Determine if the command is being run with the --json flag in a command that supports it.

Returns boolean
true if the command supports json and the --json flag is present
Inherited from Command.jsonEnabled
- Defined in node_modules/@oclif/core/lib/command.d.ts:108

log

log(message?: string, ...args: any[]): void
Parameters
- Optionalmessage: string
- ...args: any[]
Returns void
Inherited from Command.log
- Defined in node_modules/@oclif/core/lib/command.d.ts:109

`Protected`logJson

logJson(json: unknown): void
Parameters
- json: unknown
Returns void
Inherited from Command.logJson
- Defined in node_modules/@oclif/core/lib/command.d.ts:110

logToStderr

logToStderr(message?: string, ...args: any[]): void
Parameters
- Optionalmessage: string
- ...args: any[]
Returns void
Inherited from Command.logToStderr
- Defined in node_modules/@oclif/core/lib/command.d.ts:111

`Protected`parse

parse<F extends FlagOutput, B extends FlagOutput, A extends ArgOutput>(
options?: Input<F, B, A>,
argv?: string[],
): Promise<ParserOutput<F, B, A>>
Type Parameters
- F extends FlagOutput
- B extends FlagOutput
- A extends ArgOutput
Parameters
- Optionaloptions: Input<F, B, A>
- Optionalargv: string[]
Returns Promise<ParserOutput<F, B, A>>
Inherited from Command.parse
- Defined in node_modules/@oclif/core/lib/command.d.ts:112

run

run(): Promise<void>
actual command run code goes here

Returns Promise<void>
Overrides Command.run
- Defined in src/commands/export.ts:29

`Protected`toErrorJson

toErrorJson(err: unknown): any
Parameters
- err: unknown
Returns any
Inherited from Command.toErrorJson
- Defined in node_modules/@oclif/core/lib/command.d.ts:113

`Protected`toSuccessJson

toSuccessJson(result: unknown): any
Parameters
- result: unknown
Returns any
Inherited from Command.toSuccessJson
- Defined in node_modules/@oclif/core/lib/command.d.ts:114

warn

warn(input: string | Error): string | Error
Parameters
- input: string | Error
Returns string | Error
Inherited from Command.warn
- Defined in node_modules/@oclif/core/lib/command.d.ts:115

`Protected`warnIfCommandDeprecated

warnIfCommandDeprecated(): void
Returns void
Inherited from Command.warnIfCommandDeprecated
- Defined in node_modules/@oclif/core/lib/command.d.ts:116

`Protected`warnIfFlagDeprecated

warnIfFlagDeprecated(flags: Record<string, unknown>): void
Parameters
- flags: Record<string, unknown>
Returns void
Inherited from Command.warnIfFlagDeprecated
- Defined in node_modules/@oclif/core/lib/command.d.ts:117

`Static`run

run<T extends Command>(
    this: new (argv: string[], config: Config) => T,
    argv?: string[],
    opts?: LoadOptions,
): Promise<ReturnType<T["run"]>>
instantiate and run the command
Type Parameters
- T extends Command
Parameters
- this: new (argv: string[], config: Config) => T
  the command class
- Optionalargv: string[]
  argv
- Optionalopts: LoadOptions
  options
Returns Promise<ReturnType<T["run"]>>
result
Inherited from Command.run
- Defined in node_modules/@oclif/core/lib/command.d.ts:89

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

argv

config

Protecteddebug

id

Staticaliases

Staticargs

StaticbaseFlags

Static OptionaldeprecateAliases

Static OptionaldeprecationOptions

Staticdescription

StaticenableJsonFlag

Staticexamples

Staticflags

StatichasDynamicHelp

Statichelp

Statichidden

StatichiddenAliases

Staticid

Staticplugin

Static Optional ReadonlypluginAlias

Static Optional ReadonlypluginName

Static Optional ReadonlypluginType

Static Optionalstate

Staticstrict

Static Optionalsummary

Staticusage

Accessors

Protectedctor

Returns typeof Command

Methods

Protected_run

Type Parameters

Returns Promise<T>

Protectedcatch

Parameters

Returns Promise<any>

error

Parameters

Returns void

Parameters

Returns never

exit

Parameters

Returns never

Protectedfinally

Parameters

Returns Promise<any>

Protectedinit

Returns Promise<any>

jsonEnabled

Returns boolean

log

Parameters

Returns void

ProtectedlogJson

Parameters

Returns void

logToStderr

Parameters

Returns void

Protectedparse

Type Parameters

Parameters

Returns Promise<ParserOutput<F, B, A>>

run

Returns Promise<void>

ProtectedtoErrorJson

Parameters

`Protected`debug

`Static`aliases

`Static`args

`Static`baseFlags

`Static` `Optional`deprecateAliases

`Static` `Optional`deprecationOptions

`Static`description

`Static`enableJsonFlag

`Static`examples

`Static`flags

`Static`hasDynamicHelp

`Static`help

`Static`hidden

`Static`hiddenAliases

`Static`id

`Static`plugin

`Static` `Optional` `Readonly`pluginAlias

`Static` `Optional` `Readonly`pluginName

`Static` `Optional` `Readonly`pluginType

`Static` `Optional`state

`Static`strict

`Static` `Optional`summary

`Static`usage

`Protected`ctor

`Protected`_run

`Protected`catch

`Protected`finally

`Protected`init

`Protected`logJson

`Protected`parse

`Protected`toErrorJson

`Protected`toSuccessJson

`Protected`warnIfCommandDeprecated

`Protected`warnIfFlagDeprecated

`Static`run