Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
owenvoke committed Oct 9, 2023
1 parent bd64f13 commit 4cdfac8
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Worksomes Coding Style

[![Latest Stable Version](https://img.shields.io/packagist/v/worksome/coding-style?style=flat-square)](https://packagist.org/packages/worksome/coding-style)
[![Total Downloads](https://img.shields.io/packagist/dt/worksome/coding-style?style=flat-square)](https://packagist.org/packages/worksome/coding-style)
[![Latest Unstable Version](https://img.shields.io/badge/unstable-dev--main-orange?style=flat-square)](https://packagist.org/packages/worksome/coding-style#dev-main)
[![License](https://img.shields.io/packagist/l/worksome/coding-style?style=flat-square)](https://packagist.org/packages/worksome/coding-style)

# Worksomes Coding Style

This repository contains the coding style followed by Worksome.

It includes configuration for [ECS](https://github.com/symplify/easy-coding-standard), [PHPStan](https://phpstan.org), and [Rector](https://getrector.org).
Expand Down Expand Up @@ -138,7 +138,7 @@ The Worksome code style extends the [PSR-12 base rule set](https://php-fig.org/p

## Custom PHPStan rules

This section will list all the custom PHPStan rules this package adds.
The Worksome code style includes the following custom PHPStan rules.

### Generic

Expand Down Expand Up @@ -184,9 +184,9 @@ This rule will enforce the use of kebab-case for Artisan commands.

This rule will prevent checking the application environment, instead preferring that a driver based approach is used.

## Custom sniffs
## Custom PHP_CodeSniffer sniffs

List all the custom sniffs created by Worksome.
The Worksome code style includes various custom PHP_CodeSniffer sniffs where auto-fixers via PHP CS Fixer are not possible.

### Generic

Expand Down Expand Up @@ -272,6 +272,15 @@ This ensures that all to-do comments are blocked from use. Jira should be used i

This ensures that generics types in PHPDoc comments contain a single space after the comma.

## Custom Rector rules

The Worksome code style includes custom Rector rules for automatically refactoring code.

### [Disallowed Attributes](src/Rector/Generic/DisallowedAttributesRector.php)

This ensures that specified [PHP attributes](https://www.php.net/manual/en/language.attributes.php) are automatically
removed when they are not allowed.

## Credits

- [Worksome](https://github.com/worksome)
Expand Down

0 comments on commit 4cdfac8

Please sign in to comment.