👁 Logo

EasyCodingStandard for Visual Studio Code

👁 PR Welcome
👁 Build Status
👁 Code Coverage
👁 GitHub release
👁 Semantic Release
👁 GitHub license

The Easiest Way to Use Any Coding Standard 🐘

Visual Studio Code extension to format and lint your PHP code using EasyCodingStandard.

Features

• Use PHP-CS-Fixer | PHP_CodeSniffer - anything you like
• Next run under few seconds with caching
• Skipping files for specific checkers
• Prepared checker sets - PSR2, PSR12, Symfony, Common, Symplify and more...

Are you already using another tool?

• How to Migrate From PHP_CodeSniffer to EasyCodingStandard in 7 Steps
• How to Migrate From PHP-CS-Fixer to EasyCodingStandard in 6 Steps

Requirements

This extension depends on Symplify/EasyCodingStandard to be installed locally in the project or globally by specifying configPath in the settings.

Usage

Using Command Palette (CMD/CTRL + Shift + P)

1. CMD/CTRL + Shift + P -> EasyCodingStandard

Extension Settings

By the default configPath takes precedence over ruleSet.

• ecs.executablePath - The path to the EasyCodingStandard executable. Default: vendor/bin/ecs
• ecs.configPath - The path to the configuration file. Default: easy-coding-standard.yml
• ecs.ruleSet - A prepared ruleset to use. Default: psr2

Issues

An issue can occur either from vscode extension or from EasyCodingStandard. Please manually verify where the issue originates by using the EasyCodingStandard CLI and file a request accordingly.

• VSCode EasyCodingStandard Issue
• EasyCodingStandard Issue

Contributing

CONTRIBUTING

Style guide

Prettier (default settings) is used to maintain formatting. TSLint for linting. Each commit is automatically processed by using a git hook via lint-staged and husky.

Tests

Testing is done with the help of jest and jest-extended.

# Test commands:

# Install necessary testing dependencies
npm run test:install

# Run all tests
npm run test

# Run in watch mode
npm run test -- --watch

# Create a coverage report
npm run test:coverage

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Release Notes

CHANGELOG

Licensing

MIT