Skip to content

Add composer scripts #1120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 29, 2023
Merged

Add composer scripts #1120

merged 2 commits into from
Jun 29, 2023

Conversation

GromNaN
Copy link
Member

@GromNaN GromNaN commented Jun 29, 2023

Ease dev process by adding shortcuts to the common commands.

Also adding me to the authors of the library, not because I've deleted almost as many lines as I've added, but because it's become my full-time activity.

@GromNaN GromNaN requested a review from alcaeus June 29, 2023 09:14
@GromNaN GromNaN force-pushed the composer-scripts branch from 060f3e5 to 4512f99 Compare June 29, 2023 09:15
@GromNaN GromNaN force-pushed the composer-scripts branch from 4512f99 to 4fc4176 Compare June 29, 2023 09:15
Copy link
Member

@alcaeus alcaeus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Highlighting for shell scripts needs to be fixed - the rest LGTM

Copy link
Member

@jmikola jmikola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small feedback but LGTM regardless.

CONTRIBUTING.md Outdated
@@ -47,7 +47,7 @@ By default, the `simple-phpunit` binary chooses the correct PHPUnit version for
the PHP version you are running. To run tests against a specific PHPUnit
version, use the `SYMFONY_PHPUNIT_VERSION` environment variable:

```
```console
$ SYMFONY_PHPUNIT_VERSION=7.5 vendor/bin/simple-phpunit
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I realize this is outside the PR scope, but it's a good opportunity to bump this to a later version. Given https://phpunit.de/supported-versions.html, I don't think anything older than 8.5 would be used in practice.

Alternatively, we can remove this example and just link to https://symfony.com/doc/current/components/phpunit_bridge.html#modified-phpunit-script for canonical documentation.


The library uses [rector](https://getrector.com/) to refactor the code for new features.
To run automatic refactoring, use the `rector` command:

```
```console
$ vendor/bin/rector
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to change this to the fix: or check: command? Or are you intentionally calling the original binary here?

Copy link
Member Author

@GromNaN GromNaN Jun 29, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really hesitated. In the end, I think we should offer the 2 entry points into the document: Composer scripts in the header and the path to the binaries in details.

@GromNaN GromNaN merged commit 8b483f2 into mongodb:master Jun 29, 2023
@GromNaN GromNaN deleted the composer-scripts branch June 29, 2023 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants