Workspace

The workspace refers to the working directory where Chevere is developed.

IDE

Chevere provides snippets and recommendation on extensions that goes better for development, this includes the provisioning IDE resources.

🧔🏾 The default IDE of choice is Visual Studio Code

Settings

Workspace settings are at .vscode/settings.json

Extensions

• Bracket Pair Colorizer
• Coverage Gutters
• indent-rainbow
• php cs fixer
• PHP Debug
• PHP Intelephense
• PHP Namespace Resolver
• PHPUnit Test Explorer

Snippets

Snippets provide an easy way to define templates for code. It is a productivity tool that allows to rapidly create source code just typing a keyword in the IDE.

👍🏾 Built-in snippets are at .vscode/Templates.code-snippets

Working with Snippets

Snippets are designed to be context-aware, to parse information from the file system. That way, a lot of code can be autocompleted and prompt for easier editing.

In the following two-steps, a new test will be created following the snippets workflow.

Step 1: Create the file

An empty ExampleTest.php file must be created at Tests/Example/ExampleTest.php. The tree should look like as below.

Tests
└── Example
    └── ExampleTest.php

🧙🏾 Example will be implemented in the namespace path and ExampleTest will be taken used as class name.

Step 2: Inserting the snippet

Triggering snippets is easy as typing the snippet prefix in the editor. Alternatively, snippets can be triggered by using the command palette.

The screen below shows triggering test right after typing it, then the test-method snippet is triggered, which prompt to edit method's Name.

Class name and namespace path is automatically resolved by the IDE.

🧙🏾 Header comment and strict_types declaration are automatically formatted on save

Table below shows the prefix and description for built-in snippets.

Prefix	Description
docblock-boolean	Insert a docblock boolean
docblock-construct	Insert a docblock construct
docblock-immutable	Insert a docblock immutable
docblock-instance	Insert a docblock instance
component	Create a component
exception	Create an exception
interface	Create an interface
test-method	Create a test method
test	Create a test
trait	Create a trait

Coding Standards

The coding standard is automatically implemented by extension php cs fixer, which allows to register PHP CS Fixer as formatter.

🧙🏾 Formatting can be configured on save and or typing

Testing

PHPUnit Test Explorer provides inline tools for code execution and reviewing. It allows to easily handle all tests.

Configuration

• phpunit.xml for development purposes
• phpunit-coverage.xml for reporting code coverage

Running tests

vendor/bin/phpunit -c <configuration file>