feat: move all library code to ramsey/composer-repl-lib

ramsey · Jan 18, 2022 · fad2fac · fad2fac
1 parent 91e0403
commit fad2fac
Show file tree

Hide file tree

Showing 38 changed files with 42 additions and 2,088 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,3 @@ updates:
     schedule:
       interval: "monthly"
     versioning-strategy: "increase-if-necessary"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "monthly"
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 1.4.0 - 2022-01-18
+
+### Added
+
+- Nothing.
+
+### Changed
+
+- Move all library code to [ramsey/composer-repl-lib](https://github.com/ramsey/composer-repl-lib). No class names or namespaces have changed, and since this package requires ramsey/composer-repl-lib, there are no BC breaks.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 1.3.0 - 2022-01-02
 
 ### Added

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,8 @@
 # Contributing
 
+ℹ️ _**NOTICE:** First, check out [ramsey/composer-repl-lib](https://github.com/ramsey/composer-repl-lib)
+to decide whether your contribution or bug report is best suited for that library._
+
 Contributions are welcome. This project accepts pull requests on [GitHub][].
 
 This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). By
@@ -72,12 +75,6 @@ When you do begin working on your feature, here are some guidelines to consider:
   We will use this description to update the CHANGELOG. If there is no
   description, or it does not adequately describe your feature, we may ask you
   to update the description.
-* ramsey/composer-repl follows a superset of **[PSR-12 coding standard][psr-12]**.
-  Please ensure your code does, too. _Hint: run `composer dev:lint` to check._
-* Please **write tests** for any new features you add.
-* Please **ensure that tests pass** before submitting your pull request.
-  ramsey/composer-repl automatically runs tests for pull requests. However,
-  running the tests locally will help save time. _Hint: run `composer test`._
 * **Use topic/feature branches.** Please do not ask to pull from your main branch.
   * For more information, see "[Understanding the GitHub flow][gh-flow]."
 * **Submit one feature per pull request.** If you have multiple features you
@@ -107,68 +104,6 @@ Now, you are ready to develop!
 This project uses [CaptainHook](https://github.com/CaptainHookPhp/captainhook)
 to validate all staged changes prior to commit.
 
-### Commands
-
-To see all the commands available for contributing to this project:
-
-``` bash
-composer list dev
-```
-
-### Coding Standards
-
-This project follows a superset of [PSR-12](https://www.php-fig.org/psr/psr-12/)
-coding standards, enforced by [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).
-
-CaptainHook will run coding standards checks before committing.
-
-You may lint the codebase manually using the following commands:
-
-``` bash
-# Lint
-composer dev:lint
-
-# Attempt to auto-fix coding standards issues
-composer dev:lint:fix
-```
-
-### Static Analysis
-
-This project uses a combination of [PHPStan](https://github.com/phpstan/phpstan)
-and [Psalm](https://github.com/vimeo/psalm) to provide static analysis of PHP
-code.
-
-CaptainHook will run static analysis checks before committing.
-
-You may run static analysis manually across the whole codebase with the
-following command:
-
-``` bash
-# Static analysis
-composer dev:analyze
-```
-
-### Project Structure
-
-This project uses [pds/skeleton](https://github.com/php-pds/skeleton) as its
-base folder structure and layout.
-
-### Running Tests
-
-The following must pass before we will accept a pull request. If this does not
-pass, it will result in a complete build failure. Before you can run this, be
-sure to `composer install`.
-
-To run all the tests and coding standards checks, execute the following from the
-command line, while in the project root directory:
-
-```
-composer test
-```
-
-CaptainHook will automatically run all tests before pushing to the remote
-repository.
-
 [github]: https://github.com/ramsey/composer-repl
 [issues]: https://github.com/ramsey/composer-repl/issues
 [pull requests]: https://github.com/ramsey/composer-repl/pulls

diff --git a/LICENSE b/LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2020-2021 Ben Ramsey <[email protected]>
+Copyright (c) 2020-2022 Ben Ramsey <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@
     <a href="https://packagist.org/packages/ramsey/composer-repl"><img src="https://img.shields.io/packagist/v/ramsey/composer-repl.svg?style=flat-square&label=release" alt="Download Package"></a>
     <a href="https://php.net"><img src="https://img.shields.io/packagist/php-v/ramsey/composer-repl.svg?style=flat-square&colorB=%238892BF" alt="PHP Programming Language"></a>
     <a href="https://github.com/ramsey/composer-repl/blob/main/LICENSE"><img src="https://img.shields.io/packagist/l/ramsey/composer-repl.svg?style=flat-square&colorB=darkcyan" alt="Read License"></a>
-    <a href="https://github.com/ramsey/composer-repl/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/workflow/status/ramsey/composer-repl/build/main?style=flat-square&logo=github" alt="Build Status"></a>
-    <a href="https://codecov.io/gh/ramsey/composer-repl"><img src="https://img.shields.io/codecov/c/gh/ramsey/composer-repl?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
-    <a href="https://shepherd.dev/github/ramsey/composer-repl"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fcomposer-repl%2Fcoverage" alt="Psalm Type Coverage"></a>
+    <a href="https://github.com/ramsey/composer-repl-lib/actions/workflows/continuous-integration.yml"><img src="https://img.shields.io/github/workflow/status/ramsey/composer-repl-lib/build/main?style=flat-square&logo=github" alt="Build Status"></a>
+    <a href="https://codecov.io/gh/ramsey/composer-repl-lib"><img src="https://img.shields.io/codecov/c/gh/ramsey/composer-repl-lib?label=codecov&logo=codecov&style=flat-square" alt="Codecov Code Coverage"></a>
+    <a href="https://shepherd.dev/github/ramsey/composer-repl-lib"><img src="https://img.shields.io/endpoint?style=flat-square&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Framsey%2Fcomposer-repl-lib%2Fcoverage" alt="Psalm Type Coverage"></a>
 </p>
 
 ## About
@@ -36,6 +36,9 @@ for WordPress, [CakePHP console](https://book.cakephp.org/3/en/console-and-shell
 and [Yii shell](https://github.com/yiisoft/yii2-shell) are a few of the projects
 using PsySH.
 
+> 💡 You may use this REPL without the Composer plugin functionality by requiring
+> [ramsey/composer-repl-lib](https://github.com/ramsey/composer-repl-lib) instead.
+
 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.
@@ -57,7 +60,7 @@ if you prefer.
 You'll see something similar to this:
 
 ```
-Psy Shell v0.10.8 (PHP 8.0.9 — cli) by Justin Hileman
+Psy Shell v0.11.1 (PHP 8.1.1 — cli) by Justin Hileman
 ------------------------------------------------------------------------
 Welcome to the development console (REPL).
 To learn more about what you can do in PsySH, type `help`.
@@ -95,9 +98,9 @@ Test passed!
 
 >>> phpunit
 
-PHPUnit 9.3.7 by Sebastian Bergmann and contributors.
+PHPUnit 9.5.11 by Sebastian Bergmann and contributors.
 
-Runtime:       PHP 7.4.9
+Runtime:       PHP 8.1.1
 Configuration: /path/to/ramsey/conventional-commits/phpunit.xml.dist
 
 ...............................................................  63 / 221 ( 28%)
@@ -110,7 +113,7 @@ Time: 00:00.064, Memory: 12.00 MB
 OK (221 tests, 484 assertions)
 ```
 
-This implementation of PsySH has Super ElePHPant Powers.
+✨🐘 This implementation of PsySH has Super ElePHPant Powers. 🐘✨
 
 ## Environment Bootstrapping
 
@@ -181,6 +184,6 @@ security issue in software that is maintained in this repository, please read
 
 ## Copyright and License
 
-The ramsey/composer-repl library is copyright © [Ben Ramsey](https://benramsey.com)
+The ramsey/composer-repl plugin 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.