shineunited/coding-standard

Maintainers

Details

github.com/shineunited/coding-standard

Source

Issues

Installs: 668

Dependents: 9

Suggesters: 0

Security: 0

Stars: 0

Watchers: 5

Forks: 0

Open Issues: 0

Type:phpcodesniffer-standard

1.0.2 2023-04-11 22:09 UTC

Requires

MIT cc90309eebabfa74907849b6428ef53b68a48214

This package is auto-updated.

Last update: 2024-04-12 00:35:59 UTC

README

Coding Standards for Shine United Projects

Core Ruleset

ShineUnited

All projects should include the ShineUnited standard in there codesniffer configuration. This is largly a modification of the PSR12 coding standard.

<rule ref="ShineUnited" />

Additional Rulesets

ShineUnited-RequireTypeHints

Requires all parameters, returns and properties to be type hinted.

<rule ref="ShineUnited-RequireTypeHints" />

ShineUnited-RequireStrictTypes

Requires strict_types=1 to be declared in all php files.

<rule ref="ShineUnited-RequireStrictTypes" />

ShineUnited-RequireComments

Requires comments for files, classes and most functions.

<rule ref="ShineUnitedRequireComments" />