https://github.com/ramsey/composer-repl-lib
:shell::books: The library behind ramsey/composer-repl, allowing for extension of the ramsey/composer-repl Composer plugin and non-plugin use of the repl command.
https://github.com/ramsey/composer-repl-lib
composer-package composer-plugin php psysh repl shell
Last synced: 4 months ago
JSON representation
:shell::books: The library behind ramsey/composer-repl, allowing for extension of the ramsey/composer-repl Composer plugin and non-plugin use of the repl command.
- Host: GitHub
- URL: https://github.com/ramsey/composer-repl-lib
- Owner: ramsey
- License: mit
- Created: 2022-01-18T19:36:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T01:56:36.000Z (over 1 year ago)
- Last Synced: 2025-05-25T11:51:33.419Z (about 1 year ago)
- Topics: composer-package, composer-plugin, php, psysh, repl, shell
- Language: PHP
- Homepage:
- Size: 231 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
ramsey/composer-repl-lib
The library behind the ramsey/composer-repl Composer plugin.
## About
This is the library that powers the [ramsey/composer-repl](https://github.com/ramsey/composer-repl)
[Composer](https://getcomposer.org/) plugin. Since you can't extend Composer
plugins, this exists to allow for extension. This library also allows for
non-plugin use of the `repl` CLI tool, which you may use even if you do not wish
to use the plugin functionality.
> [!TIP]
> If you don't need to extend this for your own plugin needs, and you want the
> functionality provided by the plugin, check out
> [ramsey/composer-repl](https://github.com/ramsey/composer-repl) instead.
REPL stands for *read-eval-print loop*. It's a language shell that reads user
input, evaluates the input using a programming language (in this case, PHP), and
prints the output to the screen. Then, it returns to the read state (that's the
*loop* part).
[PsySH](https://psysh.org) is the REPL providing the magic behind
ramsey/composer-repl and ramsey/composer-repl-lib. PsySH is a language shell for
PHP. It's similar to [irb](https://github.com/ruby/irb) for Ruby,
[IPython](https://ipython.org) for Python, and
[JShell](https://docs.oracle.com/javase/9/tools/jshell.htm) for Java. In addition
to acting as a language shell, PsySH can also function as an interactive debugger
and development console. [Laravel Tinker](https://github.com/laravel/tinker),
[Drush](https://www.drush.org) for Drupal,
[WP-CLI shell](https://github.com/wp-cli/shell-command) for WordPress,
[CakePHP console](https://book.cakephp.org/3/en/console-and-shells/repl.html),
and [Yii shell](https://github.com/yiisoft/yii2-shell) are a few of the projects
using PsySH.
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).
By participating in this project and its community, you are expected to
uphold this code.
## Installation
Install this package as a development dependency using
[Composer](https://getcomposer.org).
``` bash
composer require --dev ramsey/composer-repl-lib
```
## Usage
Open your terminal and type `./vendor/bin/repl`.
You'll see something similar to this:
```
Psy Shell v0.12.7 (PHP 8.4.4 — cli) by Justin Hileman
------------------------------------------------------------------------
Welcome to the development console (REPL).
To learn more about what you can do in PsySH, type `help`.
------------------------------------------------------------------------
>>>
```
While in the dev console, you can do cool things like this:
``` php
>>> $hello = 'Hello, world'
=> "Hello, world"
>>> echo $hello
Hello, world
>>> foreach ([1, 2, 3] as $x) echo $x . "\n"
1
2
3
>>> $date = new DateTimeImmutable();
=> DateTimeImmutable @1598393282 {#6953
date: 2020-08-25 22:08:02.643076 UTC (+00:00),
}
>>> $getDate = fn (DateTimeInterface $dt): DateTimeInterface => $dt;
=> Closure(DateTimeInterface $dt): DateTimeInterface {#6964 …3}
>>> t assertInstanceOf(DateTimeInterface::class, $date);
Test passed!
>>> t assertSame($date, $getDate($date))
Test passed!
>>> phpunit
PHPUnit 11.5.11 by Sebastian Bergmann and contributors.
Runtime: PHP 8.4.4
Configuration: /path/to/ramsey/conventional-commits/phpunit.xml.dist
............................................................... 63 / 221 ( 28%)
............................................................... 126 / 221 ( 57%)
............................................................... 189 / 221 ( 85%)
................................ 221 / 221 (100%)
Time: 00:00.064, Memory: 12.00 MB
OK (221 tests, 484 assertions)
```
> [!IMPORTANT]
> ✨🐘 This implementation of PsySH has Super ElePHPant Powers. 🐘✨
## Environment Bootstrapping
The power of this REPL comes in its ability to act as a tool in your local
development environment. So, you might want to load parts of your environment
(i.e., configuration, objects, etc.), so you can access these from within the
REPL.
You can do this by specifying any number of PHP scripts to include in
`composer.json`, like this:
``` json
{
"extra": {
"ramsey/composer-repl": {
"includes": [
"repl.php",
"tests/bootstrap.php"
]
}
}
}
```
Any variables set or configuration loaded from these scripts is available to use
from within the REPL.
For example, if `repl.php` contains:
``` php
>> ls
Variables: $env, $foo, $phpunit
>>> $foo
=> "bar"
```
## Contributing
Contributions are welcome! To contribute, please familiarize yourself with
[CONTRIBUTING.md](CONTRIBUTING.md).
## Coordinated Disclosure
Keeping user information safe and secure is a top priority, and we welcome the
contribution of external security researchers. If you believe you've found a
security issue in software that is maintained in this repository, please read
[SECURITY.md](SECURITY.md) for instructions on submitting a vulnerability report.
## Copyright and License
The ramsey/composer-repl-lib library is copyright © [Ben Ramsey](https://benramsey.com)
and licensed for use under the terms of the
MIT License (MIT). Please see [LICENSE](LICENSE) for more information.