Global

On this page

Methods

buildPluginConfig(argsopt, cwdopt) → {Context}

Create execution context from command line args

Parameters:

Name	Type	Attributes	Description
`args`	Array.<string>	<optional>
`cwd`	string	<optional>

Source: core/context.js, line 56

Returns:

Type:: Context

parseCiMode(args, config) → {ParsedFlags}

Parse command line arguments into structured flags

Parameters:

Name	Type	Description
`args`	Array.<string>
`config`	Object

Source: core/args.js, line 35

Returns:

Type:: ParsedFlags

Type Definitions

Context

Type:

Object

Properties

Name	Type	Description
`args`	Array.<string>
`config`	Object
`cwd`	string
`exitCodes`	Object
`verbose`	boolean
`jsonOutput`	boolean
`strict`	boolean
`dryRun`	boolean
`ciMode`	boolean
`useDeepL`	boolean
`srcDir`	string
`i18nDir`	string
`reportDir`	string
`backupDir`	string
`lang`	string \| null
`format`	string
`outputFile`	string
`keyMappingFile`	string
`excludedFolders`	Array.<string>
`merge`	boolean
`skipTranslated`	boolean
`extractTsObjects`	boolean
`autoApply`	boolean
`initLangs`	Array.<string>
`backup`	boolean
`interactive`	boolean
`translatePair`	string \| null
`translateEmail`	string \| null
`parsers`	Array
`adapter`	Object
`provider`	Object
`log`	function

Source: core/context.js, line 8

ParsedFlags

Type:

Object

Properties

Name	Type	Description
`verbose`	boolean
`jsonOutput`	boolean
`strict`	boolean
`dryRun`	boolean
`ciMode`	boolean
`useDeepL`	boolean
`merge`	boolean
`skipTranslated`	boolean
`extractTsObjects`	boolean
`autoApply`	boolean
`backup`	boolean
`interactive`	boolean
`lang`	string \| null
`format`	string
`translatePair`	string \| null
`translateEmail`	string \| null
`initLangs`	Array.<string>

Source: core/args.js, line 3