diff --git a/classes/EcEuropa-Toolkit-Mock.html b/classes/EcEuropa-Toolkit-Mock.html index 2fc96d843..2a430cdd3 100644 --- a/classes/EcEuropa-Toolkit-Mock.html +++ b/classes/EcEuropa-Toolkit-Mock.html @@ -296,7 +296,7 @@

private static string $defaultTag - = '0.0.11' + = '0.0.20' diff --git a/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html b/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html index 26f460712..9b6a21737 100644 --- a/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html +++ b/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html @@ -347,26 +347,7 @@

protected array<string|int, mixed> $availableTasks - = [ - 'mkdir' => ['required' => 'dir', 'defaults' => 'mode'], - 'touch' => ['required' => 'file', 'defaults' => ['time', 'atime']], - 'copy' => ['required' => ['from', 'to'], 'defaults' => 'force'], - 'copy-dir' => ['required' => ['from', 'to']], - 'rename' => ['required' => ['from', 'to'], 'defaults' => 'force'], - 'chmod' => ['required' => ['file', 'permissions'], 'defaults' => ['umask', 'recursive']], - 'chgrp' => ['required' => ['file', 'group'], 'defaults' => 'recursive'], - 'chown' => ['required' => ['file', 'user'], 'defaults' => 'recursive'], - 'remove' => ['required' => 'file'], - 'symlink' => ['required' => ['from', 'to']], - 'mirror' => ['required' => ['from', 'to']], - 'process' => ['required' => ['source'], 'defaults' => 'destination'], - 'append' => ['required' => ['file', 'text']], - 'run' => ['required' => 'command'], - // 'process-php' => ['required' => ['source', 'destination'], 'defaults' => 'override'], - 'exec' => ['required' => 'command'], - 'drush' => ['required' => 'command'], - 'replace-block' => ['required' => ['filename', 'start', 'end'], 'defaults' => ['content', 'excludeStartEnd']], -] + = ['mkdir' => ['required' => 'dir', 'defaults' => 'mode'], 'touch' => ['required' => 'file', 'defaults' => ['time', 'atime']], 'copy' => ['required' => ['from', 'to'], 'defaults' => 'force'], 'copy-dir' => ['required' => ['from', 'to']], 'rename' => ['required' => ['from', 'to'], 'defaults' => 'force'], 'chmod' => ['required' => ['file', 'permissions'], 'defaults' => ['umask', 'recursive']], 'chgrp' => ['required' => ['file', 'group'], 'defaults' => 'recursive'], 'chown' => ['required' => ['file', 'user'], 'defaults' => 'recursive'], 'remove' => ['required' => 'file'], 'symlink' => ['required' => ['from', 'to']], 'mirror' => ['required' => ['from', 'to']], 'process' => ['required' => ['source'], 'defaults' => 'destination'], 'append' => ['required' => ['file', 'text']], 'run' => ['required' => 'command'], 'exec' => ['required' => 'command'], 'drush' => ['required' => 'command'], 'replace-block' => ['required' => ['filename', 'start', 'end'], 'defaults' => ['content', 'excludeStartEnd']]]

Each task defines all the needed parameters to execute, the required to ensure they are present, and the defaults @@ -438,7 +419,7 @@

@@ -485,7 +466,7 @@

@@ -528,7 +509,7 @@

@@ -563,7 +544,7 @@

@@ -652,7 +633,7 @@

@@ -707,7 +688,7 @@

@@ -754,7 +735,7 @@

@@ -816,7 +797,7 @@

@@ -887,7 +868,7 @@

diff --git a/classes/EcEuropa-Toolkit-Task-File-Process.html b/classes/EcEuropa-Toolkit-Task-File-Process.html index 119a3cb81..6b484a686 100644 --- a/classes/EcEuropa-Toolkit-Task-File-Process.html +++ b/classes/EcEuropa-Toolkit-Task-File-Process.html @@ -437,7 +437,7 @@

@@ -458,14 +458,18 @@

Parameters
: string
- +

The source file.

+
+
$destination : string = ''
- +

The destination file, if empty assumes the $source as destination.

+
+
@@ -489,7 +493,7 @@

@@ -532,7 +536,7 @@

@@ -575,7 +579,7 @@

@@ -610,7 +614,7 @@

diff --git a/classes/EcEuropa-Toolkit-Task-File-Tasks.html b/classes/EcEuropa-Toolkit-Task-File-Tasks.html index 63376e39f..b24283ee8 100644 --- a/classes/EcEuropa-Toolkit-Task-File-Tasks.html +++ b/classes/EcEuropa-Toolkit-Task-File-Tasks.html @@ -196,14 +196,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -236,7 +236,7 @@

@@ -244,7 +244,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -276,11 +276,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -304,7 +300,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -327,11 +323,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
diff --git a/classes/EcEuropa-Toolkit-TaskRunner-AbstractCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-AbstractCommands.html index e448319a8..4f1ef7daa 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-AbstractCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-AbstractCommands.html @@ -226,7 +226,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -303,14 +303,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -342,7 +342,7 @@

@@ -350,7 +350,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -363,11 +363,7 @@

-
-
Return values
- string -
- +
@@ -439,7 +435,7 @@

@@ -482,7 +478,7 @@

@@ -521,7 +517,7 @@

@@ -591,7 +587,7 @@

@@ -644,7 +640,7 @@

@@ -696,7 +692,7 @@

@@ -766,7 +762,7 @@

@@ -819,7 +815,7 @@

@@ -909,7 +905,7 @@

@@ -917,7 +913,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -949,11 +945,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -977,7 +969,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -1000,11 +992,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
diff --git a/classes/EcEuropa-Toolkit-TaskRunner-AbstractGitHooks.html b/classes/EcEuropa-Toolkit-TaskRunner-AbstractGitHooks.html index ba07bdab9..5379b9c05 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-AbstractGitHooks.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-AbstractGitHooks.html @@ -213,7 +213,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -290,14 +290,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -329,7 +329,7 @@

@@ -337,7 +337,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -350,11 +350,7 @@

-
-
Return values
- string -
- +
@@ -426,7 +422,7 @@

@@ -469,7 +465,7 @@

@@ -508,7 +504,7 @@

@@ -578,7 +574,7 @@

@@ -631,7 +627,7 @@

@@ -683,7 +679,7 @@

@@ -753,7 +749,7 @@

@@ -806,7 +802,7 @@

@@ -896,7 +892,7 @@

@@ -904,7 +900,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -936,11 +932,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -964,7 +956,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -987,11 +979,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-AxeCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-AxeCommands.html index 76a13e499..08ebc686a 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-AxeCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-AxeCommands.html @@ -257,7 +257,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -355,14 +355,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -407,7 +407,28 @@

private array<string|int, mixed>|array<string|int, string> $dependencies - = ['libnss3-tools', 'libatk1.0-0', 'libatk-bridge2.0-0', 'libdrm2', 'libxcomposite1', 'libxdamage1', 'libxfixes3', 'libxrandr2', 'libgbm1', 'libxkbcommon-x11-0', 'libpangocairo-1.0-0', 'libasound2', 'fonts-liberation', 'libgcc1', 'libxss1', 'libgtk-3-0', 'libx11-xcb1', 'libxcursor1', 'xdg-utils'] + = [ + // cspell:disable . + 'libnss3-tools', + 'libatk1.0-0', + 'libatk-bridge2.0-0', + 'libdrm2', + 'libxcomposite1', + 'libxdamage1', + 'libxfixes3', + 'libxrandr2', + 'libgbm1', + 'libxkbcommon-x11-0', + 'libpangocairo-1.0-0', + 'libasound2', + 'fonts-liberation', + 'libgcc1', + 'libxss1', + 'libgtk-3-0', + 'libx11-xcb1', + 'libxcursor1', + 'xdg-utils', +] @@ -438,7 +459,7 @@

@@ -446,7 +467,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -459,11 +480,7 @@

-
-
Return values
- string -
- +
@@ -535,7 +552,7 @@

@@ -578,7 +595,7 @@

@@ -617,7 +634,7 @@

@@ -677,7 +694,7 @@

@@ -737,7 +754,7 @@

@@ -788,7 +805,7 @@

@@ -858,7 +875,7 @@

@@ -911,7 +928,7 @@

@@ -963,7 +980,7 @@

@@ -1033,7 +1050,7 @@

@@ -1086,7 +1103,7 @@

@@ -1176,7 +1193,7 @@

@@ -1184,7 +1201,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -1216,11 +1233,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -1244,7 +1257,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -1267,11 +1280,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-BlackfireCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-BlackfireCommands.html index a58d6cbfc..72f348e70 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-BlackfireCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-BlackfireCommands.html @@ -212,7 +212,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -303,14 +303,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -342,7 +342,7 @@

@@ -350,7 +350,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -363,11 +363,7 @@

-
-
Return values
- string -
- +
@@ -439,7 +435,7 @@

@@ -482,7 +478,7 @@

@@ -521,7 +517,7 @@

@@ -685,7 +681,7 @@

@@ -755,7 +751,7 @@

@@ -808,7 +804,7 @@

@@ -860,7 +856,7 @@

@@ -930,7 +926,7 @@

@@ -983,7 +979,7 @@

@@ -1073,7 +1069,7 @@

@@ -1081,7 +1077,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -1113,11 +1109,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -1141,7 +1133,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -1164,11 +1156,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html index 3e9cdfa4b..cfca1876d 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-BuildCommands.html @@ -261,7 +261,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -338,14 +338,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -955,7 +955,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -966,11 +966,7 @@

-
-
Return values
- string -
- +
@@ -1042,7 +1038,7 @@

@@ -1085,7 +1081,7 @@

@@ -1124,7 +1120,7 @@

@@ -1194,7 +1190,7 @@

@@ -1247,7 +1243,7 @@

@@ -1299,7 +1295,7 @@

@@ -1369,7 +1365,7 @@

@@ -1422,7 +1418,7 @@

@@ -1512,7 +1508,7 @@

@@ -1520,7 +1516,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -1552,11 +1548,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -1580,7 +1572,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -1603,11 +1595,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
-

Command class for toolkit:component-check

+

Command class for toolkit:component-check.

@@ -293,6 +293,12 @@

 : bool +
+ $insecureNpmFailed + +  : bool +
+
$io @@ -305,12 +311,24 @@

 : bool

+
+ $optsYml + +  : array<string|int, mixed> +
+
$outdatedFailed  : bool
+
+ $outdatedNpmFailed + +  : bool +
+
$packageReviews @@ -341,12 +359,24 @@

 : bool

+
+ $skipInsecureNpm + +  : bool +
+
$skipOutdated  : bool
+
+ $skipOutdatedNpm + +  : bool +
+
$skipRecommended @@ -429,6 +459,20 @@

Check mandatory components.
+
+ componentNpmInsecure() + +  : mixed +
+
Run NPM Insecure.
+ +
+ componentNpmOutdated() + +  : mixed +
+
Run NPM Outdated.
+
componentOutdated() @@ -453,7 +497,7 @@

getConfigurationFile() -  : string +  : mixed
Path to YAML configuration file containing command defaults.
@@ -544,14 +588,14 @@

taskProcess() -  : Process|CollectionBuilder +  : mixed
Process the file.
taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
Replace block in a file.
@@ -583,6 +627,13 @@

If given bool is TRUE 'failed' is return, otherwise 'passed'.
+
+ getOptsYml() + +  : array<string|int, mixed> +
+
Returns the .opts.yml content.
+
getProjectProfile() @@ -669,7 +720,7 @@

@@ -705,7 +756,7 @@

@@ -741,7 +792,7 @@

@@ -777,7 +828,7 @@

@@ -813,7 +864,7 @@

@@ -849,7 +900,7 @@

@@ -885,7 +936,7 @@

@@ -921,7 +972,7 @@

@@ -957,7 +1008,7 @@

@@ -993,7 +1044,7 @@

@@ -1011,6 +1062,42 @@

+

+
+

+ $insecureNpmFailed + + + + +

+ + + + + + protected + bool + $insecureNpmFailed + = false + + + + + + +
@@ -1065,7 +1152,7 @@

@@ -1083,6 +1170,42 @@

+

+
+

+ $optsYml + + + + +

+ + + + + + protected + array<string|int, mixed> + $optsYml + + + + + + + +
@@ -1119,6 +1242,42 @@

+

+
+

+ $outdatedNpmFailed + + + + +

+ + + + + + protected + bool + $outdatedNpmFailed + = false + + + + + + +
@@ -1173,7 +1332,7 @@

@@ -1209,7 +1368,7 @@

@@ -1245,7 +1404,7 @@

@@ -1281,7 +1440,7 @@

@@ -1299,6 +1458,42 @@

+

+
+

+ $skipInsecureNpm + + + + +

+ + + + + + protected + bool + $skipInsecureNpm + = true + + + + + + +
@@ -1335,6 +1530,42 @@

+

+
+

+ $skipOutdatedNpm + + + + +

+ + + + + + protected + bool + $skipOutdatedNpm + = true + + + + + + +
@@ -1389,7 +1620,7 @@

@@ -1425,7 +1656,7 @@

@@ -1466,7 +1697,7 @@

@@ -1527,7 +1758,7 @@

@@ -1640,7 +1871,7 @@

@@ -1728,7 +1959,7 @@

@@ -1789,7 +2020,7 @@

@@ -1850,7 +2081,7 @@

@@ -1920,7 +2151,7 @@

@@ -1999,7 +2230,7 @@

@@ -2054,6 +2285,117 @@

+
+
+

+ componentNpmInsecure() + + +

+ + +

Run NPM Insecure.

+ + + public + componentNpmInsecure() : mixed + +
+
+ + + + +
+ Tags + + +
+
+
+ command +
+
+ +

check:npm-insecure

+
+ +
+
+ + + + +
+
+

+ componentNpmOutdated() + + +

+ + +

Run NPM Outdated.

+ + + public + componentNpmOutdated() : mixed + +
+
+ + + + +
+ Tags + + +
+
+
+ command +
+
+ +

check:npm-outdated

+
+ +
+
+ SuppressWarnings +
+
+ +

(PHPMD.CyclomaticComplexity)

+
+ +
+
+ + + +
@@ -2139,7 +2481,7 @@

@@ -2200,7 +2542,7 @@

@@ -2261,7 +2603,7 @@

@@ -2269,7 +2611,7 @@

public - getConfigurationFile() : string + getConfigurationFile() : mixed
@@ -2282,11 +2624,7 @@

-
-
Return values
- string -
- +

@@ -2358,7 +2696,7 @@

@@ -2401,7 +2739,7 @@

@@ -2440,7 +2778,7 @@

@@ -2510,7 +2848,7 @@

@@ -2563,7 +2901,7 @@

@@ -2615,7 +2953,7 @@

@@ -2685,7 +3023,7 @@

@@ -2738,7 +3076,7 @@

@@ -2781,7 +3119,7 @@

@@ -2816,7 +3154,7 @@

@@ -2842,6 +3180,31 @@

Parameters
+
+ Tags + + +
+
+
+ SuppressWarnings +
+
+ +

(PHPMD.CyclomaticComplexity)

+
+ +
+
+ SuppressWarnings +
+
+ +

(PHPMD.NPathComplexity)

+
+ +
+
@@ -2908,7 +3271,7 @@

@@ -2916,7 +3279,7 @@

protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
@@ -2948,11 +3311,7 @@

Parameters
-
-
Return values
- Process|CollectionBuilder -
- +
@@ -2976,7 +3335,7 @@

protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
@@ -2999,11 +3358,7 @@

Parameters
-
-
Return values
- ReplaceBlock|CollectionBuilder -
- +
@@ -3091,7 +3446,7 @@

ComponentCheckCommands.php : - 685 + 811 @@ -3151,7 +3506,7 @@

@@ -3186,7 +3541,7 @@

@@ -3222,6 +3577,45 @@

Return values
string +
+
+

+ getOptsYml() + + +

+ + +

Returns the .opts.yml content.

+ + + private + getOptsYml() : array<string|int, mixed> + +
+
+ + + + + + + +
+
Return values
+ array<string|int, mixed> +
+
@@ -3288,7 +3682,7 @@

ComponentCheckCommands.php : - 970 + 1119 @@ -3327,7 +3721,7 @@

@@ -3368,7 +3762,7 @@

@@ -3407,7 +3801,7 @@

@@ -3446,7 +3840,7 @@

@@ -3485,7 +3879,7 @@

@@ -3520,7 +3914,7 @@

@@ -3672,15 +4066,20 @@

Return values
  • $evaluationFailed
  • $forcedUpdateModule
  • $insecureFailed
  • +
  • $insecureNpmFailed
  • $io
  • $mandatoryFailed
  • +
  • $optsYml
  • $outdatedFailed
  • +
  • $outdatedNpmFailed
  • $packageReviews
  • $recommendedFailed
  • $recommendedFailedCount
  • $skipAbandoned
  • $skipInsecure
  • +
  • $skipInsecureNpm
  • $skipOutdated
  • +
  • $skipOutdatedNpm
  • $skipRecommended
  • $skipUnsupported
  • $unsupportedFailed
  • @@ -3698,6 +4097,8 @@
    Return values
  • componentEvaluation()
  • componentInsecure()
  • componentMandatory()
  • +
  • componentNpmInsecure()
  • +
  • componentNpmOutdated()
  • componentOutdated()
  • componentRecommended()
  • componentUnsupported()
  • @@ -3720,6 +4121,7 @@
    Return values
  • validateEnvironmentVariables()
  • disableConfigReadOnly()
  • getFailedOrPassed()
  • +
  • getOptsYml()
  • getProjectProfile()
  • getRecommendedWarningMessage()
  • getReleases()
  • diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-ConfigurationCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-ConfigurationCommands.html index 2e31649b1..12a5ae8ed 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-ConfigurationCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-ConfigurationCommands.html @@ -226,7 +226,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -303,14 +303,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -456,7 +456,7 @@

    @@ -464,7 +464,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -477,11 +477,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -553,7 +549,7 @@

    @@ -596,7 +592,7 @@

    @@ -635,7 +631,7 @@

    @@ -705,7 +701,7 @@

    @@ -758,7 +754,7 @@

    @@ -810,7 +806,7 @@

    @@ -880,7 +876,7 @@

    @@ -933,7 +929,7 @@

    @@ -1023,7 +1019,7 @@

    @@ -1031,7 +1027,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1063,11 +1059,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1091,7 +1083,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1114,11 +1106,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html index 2e711d112..1cc69c81b 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html @@ -252,7 +252,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -329,14 +329,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -345,33 +345,33 @@

     : void -
    Backup current docker-compose.yml to docker-compose.yml.prev
    +
    Backup current docker-compose.yml to docker-compose.yml.prev.
    copyDockerComposeDefaultToProject()  : void
    -
    Copy ./resources/docker/default.yml file to docker-compose.yml inside project root directory
    +
    Copy ./resources/docker/default.yml file to docker-compose.yml inside project root directory.
    extractMajorMinorVersion()  : string
    -
    Converts from semantic version to "major.minor" version
    +
    Converts from semantic version to "major.minor" version.
    getFinalImages()  : array<string|int, mixed>
    -
    Get final images to update docker-compose.yml
    +
    Get final images to update docker-compose.yml.
    getProjectPhpFromWebsite() -  : array<string|int, mixed>|array<string|int, string> +  : array<string|int, mixed>
    Returns the Project's php service version information from the endpoint.
    @@ -380,35 +380,35 @@

     : array<string|int, mixed> -
    Return the details for a service from ./resources/docker
    +
    Return the details for a service from ./resources/docker.
    getServiceImage()  : string
    -
    Get service image with version
    +
    Get service image with version.
    getServicesImagesFromDockerCompose()  : array<string|int, mixed>
    -
    Get array of services with images and versions from docker-compose.yml
    +
    Get array of services with images and versions from docker-compose.yml.
    getServicesVersionsFromRequirements()  : array<string|int, mixed>
    -
    Get final services names with versions from requirements
    +
    Get final services names with versions from requirements.
    getWarningMessages()  : array<string|int, mixed>
    -
    Get warning messages for versions on .opts.yml that not respect the minimum requirements
    +
    Get warning messages for versions on .opts.yml that not respect the minimum requirements.
    getWebsiteRequirements() @@ -422,21 +422,21 @@

     : array<string|int, mixed>

    -
    Remove services that do not exist in project info, requirements or .opts.yml
    +
    Remove services that do not exist in project info, requirements or .opts.yml.
    updateDockerComposeFile()  : void
    -
    Update docker-compose.yml
    +
    Update docker-compose.yml.
    writeWarningMessages()  : void
    -
    Write all available warning messages
    +
    Write all available warning messages.
    @@ -597,7 +597,7 @@

    @@ -680,7 +680,7 @@

    @@ -688,7 +688,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -701,11 +701,7 @@

    -
    -
    Return values
    - string -
    - +
    @@ -777,7 +773,7 @@

    @@ -820,7 +816,7 @@

    @@ -859,7 +855,7 @@

    @@ -929,7 +925,7 @@

    @@ -982,7 +978,7 @@

    @@ -1034,7 +1030,7 @@

    @@ -1104,7 +1100,7 @@

    @@ -1157,7 +1153,7 @@

    @@ -1247,7 +1243,7 @@

    @@ -1255,7 +1251,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1287,11 +1283,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1315,7 +1307,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1338,11 +1330,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    -

    Backup current docker-compose.yml to docker-compose.yml.prev

    +

    Backup current docker-compose.yml to docker-compose.yml.prev.

    private @@ -1393,11 +1381,11 @@

    DockerCommands.php : - 96 + 92 -

    Copy ./resources/docker/default.yml file to docker-compose.yml inside project root directory

    +

    Copy ./resources/docker/default.yml file to docker-compose.yml inside project root directory.

    private @@ -1428,11 +1416,11 @@

    -

    Converts from semantic version to "major.minor" version

    +

    Converts from semantic version to "major.minor" version.

    private @@ -1449,7 +1437,9 @@
    Parameters
    : string
    - +

    The version to convert.

    +
    +
    @@ -1477,11 +1467,11 @@

    -

    Get final images to update docker-compose.yml

    +

    Get final images to update docker-compose.yml.

    private @@ -1498,21 +1488,27 @@
    Parameters
    : mixed
    - +

    The requirements

    +
    +
    $websiteRequirements : mixed
    - +

    The website requirements.

    +
    +
    $optsFileContent : mixed
    - +

    The .opts.yml content.

    +
    +
    @@ -1540,7 +1536,7 @@

    @@ -1548,7 +1544,7 @@

    private - getProjectPhpFromWebsite(string $projectId) : array<string|int, mixed>|array<string|int, string> + getProjectPhpFromWebsite(string $projectId) : array<string|int, mixed>
    @@ -1561,32 +1557,19 @@

    Parameters
    : string
    - +

    The project id.

    +
    +
    -

    - Tags - - -
    -
    -
    - throws -
    -
    - Exception - - -
    -
    Return values
    - array<string|int, mixed>|array<string|int, string> + array<string|int, mixed>

    @@ -1604,11 +1587,11 @@

    DockerCommands.php : - 231 + 217 -

    Return the details for a service from ./resources/docker

    +

    Return the details for a service from ./resources/docker.

    private @@ -1625,7 +1608,9 @@
    Parameters
    : string
    - +

    The service name.

    +
    +
    @@ -1653,11 +1638,11 @@

    -

    Get service image with version

    +

    Get service image with version.

    private @@ -1674,21 +1659,27 @@
    Parameters
    : string
    - +

    The service.

    +
    +
    $image : string
    - +

    The image.

    +
    +
    $version : string
    - +

    The version.

    +
    +
    @@ -1716,11 +1707,11 @@

    DockerCommands.php : - 112 + 107 -

    Get array of services with images and versions from docker-compose.yml

    +

    Get array of services with images and versions from docker-compose.yml.

    private @@ -1737,7 +1728,9 @@
    Parameters
    : array<string|int, mixed>
    - +

    The docker-compose content.

    +
    +
    @@ -1765,11 +1758,11 @@

    DockerCommands.php : - 245 + 230 -

    Get final services names with versions from requirements

    +

    Get final services names with versions from requirements.

    private @@ -1786,7 +1779,9 @@
    Parameters
    : array<string|int, mixed>
    - +

    The content to check.

    +
    +
    @@ -1814,11 +1809,11 @@

    -

    Get warning messages for versions on .opts.yml that not respect the minimum requirements

    +

    Get warning messages for versions on .opts.yml that not respect the minimum requirements.

    private @@ -1835,14 +1830,18 @@
    Parameters
    : mixed
    - +

    The .opts.yml content.

    +
    +
    $websiteRequirements : mixed
    - +

    The website requirements.

    +
    +
    @@ -1870,7 +1869,7 @@

    @@ -1886,21 +1885,6 @@

    -

    - Tags - - -
    -
    -
    - throws -
    -
    - Exception - - -
    -
    @@ -1924,11 +1908,11 @@

    -

    Remove services that do not exist in project info, requirements or .opts.yml

    +

    Remove services that do not exist in project info, requirements or .opts.yml.

    private @@ -1945,14 +1929,18 @@
    Parameters
    : array<string|int, mixed>
    - +

    The services.

    +
    +
    $finalServicesImages : array<string|int, mixed>
    - +

    The final services.

    +
    +
    @@ -1980,11 +1968,11 @@

    -

    Update docker-compose.yml

    +

    Update docker-compose.yml.

    private @@ -2001,14 +1989,18 @@
    Parameters
    : array<string|int, mixed>
    - +

    The docker-compose content.

    +
    +
    $finalServicesImages : array<string|int, mixed>
    - +

    The services images.

    +
    +
    @@ -2032,11 +2024,11 @@

    -

    Write all available warning messages

    +

    Write all available warning messages.

    private @@ -2053,7 +2045,9 @@
    Parameters
    : array<string|int, mixed>
    - +

    Messages to print.

    +
    +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DocumentationCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DocumentationCommands.html index 4de64729d..910f3f975 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DocumentationCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DocumentationCommands.html @@ -261,7 +261,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -352,14 +352,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -670,7 +670,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -681,11 +681,7 @@

    -
    -
    Return values
    - string -
    - +
    @@ -757,7 +753,7 @@

    @@ -800,7 +796,7 @@

    @@ -1054,7 +1050,7 @@

    @@ -1124,7 +1120,7 @@

    @@ -1177,7 +1173,7 @@

    @@ -1229,7 +1225,7 @@

    @@ -1299,7 +1295,7 @@

    @@ -1352,7 +1348,7 @@

    @@ -1442,7 +1438,7 @@

    @@ -1450,7 +1446,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1482,11 +1478,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1510,7 +1502,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1533,11 +1525,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    Parameters

    : string
    -

    The directory to clean

    +

    The directory to clean.

    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html index ca82c8b30..59e39d7e7 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalCommands.html @@ -240,21 +240,21 @@

    drupalDisableCache() -  : CollectionBuilder +  : mixed
    Disable aggregation and clear cache.
    drupalDrushSetup() -  : CollectionBuilder +  : mixed
    Write Drush configuration file at "${drupal.root}/drush/drush.yml".
    drupalPermissionsSetup() -  : CollectionBuilder +  : mixed
    Setup Drupal permissions.
    @@ -268,7 +268,7 @@

    drupalSiteInstall() -  : CollectionBuilder +  : mixed
    Install target site.
    @@ -282,14 +282,14 @@

    drupalSitePostInstall() -  : TaskInterface +  : mixed
    Run Drupal post-install commands.
    drupalSitePreInstall() -  : TaskInterface +  : mixed
    Run Drupal pre-install commands.
    @@ -303,7 +303,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -401,14 +401,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -521,7 +521,7 @@

    @@ -631,7 +631,7 @@

    @@ -639,7 +639,7 @@

    public - drupalDisableCache() : CollectionBuilder + drupalDisableCache() : mixed
    @@ -666,15 +666,7 @@

    -
    -
    Return values
    - CollectionBuilder - — -

    Collection builder.

    -
    - -
    - +
    @@ -698,7 +690,7 @@

    public - drupalDrushSetup([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + drupalDrushSetup([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED] ]) : mixed
    @@ -721,7 +713,9 @@

    Parameters
    : array<string|int, mixed> = ['root' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED]
    - +

    Command options.

    +
    +
    @@ -763,11 +757,7 @@
    -
    -
    Return values
    - CollectionBuilder -
    - +
    @@ -791,7 +781,7 @@

    public - drupalPermissionsSetup([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED] ]) : CollectionBuilder + drupalPermissionsSetup([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED] ]) : mixed
    @@ -806,7 +796,9 @@

    Parameters
    : array<string|int, mixed> = ['root' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED]
    - +

    Command options.

    +
    +
    @@ -848,11 +840,7 @@
    -
    -
    Return values
    - CollectionBuilder -
    - +
    @@ -1013,7 +1001,7 @@

    public - drupalSiteInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'base-url' => InputOption::VALUE_REQUIRED, 'site-name' => InputOption::VALUE_REQUIRED, 'site-mail' => InputOption::VALUE_REQUIRED, 'site-profile' => InputOption::VALUE_REQUIRED, 'site-update' => InputOption::VALUE_REQUIRED, 'site-locale' => InputOption::VALUE_REQUIRED, 'account-name' => InputOption::VALUE_REQUIRED, 'account-password' => InputOption::VALUE_REQUIRED, 'account-mail' => InputOption::VALUE_REQUIRED, 'database-type' => InputOption::VALUE_REQUIRED, 'database-scheme' => InputOption::VALUE_REQUIRED, 'database-user' => InputOption::VALUE_REQUIRED, 'database-password' => InputOption::VALUE_REQUIRED, 'database-host' => InputOption::VALUE_REQUIRED, 'database-port' => InputOption::VALUE_REQUIRED, 'database-name' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED, 'existing-config' => false, 'skip-permissions-setup' => false] ]) : CollectionBuilder + drupalSiteInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED, 'base-url' => InputOption::VALUE_REQUIRED, 'site-name' => InputOption::VALUE_REQUIRED, 'site-mail' => InputOption::VALUE_REQUIRED, 'site-profile' => InputOption::VALUE_REQUIRED, 'site-update' => InputOption::VALUE_REQUIRED, 'site-locale' => InputOption::VALUE_REQUIRED, 'account-name' => InputOption::VALUE_REQUIRED, 'account-password' => InputOption::VALUE_REQUIRED, 'account-mail' => InputOption::VALUE_REQUIRED, 'database-type' => InputOption::VALUE_REQUIRED, 'database-scheme' => InputOption::VALUE_REQUIRED, 'database-user' => InputOption::VALUE_REQUIRED, 'database-password' => InputOption::VALUE_REQUIRED, 'database-host' => InputOption::VALUE_REQUIRED, 'database-port' => InputOption::VALUE_REQUIRED, 'database-name' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED, 'existing-config' => false, 'skip-permissions-setup' => false] ]) : mixed
    @@ -1029,7 +1017,9 @@

    Parameters
    : array<string|int, mixed> = ['root' => InputOption::VALUE_REQUIRED, 'base-url' => InputOption::VALUE_REQUIRED, 'site-name' => InputOption::VALUE_REQUIRED, 'site-mail' => InputOption::VALUE_REQUIRED, 'site-profile' => InputOption::VALUE_REQUIRED, 'site-update' => InputOption::VALUE_REQUIRED, 'site-locale' => InputOption::VALUE_REQUIRED, 'account-name' => InputOption::VALUE_REQUIRED, 'account-password' => InputOption::VALUE_REQUIRED, 'account-mail' => InputOption::VALUE_REQUIRED, 'database-type' => InputOption::VALUE_REQUIRED, 'database-scheme' => InputOption::VALUE_REQUIRED, 'database-user' => InputOption::VALUE_REQUIRED, 'database-password' => InputOption::VALUE_REQUIRED, 'database-host' => InputOption::VALUE_REQUIRED, 'database-port' => InputOption::VALUE_REQUIRED, 'database-name' => InputOption::VALUE_REQUIRED, 'sites-subdir' => InputOption::VALUE_REQUIRED, 'config-dir' => InputOption::VALUE_REQUIRED, 'existing-config' => false, 'skip-permissions-setup' => false]
    - +

    Command options.

    +
    +
    @@ -1224,11 +1214,7 @@
    -
    -
    Return values
    - CollectionBuilder -
    - +
    Parameters
    : CommandData
    - +

    The command data object.

    +
    +
    @@ -1316,7 +1304,7 @@

    @@ -1324,7 +1312,7 @@

    public - drupalSitePostInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED] ]) : TaskInterface + drupalSitePostInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED] ]) : mixed
    @@ -1384,11 +1372,7 @@

    -
    -
    Return values
    - TaskInterface -
    - +
    @@ -1412,7 +1396,7 @@

    public - drupalSitePreInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED] ]) : TaskInterface + drupalSitePreInstall([array<string|int, mixed> $options = ['root' => InputOption::VALUE_REQUIRED] ]) : mixed
    @@ -1472,11 +1456,7 @@

    -
    -
    Return values
    - TaskInterface -
    - +
    @@ -1582,7 +1562,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -1593,11 +1573,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -1669,7 +1645,7 @@

    @@ -1712,7 +1688,7 @@

    @@ -1751,7 +1727,7 @@

    @@ -1821,7 +1797,7 @@

    @@ -1874,7 +1850,7 @@

    @@ -1926,7 +1902,7 @@

    @@ -1996,7 +1972,7 @@

    @@ -2049,7 +2025,7 @@

    @@ -2092,7 +2068,7 @@

    @@ -2135,7 +2111,7 @@

    @@ -2178,7 +2154,7 @@

    DrupalCommands.php : - 344 + 342 @@ -2281,7 +2257,7 @@

    @@ -2289,7 +2265,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -2321,11 +2297,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -2349,7 +2321,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -2372,11 +2344,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalSanitiseCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalSanitiseCommands.html index 70369e1b6..3761d0f6c 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalSanitiseCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DrupalSanitiseCommands.html @@ -254,7 +254,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -338,14 +338,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -704,7 +704,7 @@

    @@ -712,7 +712,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -725,11 +725,7 @@

    -
    -
    Return values
    - string -
    - +
    @@ -801,7 +797,7 @@

    @@ -844,7 +840,7 @@

    @@ -934,7 +930,7 @@

    @@ -1004,7 +1000,7 @@

    @@ -1057,7 +1053,7 @@

    @@ -1109,7 +1105,7 @@

    @@ -1179,7 +1175,7 @@

    @@ -1232,7 +1228,7 @@

    @@ -1322,7 +1318,7 @@

    @@ -1330,7 +1326,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1362,11 +1358,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1390,7 +1382,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1413,11 +1405,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DumpCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DumpCommands.html index d177528d7..96601368d 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-DumpCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-DumpCommands.html @@ -212,7 +212,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -310,14 +310,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -373,7 +373,7 @@

    taskImportDatabase() -  : ExecStack +  : mixed
    Import given dump file, gunzip is used if dump ends with .gz.
    @@ -387,7 +387,7 @@

    wgetDownloadFile() -  : Exec +  : mixed
    Download the file present in the tmp file.
    @@ -441,7 +441,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -452,11 +452,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -528,7 +524,7 @@

    @@ -571,7 +567,7 @@

    @@ -981,7 +977,7 @@

    @@ -1051,7 +1047,7 @@

    @@ -1104,7 +1100,7 @@

    @@ -1156,7 +1152,7 @@

    @@ -1226,7 +1222,7 @@

    @@ -1279,7 +1275,7 @@

    @@ -1369,7 +1365,7 @@

    @@ -1377,7 +1373,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1409,11 +1405,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1437,7 +1429,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1460,11 +1452,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    @@ -1730,7 +1718,7 @@

    @@ -1927,7 +1915,7 @@

    @@ -1935,7 +1923,7 @@

    private - taskImportDatabase(string $dump) : ExecStack + taskImportDatabase(string $dump) : mixed
    @@ -1955,14 +1943,26 @@

    Parameters
    +
    + Tags + - +
    +
    +
    + SuppressWarnings +
    +
    + +

    (PHPMD.CyclomaticComplexity)

    +
    -
    -
    Return values
    - ExecStack -
    +
    +
    + + +
    @@ -2021,7 +2021,7 @@

    @@ -2029,7 +2029,7 @@

    private - wgetDownloadFile(string $tmp, string $destination[, string|null $accept = null ][, bool $silent = false ]) : Exec + wgetDownloadFile(string $tmp, string $destination[, string|null $accept = null ][, bool $silent = false ]) : mixed
    @@ -2079,11 +2079,7 @@

    Parameters
    -
    -
    Return values
    - Exec -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitHooksCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitHooksCommands.html index 8b92ff850..d2317b4d9 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitHooksCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitHooksCommands.html @@ -228,7 +228,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -340,14 +340,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -429,7 +429,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -440,11 +440,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -516,7 +512,7 @@

    @@ -918,7 +914,7 @@

    @@ -1001,6 +997,7 @@

    tk-hrun

    +

    phpcs:disable DrupalPractice.CodeAnalysis.VariableAnalysis.UnusedVariable

    @@ -1032,7 +1029,7 @@

    @@ -1071,7 +1068,7 @@

    @@ -1141,7 +1138,7 @@

    @@ -1194,7 +1191,7 @@

    @@ -1246,7 +1243,7 @@

    @@ -1316,7 +1313,7 @@

    @@ -1369,7 +1366,7 @@

    @@ -1459,7 +1456,7 @@

    @@ -1467,7 +1464,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1499,11 +1496,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1527,7 +1520,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1550,11 +1543,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    @@ -1626,7 +1615,7 @@

    @@ -1669,7 +1658,7 @@

    @@ -1724,7 +1713,7 @@

    @@ -1769,7 +1758,7 @@

    @@ -1814,7 +1803,7 @@

    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitleaksCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitleaksCommands.html index e65d52bf6..ec2dfc474 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitleaksCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-GitleaksCommands.html @@ -237,7 +237,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -321,14 +321,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -490,7 +490,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -501,11 +501,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -577,7 +573,7 @@

    @@ -620,7 +616,7 @@

    @@ -763,7 +759,7 @@

    @@ -833,7 +829,7 @@

    @@ -886,7 +882,7 @@

    @@ -938,7 +934,7 @@

    @@ -1008,7 +1004,7 @@

    @@ -1061,7 +1057,7 @@

    @@ -1151,7 +1147,7 @@

    @@ -1159,7 +1155,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1191,11 +1187,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1219,7 +1211,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1242,11 +1234,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -310,14 +310,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -357,7 +357,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -368,11 +368,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -444,7 +440,7 @@

    @@ -487,7 +483,7 @@

    @@ -813,7 +809,7 @@

    @@ -883,7 +879,7 @@

    @@ -936,7 +932,7 @@

    @@ -988,7 +984,7 @@

    @@ -1058,7 +1054,7 @@

    @@ -1111,7 +1107,7 @@

    @@ -1201,7 +1197,7 @@

    @@ -1209,7 +1205,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1241,11 +1237,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1269,7 +1261,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1292,11 +1284,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html index 79c0b12e3..d4eb7ffcd 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html @@ -212,7 +212,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -237,6 +237,20 @@

    Check if the website is installed.
    +
    + toolkitLintBehat() + +  : mixed +
    +
    Run lint Behat.
    + +
    + toolkitLintCsPell() + +  : mixed +
    +
    Run lint CSpell.
    +
    toolkitLintCss() @@ -324,14 +338,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -385,7 +399,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -396,11 +410,7 @@

    -
    -
    Return values
    - string -
    - + +
    +

    + toolkitLintBehat() + + +

    + + +

    Run lint Behat.

    + + + public + toolkitLintBehat([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> + = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED]
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + command +
    +
    + +

    toolkit:lint-behat

    +
    + +
    +
    + option +
    +
    + +

    config The path to the config file.

    +
    + +
    +
    + option +
    +
    + +

    files The files to check.

    +
    + +
    +
    + aliases +
    +
    + +

    tk-lbehat

    +
    + +
    +
    + usage +
    +
    + +

    --files='tests/features' --config='gherkinlint.json'

    +
    + +
    +
    + + + + +
    +
    +

    + toolkitLintCsPell() + + +

    + + +

    Run lint CSpell.

    + + + public + toolkitLintCsPell([array<string|int, mixed> $options = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED, 'options' => InputOption::VALUE_OPTIONAL] ]) : mixed + +
    +
    + + +
    Parameters
    +
    +
    + $options + : array<string|int, mixed> + = ['config' => InputOption::VALUE_REQUIRED, 'files' => InputOption::VALUE_REQUIRED, 'options' => InputOption::VALUE_OPTIONAL]
    +
    + +
    +
    + + +
    + Tags + + +
    +
    +
    + command +
    +
    + +

    toolkit:lint-cspell

    +
    + +
    +
    + option +
    +
    + +

    config The path to the config file.

    +
    + +
    +
    + option +
    +
    + +

    files The files to check.

    +
    + +
    +
    + option +
    +
    + +

    options Extra options for the command.

    +
    + +
    +
    + aliases +
    +
    + +

    tk-cspell

    +
    + +
    +
    + usage +
    +
    + +

    --files='lib' --config='web/core/.cspell.json' --options='--gitignore'

    +
    + +
    +
    + + + +
    @@ -1127,7 +1340,7 @@

    @@ -1180,7 +1393,7 @@

    @@ -1232,7 +1445,7 @@

    @@ -1302,7 +1515,7 @@

    @@ -1355,7 +1568,7 @@

    @@ -1445,7 +1658,7 @@

    @@ -1453,7 +1666,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1485,11 +1698,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1513,7 +1722,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1536,11 +1745,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
  • getJson()
  • getWorkingDir()
  • isWebsiteInstalled()
  • +
  • toolkitLintBehat()
  • +
  • toolkitLintCsPell()
  • toolkitLintCss()
  • toolkitLintJs()
  • toolkitLintPhp()
  • diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Commands-PatchCommands.html b/classes/EcEuropa-Toolkit-TaskRunner-Commands-PatchCommands.html index ce35297e0..30818d1e3 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Commands-PatchCommands.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Commands-PatchCommands.html @@ -243,7 +243,7 @@

    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -334,14 +334,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -445,7 +445,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -456,11 +456,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -532,7 +528,7 @@

    @@ -575,7 +571,7 @@

    @@ -832,7 +828,7 @@

    @@ -902,7 +898,7 @@

    @@ -955,7 +951,7 @@

    @@ -1007,7 +1003,7 @@

    @@ -1077,7 +1073,7 @@

    @@ -1130,7 +1126,7 @@

    @@ -1220,7 +1216,7 @@

    @@ -1228,7 +1224,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1260,11 +1256,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1288,7 +1280,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1311,11 +1303,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -338,14 +338,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -479,7 +479,7 @@

    @@ -487,7 +487,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -500,11 +500,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -576,7 +572,7 @@

    @@ -619,7 +615,7 @@

    @@ -995,7 +991,7 @@

    @@ -1065,7 +1061,7 @@

    @@ -1118,7 +1114,7 @@

    @@ -1170,7 +1166,7 @@

    @@ -1240,7 +1236,7 @@

    @@ -1293,7 +1289,7 @@

    @@ -1383,7 +1379,7 @@

    @@ -1391,7 +1387,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1423,11 +1419,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1451,7 +1443,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1474,11 +1466,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -317,14 +317,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -415,7 +415,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -426,11 +426,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -502,7 +498,7 @@

    @@ -545,7 +541,7 @@

    @@ -734,7 +730,7 @@

    @@ -804,7 +800,7 @@

    @@ -857,7 +853,7 @@

    @@ -909,7 +905,7 @@

    @@ -979,7 +975,7 @@

    @@ -1032,7 +1028,7 @@

    @@ -1122,7 +1118,7 @@

    @@ -1130,7 +1126,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1162,11 +1158,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1190,7 +1182,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1213,11 +1205,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -345,14 +345,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -413,7 +413,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -424,11 +424,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -500,7 +496,7 @@

    @@ -543,7 +539,7 @@

    @@ -1392,7 +1388,7 @@

    @@ -1462,7 +1458,7 @@

    @@ -1515,7 +1511,7 @@

    @@ -1567,7 +1563,7 @@

    @@ -1637,7 +1633,7 @@

    @@ -1690,7 +1686,7 @@

    @@ -1780,7 +1776,7 @@

    @@ -1788,7 +1784,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -1820,11 +1816,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -1848,7 +1840,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -1871,11 +1863,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    getConfigurationFile() -  : string +  : mixed
    Path to YAML configuration file containing command defaults.
    @@ -417,14 +417,14 @@

    taskProcess() -  : Process|CollectionBuilder +  : mixed
    Process the file.
    taskReplaceBlock() -  : ReplaceBlock|CollectionBuilder +  : mixed
    Replace block in a file.
    @@ -456,7 +456,7 @@

    @@ -521,7 +521,7 @@

    @@ -582,7 +582,7 @@

    @@ -697,7 +697,7 @@

    public - getConfigurationFile() : string + getConfigurationFile() : mixed
    @@ -708,11 +708,7 @@

    -
    -
    Return values
    - string -
    - +

    @@ -777,7 +773,7 @@

    @@ -833,7 +829,7 @@

    @@ -888,7 +884,7 @@

    ToolCommands.php : - 381 + 413 @@ -977,7 +973,7 @@

    @@ -1020,7 +1016,7 @@

    @@ -1075,7 +1071,7 @@

    @@ -1114,7 +1110,7 @@

    @@ -1218,7 +1214,7 @@

    @@ -1278,7 +1274,7 @@

    @@ -1438,7 +1434,7 @@

    @@ -1542,7 +1538,7 @@

    @@ -1628,7 +1624,7 @@

    @@ -1741,7 +1737,7 @@

    @@ -1802,7 +1798,7 @@

    @@ -1863,7 +1859,7 @@

    @@ -1933,7 +1929,7 @@

    @@ -1986,7 +1982,7 @@

    @@ -2038,7 +2034,7 @@

    @@ -2108,7 +2104,7 @@

    @@ -2161,7 +2157,7 @@

    @@ -2251,7 +2247,7 @@

    @@ -2259,7 +2255,7 @@

    protected - taskProcess(string $source[, string $destination = '' ]) : Process|CollectionBuilder + taskProcess(string $source[, string $destination = '' ]) : mixed
    @@ -2291,11 +2287,7 @@

    Parameters
    -
    -
    Return values
    - Process|CollectionBuilder -
    - +
    @@ -2319,7 +2311,7 @@

    protected - taskReplaceBlock([string $filename = '' ]) : ReplaceBlock|CollectionBuilder + taskReplaceBlock([string $filename = '' ]) : mixed
    @@ -2342,11 +2334,7 @@

    Parameters
    -
    -
    Return values
    - ReplaceBlock|CollectionBuilder -
    - +
    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Inject-ConfigForCommand.html b/classes/EcEuropa-Toolkit-TaskRunner-Inject-ConfigForCommand.html index aa9736aa5..147972aec 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Inject-ConfigForCommand.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Inject-ConfigForCommand.html @@ -258,9 +258,7 @@

     : mixed

    -
    Before a Console command runs, inject configuration settings -for this command into the default value of the options of -this command.
    +
    Inject configurations.
    setApplication() @@ -509,13 +507,11 @@

    -

    Before a Console command runs, inject configuration settings -for this command into the default value of the options of -this command.

    +

    Inject configurations.

    public @@ -524,7 +520,11 @@

    - +

    Before a Console command runs, inject configuration settings +for this command into the default value of the options of +this command.

    +
    +

    Parameters
    @@ -605,7 +605,7 @@

    @@ -661,7 +661,7 @@

    @@ -725,7 +725,7 @@

    ConfigForCommand.php : - 136 + 138 @@ -790,7 +790,7 @@

    ConfigForCommand.php : - 114 + 116 @@ -846,7 +846,7 @@

    ConfigForCommand.php : - 92 + 94 @@ -893,7 +893,7 @@

    @@ -948,7 +948,7 @@

    diff --git a/classes/EcEuropa-Toolkit-TaskRunner-Runner.html b/classes/EcEuropa-Toolkit-TaskRunner-Runner.html index 81d6ad130..204f38a98 100644 --- a/classes/EcEuropa-Toolkit-TaskRunner-Runner.html +++ b/classes/EcEuropa-Toolkit-TaskRunner-Runner.html @@ -324,14 +324,14 @@

    getConfigDirFilesPaths() -  : array<string|int, string> +  : array<string|int, mixed>
    Get runner config directory files.
    getWorkingDir() -  : string +  : mixed
    Returns the current working directory.
    @@ -345,28 +345,28 @@

    prepareApplication() -  : $this +  : mixed
    Create and prepare the Application.
    prepareConfigurations() -  : $this +  : mixed
    Create the configurations and process overrides.
    prepareContainer() -  : $this +  : mixed
    Prepare the container with the configurations.
    prepareRunner() -  : $this +  : mixed
    Create and configure the Robo runner.
    @@ -811,7 +811,7 @@

    @@ -854,7 +854,7 @@

    @@ -897,7 +897,7 @@

    @@ -905,7 +905,7 @@

    private - getConfigDirFilesPaths(string $runnerConfigDir) : array<string|int, string> + getConfigDirFilesPaths(string $runnerConfigDir) : array<string|int, mixed>
    @@ -918,7 +918,9 @@

    Parameters
    : string
    - +

    The directory to scan.

    +
    +
    @@ -928,7 +930,7 @@

    Parameters
    Return values
    - array<string|int, string> + array<string|int, mixed>
    @@ -946,7 +948,7 @@

    @@ -954,7 +956,7 @@

    private - getWorkingDir() : string + getWorkingDir() : mixed
    @@ -965,11 +967,7 @@

    -
    -
    Return values
    - string -
    - +
    @@ -1045,7 +1043,7 @@

    @@ -1053,7 +1051,7 @@

    private - prepareApplication() : $this + prepareApplication() : mixed
    @@ -1064,11 +1062,7 @@

    -
    -
    Return values
    - $this -
    - +

    @@ -1092,7 +1086,7 @@

    private - prepareConfigurations() : $this + prepareConfigurations() : mixed
    @@ -1103,11 +1097,7 @@

    -
    -
    Return values
    - $this -
    - +

    @@ -1131,7 +1121,7 @@

    private - prepareContainer() : $this + prepareContainer() : mixed
    @@ -1142,11 +1132,7 @@

    -
    -
    Return values
    - $this -
    - +

    @@ -1170,7 +1156,7 @@

    private - prepareRunner() : $this + prepareRunner() : mixed
    @@ -1181,11 +1167,7 @@

    -
    -
    Return values
    - $this -
    - +

    Runner.php : - 309 + 298 diff --git a/classes/EcEuropa-Toolkit-Toolkit.html b/classes/EcEuropa-Toolkit-Toolkit.html index fb1aa100d..741f8fa90 100644 --- a/classes/EcEuropa-Toolkit-Toolkit.html +++ b/classes/EcEuropa-Toolkit-Toolkit.html @@ -220,7 +220,7 @@

    VERSION -  = '10.14.0' +  = '10.15.0'
    Constant holding the current version.
    @@ -379,7 +379,7 @@

    public mixed VERSION - = '10.14.0' + = '10.15.0' diff --git a/files/src-taskrunner-commands-componentcheckcommands.html b/files/src-taskrunner-commands-componentcheckcommands.html index b2da138bd..00f6e0eb5 100644 --- a/files/src-taskrunner-commands-componentcheckcommands.html +++ b/files/src-taskrunner-commands-componentcheckcommands.html @@ -171,7 +171,7 @@

    -
    ComponentCheckCommands
    Command class for toolkit:component-check
    +
    ComponentCheckCommands
    Command class for toolkit:component-check.
    diff --git a/guide/commands.html b/guide/commands.html index 0e0dc547b..38f5bef57 100644 --- a/guide/commands.html +++ b/guide/commands.html @@ -165,6 +165,8 @@

    Commands

    check:evaluation Check Evaluation components. check:insecure Check insecure components. check:mandatory Check mandatory components. + check:npm-insecure Run NPM Insecure. + check:npm-outdated Run NPM Outdated. check:outdated Check outdated components. check:recommended Check recommended components. check:unsupported Check unsupported components. @@ -208,6 +210,8 @@

    Commands

    toolkit:install-clone [tk-iclone] Install a clone website. toolkit:install-dependencies Install packages present in the .opts.yml file under extra_pkgs section. toolkit:install-dump [tk-idump] Import the production snapshot. + toolkit:lint-behat [tk-lbehat] Run lint Behat. + toolkit:lint-cspell [tk-cspell] Run lint CSpell. toolkit:lint-css [tk-css] Run lint CSS. toolkit:lint-js [tk-js|tljs] Run lint JS. toolkit:lint-php [tk-php|tlp] Run lint PHP. diff --git a/guide/testing-project.html b/guide/testing-project.html index 14f91f370..0646d86cf 100644 --- a/guide/testing-project.html +++ b/guide/testing-project.html @@ -534,6 +534,49 @@

    ESLint YAML testing

    docker-compose exec web ./vendor/bin/run toolkit:lint-yaml
    + + +
    +

    CSpell testing

    + + +

    To run the CSpell tests you can make use of the toolkit:lint-cspell + command:

    + +
    docker-compose exec web ./vendor/bin/run toolkit:lint-cspell
    + + +

    These are the default configurations in the runner.yml + file.

    + +
    toolkit:
    +  lint:
    +    cspell:
    +      config: '.cspell.json'
    +      files: 'lib/'
    +      options: '--dot --gitignore'
    + +
    + +
    +

    Behat lint testing

    + + +

    To run the Behat lint you can make use of the toolkit:lint-behat + command:

    + +
    docker-compose exec web ./vendor/bin/run toolkit:lint-behat
    + + +

    These are the default configurations in the runner.yml + file.

    + +
    toolkit:
    +  lint:
    +    behat:
    +      config: 'gherkinlint.json'
    +      files: 'tests/features'
    +
    diff --git a/js/searchIndex.js b/js/searchIndex.js index d679b6173..a83101516 100644 --- a/js/searchIndex.js +++ b/js/searchIndex.js @@ -453,7 +453,7 @@ Search.appendIndex( }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands", "name": "ComponentCheckCommands", - "summary": "Command\u0020class\u0020for\u0020toolkit\u003Acomponent\u002Dcheck", + "summary": "Command\u0020class\u0020for\u0020toolkit\u003Acomponent\u002Dcheck.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003AcomponentCheck\u0028\u0029", @@ -510,6 +510,16 @@ Search.appendIndex( "name": "componentComposer", "summary": "Check\u0020composer\u0020packages.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#method_componentComposer" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003AcomponentNpmInsecure\u0028\u0029", + "name": "componentNpmInsecure", + "summary": "Run\u0020NPM\u0020Insecure.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#method_componentNpmInsecure" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003AcomponentNpmOutdated\u0028\u0029", + "name": "componentNpmOutdated", + "summary": "Run\u0020NPM\u0020Outdated.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#method_componentNpmOutdated" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003AprepareSkips\u0028\u0029", "name": "prepareSkips", @@ -580,6 +590,11 @@ Search.appendIndex( "name": "restoreConfigReadOnly", "summary": "Restore\u0020the\u0020comment\u0020added\u0020to\u0020the\u0020config_readonly\u0020setting.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#method_restoreConfigReadOnly" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003AgetOptsYml\u0028\u0029", + "name": "getOptsYml", + "summary": "Returns\u0020the\u0020.opts.yml\u0020content.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#method_getOptsYml" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024evaluationFailed", "name": "evaluationFailed", @@ -655,6 +670,26 @@ Search.appendIndex( "name": "skipRecommended", "summary": "", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_skipRecommended" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024skipInsecureNpm", + "name": "skipInsecureNpm", + "summary": "", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_skipInsecureNpm" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024skipOutdatedNpm", + "name": "skipOutdatedNpm", + "summary": "", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_skipOutdatedNpm" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024outdatedNpmFailed", + "name": "outdatedNpmFailed", + "summary": "", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_outdatedNpmFailed" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024insecureNpmFailed", + "name": "insecureNpmFailed", + "summary": "", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_insecureNpmFailed" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024recommendedFailedCount", "name": "recommendedFailedCount", @@ -690,6 +725,11 @@ Search.appendIndex( "name": "disabledConfigReadonly", "summary": "", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_disabledConfigReadonly" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ComponentCheckCommands\u003A\u003A\u0024optsYml", + "name": "optsYml", + "summary": "", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-ComponentCheckCommands.html#property_optsYml" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\ConfigurationCommands", "name": "ConfigurationCommands", @@ -718,12 +758,12 @@ Search.appendIndex( }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AcopyDockerComposeDefaultToProject\u0028\u0029", "name": "copyDockerComposeDefaultToProject", - "summary": "Copy\u0020.\/resources\/docker\/default.yml\u0020file\u0020to\u0020docker\u002Dcompose.yml\u0020inside\u0020project\u0020root\u0020directory", + "summary": "Copy\u0020.\/resources\/docker\/default.yml\u0020file\u0020to\u0020docker\u002Dcompose.yml\u0020inside\u0020project\u0020root\u0020directory.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_copyDockerComposeDefaultToProject" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetServicesImagesFromDockerCompose\u0028\u0029", "name": "getServicesImagesFromDockerCompose", - "summary": "Get\u0020array\u0020of\u0020services\u0020with\u0020images\u0020and\u0020versions\u0020from\u0020docker\u002Dcompose.yml", + "summary": "Get\u0020array\u0020of\u0020services\u0020with\u0020images\u0020and\u0020versions\u0020from\u0020docker\u002Dcompose.yml.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getServicesImagesFromDockerCompose" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetProjectPhpFromWebsite\u0028\u0029", @@ -738,52 +778,52 @@ Search.appendIndex( }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AextractMajorMinorVersion\u0028\u0029", "name": "extractMajorMinorVersion", - "summary": "Converts\u0020from\u0020semantic\u0020version\u0020to\u0020\u0022major.minor\u0022\u0020version", + "summary": "Converts\u0020from\u0020semantic\u0020version\u0020to\u0020\u0022major.minor\u0022\u0020version.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_extractMajorMinorVersion" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AbackupDockerComposeFile\u0028\u0029", "name": "backupDockerComposeFile", - "summary": "Backup\u0020current\u0020docker\u002Dcompose.yml\u0020to\u0020docker\u002Dcompose.yml.prev", + "summary": "Backup\u0020current\u0020docker\u002Dcompose.yml\u0020to\u0020docker\u002Dcompose.yml.prev.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_backupDockerComposeFile" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AupdateDockerComposeFile\u0028\u0029", "name": "updateDockerComposeFile", - "summary": "Update\u0020docker\u002Dcompose.yml", + "summary": "Update\u0020docker\u002Dcompose.yml.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_updateDockerComposeFile" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetServiceDetailsFromResources\u0028\u0029", "name": "getServiceDetailsFromResources", - "summary": "Return\u0020the\u0020details\u0020for\u0020a\u0020service\u0020from\u0020.\/resources\/docker", + "summary": "Return\u0020the\u0020details\u0020for\u0020a\u0020service\u0020from\u0020.\/resources\/docker.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getServiceDetailsFromResources" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetServicesVersionsFromRequirements\u0028\u0029", "name": "getServicesVersionsFromRequirements", - "summary": "Get\u0020final\u0020services\u0020names\u0020with\u0020versions\u0020from\u0020requirements", + "summary": "Get\u0020final\u0020services\u0020names\u0020with\u0020versions\u0020from\u0020requirements.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getServicesVersionsFromRequirements" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AwriteWarningMessages\u0028\u0029", "name": "writeWarningMessages", - "summary": "Write\u0020all\u0020available\u0020warning\u0020messages", + "summary": "Write\u0020all\u0020available\u0020warning\u0020messages.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_writeWarningMessages" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetServiceImage\u0028\u0029", "name": "getServiceImage", - "summary": "Get\u0020service\u0020image\u0020with\u0020version", + "summary": "Get\u0020service\u0020image\u0020with\u0020version.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getServiceImage" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetFinalImages\u0028\u0029", "name": "getFinalImages", - "summary": "Get\u0020final\u0020images\u0020to\u0020update\u0020docker\u002Dcompose.yml", + "summary": "Get\u0020final\u0020images\u0020to\u0020update\u0020docker\u002Dcompose.yml.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getFinalImages" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AgetWarningMessages\u0028\u0029", "name": "getWarningMessages", - "summary": "Get\u0020warning\u0020messages\u0020for\u0020versions\u0020on\u0020.opts.yml\u0020that\u0020not\u0020respect\u0020the\u0020minimum\u0020requirements", + "summary": "Get\u0020warning\u0020messages\u0020for\u0020versions\u0020on\u0020.opts.yml\u0020that\u0020not\u0020respect\u0020the\u0020minimum\u0020requirements.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_getWarningMessages" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003AremoveUnusedDcServices\u0028\u0029", "name": "removeUnusedDcServices", - "summary": "Remove\u0020services\u0020that\u0020do\u0020not\u0020exist\u0020in\u0020project\u0020info,\u0020requirements\u0020or\u0020.opts.yml", + "summary": "Remove\u0020services\u0020that\u0020do\u0020not\u0020exist\u0020in\u0020project\u0020info,\u0020requirements\u0020or\u0020.opts.yml.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-DockerCommands.html#method_removeUnusedDcServices" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\DockerCommands\u003A\u003ADC_YML_FILE", @@ -1280,6 +1320,16 @@ Search.appendIndex( "name": "toolkitLintCss", "summary": "Run\u0020lint\u0020CSS.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html#method_toolkitLintCss" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\LintCommands\u003A\u003AtoolkitLintCsPell\u0028\u0029", + "name": "toolkitLintCsPell", + "summary": "Run\u0020lint\u0020CSpell.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html#method_toolkitLintCsPell" + }, { + "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\LintCommands\u003A\u003AtoolkitLintBehat\u0028\u0029", + "name": "toolkitLintBehat", + "summary": "Run\u0020lint\u0020Behat.", + "url": "classes/EcEuropa-Toolkit-TaskRunner-Commands-LintCommands.html#method_toolkitLintBehat" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Commands\\PatchCommands", "name": "PatchCommands", @@ -1578,7 +1628,7 @@ Search.appendIndex( }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Inject\\ConfigForCommand\u003A\u003AinjectConfiguration\u0028\u0029", "name": "injectConfiguration", - "summary": "Before\u0020a\u0020Console\u0020command\u0020runs,\u0020inject\u0020configuration\u0020settings\nfor\u0020this\u0020command\u0020into\u0020the\u0020default\u0020value\u0020of\u0020the\u0020options\u0020of\nthis\u0020command.", + "summary": "Inject\u0020configurations.", "url": "classes/EcEuropa-Toolkit-TaskRunner-Inject-ConfigForCommand.html#method_injectConfiguration" }, { "fqsen": "\\EcEuropa\\Toolkit\\TaskRunner\\Inject\\ConfigForCommand\u003A\u003AinjectConfigurationForGlobalOptions\u0028\u0029", diff --git a/namespaces/eceuropa-toolkit-taskrunner-commands.html b/namespaces/eceuropa-toolkit-taskrunner-commands.html index 9b2895619..3c5cb2b92 100644 --- a/namespaces/eceuropa-toolkit-taskrunner-commands.html +++ b/namespaces/eceuropa-toolkit-taskrunner-commands.html @@ -166,7 +166,7 @@

    -
    AxeCommands
    Commands to interact with the axe-scan.
    BlackfireCommands
    Commands to interact with the Blackfire.
    BuildCommands
    Provides commands to build a site for development and a production artifact.
    ComponentCheckCommands
    Command class for toolkit:component-check
    ConfigurationCommands
    Configuration commands are defined in the runner.yml file under 'commands:'.
    DockerCommands
    Provides commands to update docker-compose.yml based on project's configurations.
    DocumentationCommands
    Provides commands to generate Toolkit documentation.
    DrupalCommands
    Drupal commands to setup and install a Drupal 8 site.
    DrupalSanitiseCommands
    Provides commands to check sanitisation fields.
    DumpCommands
    Provides commands to download and install dump files.
    GitHooksCommands
    Provides commands to interact with git hooks.
    GitleaksCommands
    Provides command to interact with GitLeaks.
    InstallCommands
    Class ToolkitCommands.
    LintCommands
    Commands to lint the source code and interact with ESLint.
    PatchCommands
    Commands for patch download and list.
    ReleaseCommands
    Provides commands to generate Toolkit release.
    SymlinkProjectCommands
    Provides command to symlink project as a package.
    TestsCommands
    Class TestsCommands.
    ToolCommands
    Generic tools.
    +
    AxeCommands
    Commands to interact with the axe-scan.
    BlackfireCommands
    Commands to interact with the Blackfire.
    BuildCommands
    Provides commands to build a site for development and a production artifact.
    ComponentCheckCommands
    Command class for toolkit:component-check.
    ConfigurationCommands
    Configuration commands are defined in the runner.yml file under 'commands:'.
    DockerCommands
    Provides commands to update docker-compose.yml based on project's configurations.
    DocumentationCommands
    Provides commands to generate Toolkit documentation.
    DrupalCommands
    Drupal commands to setup and install a Drupal 8 site.
    DrupalSanitiseCommands
    Provides commands to check sanitisation fields.
    DumpCommands
    Provides commands to download and install dump files.
    GitHooksCommands
    Provides commands to interact with git hooks.
    GitleaksCommands
    Provides command to interact with GitLeaks.
    InstallCommands
    Class ToolkitCommands.
    LintCommands
    Commands to lint the source code and interact with ESLint.
    PatchCommands
    Commands for patch download and list.
    ReleaseCommands
    Provides commands to generate Toolkit release.
    SymlinkProjectCommands
    Provides command to symlink project as a package.
    TestsCommands
    Class TestsCommands.
    ToolCommands
    Generic tools.
    diff --git a/packages/Toolkit.html b/packages/Toolkit.html index b510ee01f..5683ee30f 100644 --- a/packages/Toolkit.html +++ b/packages/Toolkit.html @@ -170,7 +170,7 @@

    -
    AuthorizationBasic
    Authorization Basic for QA api.
    AuthorizationFactory
    Authorization factory for QA api.
    AuthorizationToken
    Authorization Token for QA api.
    ConfigurationCallbacks
    Class containing configuration check callbacks.
    DrupalReleaseHistory
    Helper to fetch drupal.org release-history information.
    Mock
    Toolkit mock class.
    ConfigurationCommand
    Execute the tasks from a Configuration command.
    Process
    Process a source file to its destination replacing tokens.
    ReplaceBlock
    Replace a block of content in given file.
    AbstractCommands
    Class AbstractCommands.
    AbstractGitHooks
    Projects should extend this class to override or extend the GitHooks feature.
    AxeCommands
    Commands to interact with the axe-scan.
    BlackfireCommands
    Commands to interact with the Blackfire.
    BuildCommands
    Provides commands to build a site for development and a production artifact.
    ComponentCheckCommands
    Command class for toolkit:component-check
    ConfigurationCommands
    Configuration commands are defined in the runner.yml file under 'commands:'.
    DockerCommands
    Provides commands to update docker-compose.yml based on project's configurations.
    DocumentationCommands
    Provides commands to generate Toolkit documentation.
    DrupalCommands
    Drupal commands to setup and install a Drupal 8 site.
    DrupalSanitiseCommands
    Provides commands to check sanitisation fields.
    DumpCommands
    Provides commands to download and install dump files.
    GitHooksCommands
    Provides commands to interact with git hooks.
    GitleaksCommands
    Provides command to interact with GitLeaks.
    InstallCommands
    Class ToolkitCommands.
    LintCommands
    Commands to lint the source code and interact with ESLint.
    PatchCommands
    Commands for patch download and list.
    ReleaseCommands
    Provides commands to generate Toolkit release.
    SymlinkProjectCommands
    Provides command to symlink project as a package.
    TestsCommands
    Class TestsCommands.
    ToolCommands
    Generic tools.
    ConfigForCommand
    This class is based on \Consolidation\Config\Inject\ConfigForCommand.
    Runner
    Toolkit Runner.
    Toolkit
    Provides default Toolkit class.
    Website
    Handle communications with QA api.
    +
    AuthorizationBasic
    Authorization Basic for QA api.
    AuthorizationFactory
    Authorization factory for QA api.
    AuthorizationToken
    Authorization Token for QA api.
    ConfigurationCallbacks
    Class containing configuration check callbacks.
    DrupalReleaseHistory
    Helper to fetch drupal.org release-history information.
    Mock
    Toolkit mock class.
    ConfigurationCommand
    Execute the tasks from a Configuration command.
    Process
    Process a source file to its destination replacing tokens.
    ReplaceBlock
    Replace a block of content in given file.
    AbstractCommands
    Class AbstractCommands.
    AbstractGitHooks
    Projects should extend this class to override or extend the GitHooks feature.
    AxeCommands
    Commands to interact with the axe-scan.
    BlackfireCommands
    Commands to interact with the Blackfire.
    BuildCommands
    Provides commands to build a site for development and a production artifact.
    ComponentCheckCommands
    Command class for toolkit:component-check.
    ConfigurationCommands
    Configuration commands are defined in the runner.yml file under 'commands:'.
    DockerCommands
    Provides commands to update docker-compose.yml based on project's configurations.
    DocumentationCommands
    Provides commands to generate Toolkit documentation.
    DrupalCommands
    Drupal commands to setup and install a Drupal 8 site.
    DrupalSanitiseCommands
    Provides commands to check sanitisation fields.
    DumpCommands
    Provides commands to download and install dump files.
    GitHooksCommands
    Provides commands to interact with git hooks.
    GitleaksCommands
    Provides command to interact with GitLeaks.
    InstallCommands
    Class ToolkitCommands.
    LintCommands
    Commands to lint the source code and interact with ESLint.
    PatchCommands
    Commands for patch download and list.
    ReleaseCommands
    Provides commands to generate Toolkit release.
    SymlinkProjectCommands
    Provides command to symlink project as a package.
    TestsCommands
    Class TestsCommands.
    ToolCommands
    Generic tools.
    ConfigForCommand
    This class is based on \Consolidation\Config\Inject\ConfigForCommand.
    Runner
    Toolkit Runner.
    Toolkit
    Provides default Toolkit class.
    Website
    Handle communications with QA api.

    Traits