search

shaal / DrupalPod

Start Drupal contributions with 1 click.
https://shaal.github.io/DrupalPod
MIT License
163 stars 54 forks source link

Add improved codesniffer support. #151

Open codebymikey opened 3 months ago

codebymikey commented 3 months ago

The Problem/Issue/Bug

Codesniffer integration is currently not the best, so added tooling as well as ensure that the installed_paths set by dealerdirect/phpcodesniffer-composer-installer isn't unintentionally purged after composer has finished installing the site.

How this PR Solves The Problem

Add tooling for php codesniffer's phpcs and phpcbf scripts - which are useful for ensuring code meets certain standards (and will help with gitpod integrations like PHPStorm, which require the scripts to be present on the "host").

Also ensure that ddev phpcs --config-set installed_paths vendor/drupal/coder/coder_sniffer is no longer accidentally overwritten with our script. I'd probably opt to remove this part of the code in the first place if possible if we already have the composer plugin.

Manual Testing Instructions

phpcs and phpcbf commands should now work with or without the ddev prefix.

phpcs --config-show
ddev phpcs --config-show
phpcbf --config-show
ddev phpcbf --config-show

Related Issue Link(s)

Release/Deployment notes

Summary by CodeRabbit

codesandbox[bot] commented 3 months ago

Review or Edit in CodeSandbox

Open the branch in Web Editor • VS Code • Insiders
Open Preview

coderabbitai[bot] commented 3 months ago

Walkthrough

This update introduces new scripts and modifications to existing ones to improve the handling of PHP_CodeSniffer tools (phpcs and phpcbf) and PHPUnit within a DDEV environment. The changes streamline the setup and execution of these tools, ensuring compatibility with IDEs and enhancing the developer experience in Gitpod and DDEV setups.

Changes

File/Path Change Summary
.ddev/commands/web/phpcbf Added a script to run PHP_CodeSniffer's code beautifier (phpcbf) within DDEV.
.ddev/commands/web/phpcs Introduced a script to run PHP_CodeSniffer's codesniffer tool (phpcs) within DDEV.
.ddev/commands/host/exec_dir Modified argument handling and path references based on environment variables.
.gitpod/drupal/drupalpod-setup/drupalpod-setup.sh Updated phpcs configuration check and setup logic.
.gitpod/utils/env-setup.sh Added commands to run PHPUnit, PHPCS, and PHPCBF inside a DDEV container.
.gitpod/utils/script-templates/ddev-phpcbf.template.sh Added a template script for running phpcbf in a DDEV environment.
.gitpod/utils/script-templates/ddev-phpcs.template.sh Introduced a template script for running phpcs in a DDEV environment.
.gitpod/utils/script-templates/ddev-phpunit.template.sh Added a template script for running PHPUnit in a DDEV environment.

Poem

In the realm of code so neat,
Tools align for a developer's feat.
With phpcs and phpcbf at hand,
DDEV and Gitpod make a stand.
Paths and scripts, all set right,
Bringing joy to coders' sight.
🐰✨ CodeRabbit's delight!

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.