Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 5.29 KB

README.md

File metadata and controls

111 lines (79 loc) · 5.29 KB

WPAA-Coding-Standards


license Tweet for help GitHub stars GitHub followers

WPAA-Coding-Standards
Custom linting and coding standards for WordPress with VSCode.
A FOSS (Free & Open Source Software) project developed by Ahmad Awais.
Follow Ahmad's #FOSS work on GitHub @AhmadAwais — Say Hi on Twitter @MrAhmadAwais👋

# Custom WordPress Coding Standards by Ahmad Awais

Custom linting and coding standards for WordPress with VSCode.

Start

GETTING STARTED!

For having these standards you need to install a couple of things like Composer, PHPCS, WordPress Coding Standards. Run the following commands.

# Make ~/bin dir.
cd ~ && mkdir -p bin && cd bin

# Download Composer.
curl -s http://getcomposer.org/installer | php

# Clone PHPCS, WPCS, and this repo.
git clone https://github.com/squizlabs/PHP_CodeSniffer.git phpcs
git clone -b master https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs
git clone https://github.com/ahmadawais/wpaa-coding-standards.git wpaa

# Install composer, phpcs, and phpcbf.
sudo ln -s ~/bin/composer.phar /usr/local/bin/composer
sudo ln -s ~/bin/phpcs/bin/phpcs /usr/local/bin/phpcs
sudo ln -s ~/bin/phpcs/bin/phpcbf /usr/local/bin/phpcbf

# Set phpcs configuration for wpcs and wpaa.
phpcs --config-set installed_paths /Users/$USER/bin/wpaa/WPAA,/Users/$USER/bin/wpcs

And then go to VSCode, install phpcs extension and then go to settings + , and add the following settings. Finally reload.

// Setting for phpcs.
"phpcs.executablePath": "/usr/local/bin/phpcs",
"phpcs.standard": "WPAA",

Hello, we're TheDevCouple!

I (Ahmad Awais) am a Full Stack Web Developer and a regular core contributor at WordPress. My significant other (Maedah Batool) is a Technical Project Manager, and she's also a WordPress Core Contributor. Together with our team, we run the TheDevCouple.com.

If you'd like to get insights into our love for open source software, professional full stack development, WordPress community, the growth of JavaScript or growing a family, building, and bootstrapping a business, then subscribe to our premium newsletter called ↣ The WordPress Takeaway!

If you'd like us to keep producing professional free and open source software (FOSS). Consider paying for an hour of my dev-time. We'll spend two hours on open source for each contribution. Yeah, that's right, you pay for one hour and get both of us to spend an hour as a thank you.


Thanks

License & Attribution

MIT © Ahmad Awais. Thanks to Composer, PHP/WordPress/WDS Coding Standards.



For anything else, tweet at @MrAhmadAwais

I have released a video course to help you become a better developer — Become a VSCode Power User →



VSCode

VSCode Power User Course →