Migrate from v5 to v6

[qetza]

Most inputs where renamed, migrated or have their values changed, outputs were renamed and some transforms were renamed between v5 and v6.

When migrating from v5 to v6 use the following tables to migrate needed inputs, outputs and transforms:

inputs

v5	v6	Comments
actionOnNoFiles: continue	ifNoFilesFound: ignore
actionOnNoFiles: fail	ifNoFilesFound: error
actionOnNoFiles: *	ifNoFilesFound: *	rename only for other values
defaultValue: *	missingVarDefault: *	rename only
emptyValue		remove input
enableRecursion: *	recursive: *	rename only
enableTelemetry: false	telemetryOptout: true
enableTelemetry: true	telemetryOptout: false
enableTransforms: *	transforms: *	rename only
encoding: win1252	encoding: windows1252
escapeType: none	escape: off
escapeType: *	escape: *	rename only for other values
inlineVariables: *	additionalVariables: *	set values as an object
keepToken: false actionOnMissing: continue useDefaultValue: false	missingVarAction: none missingVarLog: off	silently replace missing tokens with an empty string
keepToken: false actionOnMissing: continue useDefaultValue: true	missingVarAction: replace	silently replace missing tokens with default value
keepToken: false actionOnMissing: warn useDefaultValue: false	missingVarAction: none missingVarLog: warn	replace missing tokens with an empty string and log a warning message
keepToken: false actionOnMissing: warn useDefaultValue: true	missingVarAction: replace missingVarLog: warn	replace missing tokens with default value and log a warning message
keepToken: false actionOnMissing: fail useDefaultValue: false	missingVarAction: none missingVarLog: error	replace missing tokens with an empty string and log an error message which will make the task fail
keepToken: false actionOnMissing: fail useDefaultValue: true	missingVarAction: replace missingVarLog: error	replace missing tokens with default value and log an error message which will make the task fail
keepToken: true actionOnMissing: continue	missingVarAction: keep missingVarLog: off	keep missing tokens
keepToken: true actionOnMissing: warn	missingVarAction: keep missingVarLog: warn	keep missing tokens and log a warning message
keepToken: true actionOnMissing: fail	missingVarAction: keep missingVarLog: error	keep missing tokens and log an error message which will make the task fail
rootDirectory: *	root: *	rename only
targetFiles: *	sources: *	comma-separated values are not supported anymore, if you have multiple entries use newline to separate them only slashes are supported as directory separator
tokenPattern: rm	tokenPattern: doubleunderscores
transformPrefix: *	transformsPrefix: *	rename only
transformSuffix: *	transformsSuffix: *	rename only
useLegacyEmptyFeature: true		not supported
useLegacyEmptyFeature: false		remove input
useLegacyPattern: true		not supported
useLegacyPattern: false		remove input
variableFiles: *	additionalVariables: *	set paths as an array of strings starting with @ and use only slashes as directory separator
variableSeparator: *	separator: *	rename only
verbosity: detailed	logLevel: debug
verbosity: normal	logLevel: info
verbosity: off	logLevel: error
writeBOM: *	addBOM: *	rename and changed default value to false; if you didn't specify writeBOM, add addBOM: true

outputs

v5	v6
defaultValueCount	defaults
fileProcessedCount	files
tokenFoundCount	tokens
tokenReplacedCount	replaced
transformExecutedCount	transforms

transforms

v5	v6
noescape(*)	raw(*)

[MattacksWTW]

To be proper English 'ifNoFilesFound' would have been better phrased 'whenNoFilesFound'
Etc.

[matthewc-dccu]

I believe ifNoFilesFound is correct English in this context.

• If is used to discuss conditional or uncertain events, indicating the possibility that an event may or may not happen.
• When is used when you're certain that an event will happen, and it pertains to timing rather than conditionality.

[parshOne]

Could you please tell me how long then v5 will be around and supported for?

[qetza]

Hi @parshOne,
I don't intend to remove any version so all versions will still be available in the extension.

As for support i don't think the v5 version will be deprecated soon, i'll still update it to support new node version but for new features it will depend it will depend on the time needed to implement them as for new features i will privilege version 6 as it's using a common library which allows the extension to be available as a CLI and a GitHub Action.

In any case as the code is open-source anyone can fork it and update it as needed 😄