mcuadros / cli-array-editor
This library provides an easy way to edit arrays in CLI using vim or your preferred editor.
Requires
- php: >=5.3.0
Suggests
- ext-yaml: Allows YAML format.
This package is not auto-updated.
Last update: 2020-06-12 17:39:53 UTC
README
This library provides an easy way to edit arrays in CLI using vim or your preferred editor.
Can be useful in scenarios where we need an interface to edit arrays from a CLI PHP application, CLIArrayEditor will open an editor with the array in a readable format (json, yaml, etc) and wait for the user (like "crontab -e" or "git commit").
The editor can be configured or by default $EDITOR from the environment will be used.
Requirements
- PHP 5.3.23;
- Unix system;
- PECL yaml >= 0.5.0 (optional)
Installation
The recommended way to install CLIArrayEditor is through composer. You can see package information on Packagist.
{ "require": { "mcuadros/cli-array-editor": "dev" } }
Examples
use CLIArrayEditor\Editor; use CLIArrayEditor\Format\JSON; $tmp = array( 'baz' => true, 'foo' => 'bar' ); $editor = new Editor(); $result = $editor ->setFormat(new JSON) ->edit($tmp); print_r($result);
Check available Editor's methods in src/CLIArrayEditor/Editor.php
Tests
Tests are in the tests
folder.
To run them, you need PHPUnit.
Example:
$ phpunit --configuration phpunit.xml.dist
License
MIT, see LICENSE