codelytv / coding-style
PHP Coding Style rules we use in Codely
Fund package maintenance!
bit.ly/CodelyTvPro
Installs: 7 964
Dependents: 7
Suggesters: 0
Security: 0
Stars: 50
Watchers: 3
Forks: 2
Open Issues: 0
Requires
README
✍️ Codely's Easy Coding Standards configuration
Opinionated linting configuration considering modern PHP best practices and providing consistency. 👌
Take a look, play and have fun with this.
Stars are welcome 😊
👀 How to use
- Install the dependency
composer require --dev codelytv/coding-style
- Add it to your
ecs.php
file:use CodelyTv\CodingStyle; use Symplify\EasyCodingStandard\Config\ECSConfig; return function (ECSConfig $ecsConfig): void { $ecsConfig->paths([__DIR__ . '/src',]); $ecsConfig->sets([CodingStyle::DEFAULT]); // Or this if you prefer to have the code aligned // $ecsConfig->sets([CodingStyle::ALIGNED]); };
- Execute it:
./vendor/bin/ecs check
🤔 What it does
- Lints PHP using PSR-12
- Extends some config (you can see all the rules here)
- Use tabs to indent (reason). If you want to use spaces, you can add the
following line at the end of your
ecs.php
:use Symplify\EasyCodingStandard\ValueObject\Option; $ecsConfig->indentation(Option::INDENTATION_SPACES);
📦 How to release a new version
Simply create a new GitHub Release following semantic versioning.
👌 Codely Code Quality Standards
Publishing this package we are committing ourselves to the following code quality standards:
- 🤝 Respect Semantic Versioning: No breaking changes in patch or minor versions
- 🤏 No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
- 🎯 One specific purpose to meet without having to carry a bunch of unnecessary other utilities
- 📖 Well documented Readme showing how to install and use
- ⚖️ License favoring Open Source and collaboration