https://github.com/brainsum/drupal-dev-tools
Tools for Drupal development.
https://github.com/brainsum/drupal-dev-tools
brainsum code-quality composer composer-plugin developer-tools drupal drupal-8 grumphp grumphp-task
Last synced: 8 months ago
JSON representation
Tools for Drupal development.
- Host: GitHub
- URL: https://github.com/brainsum/drupal-dev-tools
- Owner: brainsum
- Created: 2018-10-30T16:55:55.000Z (about 7 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-12-01T21:44:43.000Z (about 1 year ago)
- Last Synced: 2025-04-12T23:34:41.993Z (8 months ago)
- Topics: brainsum, code-quality, composer, composer-plugin, developer-tools, drupal, drupal-8, grumphp, grumphp-task
- Language: PHP
- Homepage:
- Size: 162 KB
- Stars: 5
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Brainsum dev tools for Drupal 10
[](https://travis-ci.org/brainsum/drupal-dev-tools)
## About
Package / Composer plugin for standardizing development tools.
## Setup
### Preparation
If you already have a ```grumphp.yml``` and/or ```phpcs.xml``` file in your project, you should rename them. E.g. ```mv grumphp.yml grumphp.yml.backup```
If you want to add new tasks and rules on a case-by-case basis, check the files in the ```distfiles``` folder of this package.
Note: This package is not going to overwrite existing ones, but it might not work with them either.
### Installation
In your project, simply use
```composer require --dev brainsum/drupal-dev-tools:^5.0.0```
### Settings
#### Extend
In the ```grumphp.yml``` file in your project, add the following:
```
imports:
- { resource: vendor/brainsum/drupal-dev-tools/convention/grumphp.yml }
```
This will signal grumphp to import everything from this package.
You can customize the rules when needed, too:
```
parameters:
convention.git_commit_message_whitelist: ['/^([A-Z]+-[\d]+ )+\| [A-Za-z\d\s\.]+([^.])+\.{1}$/s']
```
For more information, see:
- [GrumPHP Conventions](https://github.com/phpro/grumphp/blob/master/doc/conventions.md)
#### Override
The files ```grumphp.yml``` and ```phpcs.xml``` should now be created in your project root.
They should be good to go, but you should take a look at them and customize them for the current project as necessary.
E.g, phpcs.xml descriptions, namings, checked folders, etc.; grumphp.yml php version, etc.
If they, for some reason, don't get created, you can copy their contents from the files from ```vendor/brainsum/drupal-dev-tools/distfiles``` as needed.
If you just want to use some settings from ```grumphp.yml```, not the whole thing, see ```convention/grumphp.yml```,
as ```distfiles/grumphp.yml``` is only an import file and doesn't contain any other directives.
## GrumPHP
### Settings
For the pre-defined settings see ```distfiles/grumphp.yml``` and ```convention/grumphp.yml```.
Note, we are also trying to create a ```phpcs.xml``` file in the project root. The source for that file is also in the ```distfiles``` folder.