Skip to content

Commit

Permalink
Robo release 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
greg-1-anderson committed Feb 21, 2021
1 parent 580527b commit aa4028f
Show file tree
Hide file tree
Showing 17 changed files with 100 additions and 15 deletions.
2 changes: 2 additions & 0 deletions docs/tasks/ApiGen.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,12 @@ $this->taskApiGen('./vendor/apigen/apigen.phar')
* `colors($colors)` * `param bool|string` $colors
* `updateCheck($check)` * `param bool|string` $check
* `debug($debug)` * `param bool|string` $debug
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `rawArg($arg)` Pass the provided string in its raw (as provided) form as an argument to executable.
* `option($option, $value = null, $separator = null)` Pass option to executable. Options are prefixed with `--` , value can be provided in second parameter.
* `options(array $options, $separator = null)` Pass multiple options to executable. The associative array contains
* `optionList($option, $value = null, $separator = null)` Pass an option with multiple values to executable. Value can be a string or array.


3 changes: 3 additions & 0 deletions docs/tasks/Archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ $this->taskExtract($archivePath)

* `to($to)` Location to store extracted files.
* `preserveTopDirectory($preserve = null)` * `param bool` $preserve
* `setOutput($output)` Sets the Console Output.

## Pack

Expand All @@ -49,4 +50,6 @@ $this->taskPack(
* `addDir($placementLocation, $filesystemLocation)` Alias for addFile, in case anyone has angst about using
* `add($item)` Add a file or directory, or list of same to the archive.
* `exclude($ignoreList)` Allow files or folder to be excluded from the archive. Use regex, without enclosing slashes.
* `setOutput($output)` Sets the Console Output.


5 changes: 5 additions & 0 deletions docs/tasks/Assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ This will execute as:

* `to($target)` Sets the target directory where the files will be copied to.
* `minifier($minifier, array $options = Array ( ) )` Sets the minifier.
* `setOutput($output)` Sets the Console Output.

## Less

Expand Down Expand Up @@ -104,6 +105,7 @@ inject the name there.
* `setImportPaths($dirs)` Sets import directories
* `setFormatter($formatterName)` * `param string` $formatterName
* `compiler($compiler, array $options = Array ( ) )` Sets the compiler.
* `setOutput($output)` Sets the Console Output.

## Minify

Expand All @@ -129,6 +131,7 @@ composer require natxet/cssmin:^3.0
* `keepImportantComments($keepImportantComments)` keepImportantComments option for the JS minimisation.
* `specialVarRx($specialVarRx)` Set specialVarRx option for the JS minimisation.
* `__toString()` @return string
* `setOutput($output)` Sets the Console Output.

## Scss

Expand Down Expand Up @@ -160,4 +163,6 @@ inject the name there.
* `addImportPath($dir)` Adds import directory
* `setImportPaths($dirs)` Sets import directories
* `compiler($compiler, array $options = Array ( ) )` Sets the compiler.
* `setOutput($output)` Sets the Console Output.


7 changes: 7 additions & 0 deletions docs/tasks/Base.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ if ($this->taskExec('phpunit .')->run()->wasSuccessful()) {
```

* `simulate($context)` {@inheritdoc}
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -49,6 +50,7 @@ $this->taskExecStack()
* `exec($command)` * `param string|string[]|CommandInterface` $command
* `stopOnFail($stopOnFail = null)` * `param bool` $stopOnFail
* `result($result)`
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command

## ParallelExec
Expand All @@ -68,6 +70,8 @@ $this->taskParallelExec()

* `process($command)` * `param string|\Robo\Contract\CommandInterface` $command
* `waitInterval($waitInterval)` Parallel processing will wait `$waitInterval` seconds after launching each process and before
* `setOutput($output)` Sets the Console Output.


## SymfonyCommand

Expand All @@ -91,6 +95,8 @@ $this->taskSymfonyCommand(new ModelGeneratorCommand())

* `arg($arg, $value)` * `param string` $arg
* `opt($option, $value = null)`
* `setOutput($output)` Sets the Console Output.


## Watch

Expand Down Expand Up @@ -146,4 +152,5 @@ $this
The $event parameter is a [standard Symfony file resource object](https://api.symfony.com/3.1/Symfony/Component/Config/Resource/FileResource.html)

* `monitor($paths, $callable, $events = null)` * `param string|string[]` $paths
* `setOutput($output)` Sets the Console Output.

3 changes: 3 additions & 0 deletions docs/tasks/Bower.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ $this->taskBowerInstall('path/to/my/bower')
* `forceLatest()` adds `force-latest` option to bower
* `noDev()` adds `production` option to bower
* `offline()` adds `offline` option to bower
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -29,6 +30,7 @@ $this->taskBowerInstall('path/to/my/bower')
* `options(array $options, $separator = null)` Pass multiple options to executable. The associative array contains
* `optionList($option, $value = null, $separator = null)` Pass an option with multiple values to executable. Value can be a string or array.


## Update


Expand All @@ -50,6 +52,7 @@ $this->taskBowerUpdate('path/to/my/bower')
* `forceLatest()` adds `force-latest` option to bower
* `noDev()` adds `production` option to bower
* `offline()` adds `offline` option to bower
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down
11 changes: 11 additions & 0 deletions docs/tasks/Composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ $this->taskComposerValidate()->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -66,6 +67,7 @@ $this->taskComposerConfig()->set('bin-dir', 'bin/')->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -107,6 +109,7 @@ $this->taskComposerCreateProject()->source('foo/bar')->target('myBar')->run();
* `disablePlugins($disable = null)` disable plugins
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -158,6 +161,7 @@ $this->taskComposerDumpAutoload('path/to/my/composer.phar')
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -201,6 +205,7 @@ $this->taskComposerInit()->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -246,6 +251,7 @@ $this->taskComposerInstall('path/to/my/composer.phar')
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -284,6 +290,7 @@ $this->taskComposerRemove()->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -320,6 +327,7 @@ $this->taskComposerRequire()->dependency('foo/bar', '^.2.4.8')->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -328,6 +336,7 @@ $this->taskComposerRequire()->dependency('foo/bar', '^.2.4.8')->run();
* `options(array $options, $separator = null)` Pass multiple options to executable. The associative array contains
* `optionList($option, $value = null, $separator = null)` Pass an option with multiple values to executable. Value can be a string or array.


## Update


Expand Down Expand Up @@ -365,6 +374,7 @@ $this->taskComposerUpdate('path/to/my/composer.phar')
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -404,6 +414,7 @@ $this->taskComposerValidate()->run();
* `noScripts($disable = null)` skip scripts
* `workingDir($dir)` adds `--working-dir $dir` option to composer
* `buildCommand()` Copy class fields into command options as directed.
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down
10 changes: 8 additions & 2 deletions docs/tasks/Development.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ $this->taskChangelog()
* `change($change)` * `param string` $change
* `getChanges()` @return array
* `processLogRow($i)` * `param string` $i
* `setOutput($output)` Sets the Console Output.

## GenerateMarkdownDoc

Expand Down Expand Up @@ -93,6 +94,7 @@ $this->taskGenDoc('models.md')
* `append($append)` Inserts text at the end of markdown file.
* `text($text)` * `param string` $text
* `textForClass($item)` * `param string` $item
* `setOutput($output)` Sets the Console Output.

## Generate

Expand All @@ -105,7 +107,7 @@ $this->taskGenerateTask('Symfony\Component\Filesystem\Filesystem', 'FilesystemSt
->run();
```


* `setOutput($output)` Sets the Console Output.


## GitHubRelease
Expand Down Expand Up @@ -139,6 +141,7 @@ $this->taskGitHubRelease('0.1.0')
* `user($user)` * `param string` $user
* `password($password)` * `param string` $password
* `accessToken($token)` * `param string` $token
* `setOutput($output)` Sets the Console Output.

## OpenBrowser

Expand All @@ -160,7 +163,7 @@ $this->taskOpenBrowser([
->run();
```


* `setOutput($output)` Sets the Console Output.

## PackPhar

Expand Down Expand Up @@ -201,6 +204,7 @@ $pharTask = $this->taskPackPhar('package/codecept.phar')
* `addFile($path, $file)` * `param string` $path
* `addFiles($files)` * `param \Symfony\Component\Finder\SplFileInfo[]` $files
* `executable($file)` * `param string` $file
* `setOutput($output)` Sets the Console Output.

## PhpServer

Expand Down Expand Up @@ -229,6 +233,7 @@ $this->taskServer(8000)
* `host($host)` * `param string` $host
* `dir($path)` * `param string` $path
* `simulate($context)` {@inheritdoc}
* `setOutput($output)` Sets the Console Output.
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
* `rawArg($arg)` Pass the provided string in its raw (as provided) form as an argument to executable.
Expand Down Expand Up @@ -259,3 +264,4 @@ $this->taskSemVer('.semver')
* `prerelease($tag = null)` * `param string` $tag
* `metadata($data)` * `param array|string` $data


9 changes: 9 additions & 0 deletions docs/tasks/Docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Class Build

* `tag($tag)` * `param string` $tag
* `enableBuildKit()` * `return` $this
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -52,6 +53,7 @@ $task->dockerCommit($result)
```

* `name($name)` * `param string` $name
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -88,6 +90,7 @@ $this->taskDockerExec($test)

* `detached()` * `return` $this
* `exec($command)` * `param string|\Robo\Contract\CommandInterface` $command
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -110,6 +113,7 @@ $this->taskDockerPull('wordpress')
```


* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -131,6 +135,7 @@ $this->taskDockerRemove($container)
```


* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand Down Expand Up @@ -197,6 +202,7 @@ $this->taskDockerRun('wordpress')
* `tmpDir($dir)` * `param string` $dir
* `getTmpDir()` @return string
* `getUniqId()` @return string
* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -217,6 +223,7 @@ $this->taskDockerStart($cidOrResult)
?>
```

* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -237,6 +244,7 @@ $this->taskDockerStop($cidOrResult)
?>
```

* `setOutput($output)` Sets the Console Output.
* `dir($dir)` Changes working directory of command
* `arg($arg)` Pass argument to executable. Its value will be automatically escaped.
* `args($args)` Pass methods parameters as arguments to executable. Argument values
Expand All @@ -245,3 +253,4 @@ $this->taskDockerStop($cidOrResult)
* `options(array $options, $separator = null)` Pass multiple options to executable. The associative array contains
* `optionList($option, $value = null, $separator = null)` Pass an option with multiple values to executable. Value can be a string or array.


5 changes: 5 additions & 0 deletions docs/tasks/File.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ $this->taskConcat([
```

* `to($dst)` set the destination file
* `setOutput($output)` Sets the Console Output.

## Replace

Expand Down Expand Up @@ -52,6 +53,8 @@ $this->taskReplaceInFile('box/robo.txt')
* `to($to)` Value(s) to be set as a replacement.
* `regex($regex)` Regex to match string to be replaced.
* `limit($limit)` If used with $this->regexp() how many counts will be replaced
* `setOutput($output)` Sets the Console Output.


## TmpFile

Expand Down Expand Up @@ -91,6 +94,7 @@ $collection->run();
* `originalContents()` @return string
* `wouldChange()` @return bool
* `getPath()` @return string
* `setOutput($output)` Sets the Console Output.

## Write

Expand Down Expand Up @@ -121,4 +125,5 @@ $this->taskWriteToFile('blogpost.md')
* `originalContents()` @return string
* `wouldChange()` @return bool
* `getPath()` @return string
* `setOutput($output)` Sets the Console Output.

Loading

0 comments on commit aa4028f

Please sign in to comment.