Skip to content

Drupal Code Quality Checker #287

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Drupal Code Quality Checker #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8762e2d
Require Drupal Code Quality Checker.
Brian-Clement Sep 18, 2019
04eee94
Update README for phpcs, phpcbf.
Brian-Clement Oct 1, 2019
c5b10f1
GrumPHP settings.
Brian-Clement Oct 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ From inside the project root, run:
- `composer install`
- `docker-compose up -d --build`

Visit [midcamp.org.docker.amazee.io](http://midcamp.org.docker.amazee.io) in your browser of choice. At this point you should see a Drupal installation page. See below for Drush commands to install the site.
Visit [midcamp.org.docker.amazee.io](http://midcamp.org.docker.amazee.io) in your browser of choice. At this point you should see a Drupal installation page. See below for Drush commands to install the site.

## How do I work on this?

Expand Down Expand Up @@ -101,8 +101,19 @@ Butler is tool to automate front-end development tasks and streamline prototypin

*Note: When you are deploying, Butler will ask you for your GitHub credentials at least once, possibly multiple times. Enter your own GitHub credentials as prompted.*

## Code Linting

### Patching modules
[GrumPHP](https://github.com/phpro/grumphp) is included for linting and enforcing Drupal code quality standards. This will run on a Git `pre-commit` hook based on the files you are attempting to commit. When you run `git commit -m "My message"` GrumPHP will check your code and potentially prevent you from committing until issues are resolved.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I have... feelings about this... the one other project I'm on that uses pre-commit hooks takes close to a minute to run checks and it's... a pain to work with. I'd much rather run checks in CI, where I don't get yelled at until I'm asking to be, but I'm open to discussion here, as this is definitely a much smaller project and I'd imagine the checks take much less time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm certainly up for further discussion on it, but these don't take much time at all in here at the minute (a few seconds). I would love to have real CI one day...


Additionally, you can run commands directly against files or directories with the following commands:

- `vendor/bin/phpcs --standard=Drupal path/to/something/to/lint`: Runs PHP Code Sniffer. Pass it a file or a directory to inspect.
- `vendor/bin/phpcbf --standard=Drupal path/to/something/to/fix`: Runs PHP Code Beautifier and Fixer. Pass it a file or a directory to fix.

If you need to commit something you know is breaking the rules, you can pass the `-n` or `--no-verify` flag when you commit.


## Patching modules

Sometimes we need to apply patches from the Drupal.org issue queues. These patches should be applied using composer using the [Composer Patches](https://github.com/cweagans/composer-patches) composer plugin.

Expand Down
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@
"drupal/drupal-extension": "^3.1",
"drush/drush": "^8.0",
"palantirnet/palantir-behat-extension": "dev-drupal8-file-revisited",
"phpmd/phpmd": "^2.4"
"phpmd/phpmd": "^2.4",
"vijaycs85/drupal-quality-checker": "^1.0"
},
"conflict": {
"drupal/drupal": "*"
Expand Down
Loading