Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smithsonian/drupal-ray-debugger
Drupal module for integrating the Ray debug tool.
https://github.com/smithsonian/drupal-ray-debugger
drupal
Last synced: about 9 hours ago
JSON representation
Drupal module for integrating the Ray debug tool.
- Host: GitHub
- URL: https://github.com/smithsonian/drupal-ray-debugger
- Owner: Smithsonian
- Archived: true
- Created: 2022-04-28T13:10:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-05-02T14:24:00.000Z (over 2 years ago)
- Last Synced: 2024-09-24T23:18:53.428Z (about 13 hours ago)
- Topics: drupal
- Language: PHP
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Drupal Ray Debugger
❗This module has been moved to drupal.org: https://www.drupal.org/project/ray_debugger/
A simple Drupal module for integrating the [Ray Debugging tool](https://myray.app/) for use within a Drupal project.
Ray allows developers to debug code in PHP, Twig, Javascript, and [integrates](https://spatie.be/docs/ray/v1/installation-in-your-project/introduction)
with numerous PHP/JS frameworks and content management systems.
## Install
This module requires installation with [composer](https://getcomposer.org/).
```
composer install smithsonian/ray_debugger
```
:bulb: It's common to include a development module like this using `--require-dev` in composer, or adding the module
to Drupal's `$settings['config_exclude_modules']` setting so the module won't be installed on other environments. Keep
in mind that leftover debug statements in the codebase might result in a fatal error without the module and dependencies
installed
## Requirements
- drupal/core 8.8 or greater
- PHP 7.3 or greater
## Modules
### Ray Debugger
The base module for common libraries.
Example usage in mytheme.theme file:
```php
function mytheme_preprocess_html(&$variables) {
ray($variables)->purple()->label('HTML variables');
}
```
### Ray Debugger Twig
A module that allows you to debug Twig variables using Ray in theme/module Twig files.
Example usage in node.html.twig:
```twig
{{ ray(view_mode, 'label', 'The current View Mode' ) }}
```
### Ray Debugger Javascript
A module that allows you to debug Javascript variables using Ray in theme/module JS files.
Example usage in a custom module javascript library:
```js
Drupal.behaviors.myModule = {
attach: function (context, settings) {
ray(settings);
}
};
```
### Ray Debugger AlpineJS
A module that allows you to debug [alpine.js](https://alpinejs.dev/start-here) using Ray.
Example usage in a Twig template:
```twig
Click me!
```
## Setting up Ray
Setup requires adding a [ray.php](https://spatie.be/docs/ray/v1/configuration/framework-agnostic-php) config file to
your project root.
### Lando
If using [Lando](https://lando.dev/) as a development environment for your Drupal project, you'll want to follow the [docker configuration docs
for Ray](https://spatie.be/docs/ray/v1/environment-specific-configuration/docker), setting up the `ray.php`
[config](https://spatie.be/docs/ray/v1/configuration/framework-agnostic-php) file specific to your `.lando` file
and adding `127.0.0.1 host.docker.internal` to your`/etc/hosts` file.
An example .lando.yml (using the Drupal 9 recipe):
```yaml
name: example-drupal-project
recipe: drupal9
config:
webroot: web
composer_version: '2.2.12'
php: '8.1'
via: nginx
database: mysql:8.0
xdebug: false
services:
appserver:
overrides:
extra_hosts:
- "host.docker.internal:host-gateway" # adding "127.0.0.1 host.docker.internal" to /etc/hosts
```
and the corresponding `ray.php` at the project root:
```php
true,
/*
* The host used to communicate with the Ray app.
*/
'host' => 'host.docker.internal',
/*
* The port number used to communicate with the Ray app.
*/
'port' => 23517,
/*
* Absolute base path for your sites or projects in Homestead, Vagrant, Docker, or another remote development server.
*/
'remote_path' => '/app/web',
/*
* Absolute base path for your sites or projects on your local computer where your IDE or code editor is running on.
*/
'local_path' => '/home/username/example-drupal-project/web',
/*
* When this setting is enabled, the package will not try to format values sent to Ray.
*/
'always_send_raw_values' => false,
];
```
### DDEV
TODO: Document setup with [ddev](https://github.com/drud/ddev/).