Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextcloud-libraries/rector
Rector upgrade rules for Nextcloud
https://github.com/nextcloud-libraries/rector
Last synced: 3 days ago
JSON representation
Rector upgrade rules for Nextcloud
- Host: GitHub
- URL: https://github.com/nextcloud-libraries/rector
- Owner: nextcloud-libraries
- License: agpl-3.0
- Created: 2024-09-10T17:56:59.000Z (17 days ago)
- Default Branch: main
- Last Pushed: 2024-09-20T18:05:24.000Z (7 days ago)
- Last Synced: 2024-09-24T21:34:36.974Z (3 days ago)
- Language: PHP
- Size: 89.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# nextcloud/rector
Rector upgrade rules for Nextcloud
## About
This is a package containing rector rules and sets to use to upgrade your Nextcloud application to the latest API changes.
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 dependency using [Composer](https://getcomposer.org). We recommend to do so in a vendor bin directory along with rector.
``` bash
composer require --dev bamarni/composer-bin-plugin
composer bin rector require rector/rector --dev
composer bin rector require nextcloud/rector --dev
```
## Usage
First generate a rector.php configuration by running `process` command a first time:
```bash
./vendor/bin/rector process
```
We recommend that you first run rector with an empty configuration, commit the result, and then add the sets from Nextcloud
and PHP one by one and commit the rule along with its result each time.
You should stop at the oldest version your application is supporting of both Nextcloud and PHP.
Do not apply a newer set or you might lose compatibility.
Each Nextcloud set includes the older ones so you only need one of them in your configuration.
You could end up with a configuration like this one:
``` php
withPaths([
__DIR__ . '/appinfo',
__DIR__ . '/lib',
__DIR__ . '/tests',
])
->withPhpSets(php81: true)
->withTypeCoverageLevel(0)
->withSets([
NextcloudSets::NEXTCLOUD_30,
]);
```
Make sure that you also have nextcloud/coding-standard setup and to run the code style fixer after rector to fix styling.
## Contributing
Contributions are welcome! To contribute, please familiarize yourself with
[CONTRIBUTING.md](CONTRIBUTING.md).
## Copyright and License
nextcloud/rector is copyright © [Christoph Wurst](https://wuc.me)
and licensed for use under the terms of the
GNU Affero General Public License (AGPL-3.0-or-later) as published by the Free
Software Foundation. Please see [COPYING](COPYING) and [NOTICE](NOTICE) for more
information.