webdevstudios/wds-coding-standards

This package is abandoned and no longer maintained. No replacement package was suggested.

There is no license information available for the latest version (2.0.1) of this package.

In-house linting and coding standards for WebDevStudios

2.0.1 2019-06-21 17:28 UTC

Requires

• squizlabs/php_codesniffer: 3.3.1
• wp-coding-standards/wpcs: 2.1.0

Unknown License

README

WebDevStudios in-house linting and coding standards for your favorite editor.

Leadership

• Aubrey Portwood (Senior BED Developer)
  • Writes & Integrates Coding Standards/Maintains Standards
• Greg Rickaby (Director of Engineering)
  • High level Approval / Leadership

How to Install

Simply grab a cup of ☕  and follow directions here.

Want to Contribute?

Please see CONTRIBUTING.md.

Changelog

2.0.1

• Fixes issue where getFilename error happening in latest eslint ^PR

2.0.0

PHPCS Upgrade Guide: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Version-3.0-Upgrade-Guide

This release updates to the new WPCS ^2.x.

• Reworked all our custom sniffs to use new PHP_CodeSniffer structure ^a210b73

1.2.0

• WordPress Coding Standards update to 1.2.1
• PHPCS 3.3.2 installed via composer
• Docblocks are required on function assignments in JS (see release notes)
• @author is suggested in docblocks in both PHP & JS (see release notes)
• Documented @return on abstract methods will no longer show a warning about missing @return

Release Notes

This installation requires you to do an additional step to get eslint to work:

npm install -g "/path/to/WebDevStudios/eslint-plugin-webdevstudios"

This will install the additional ES Lint rules we've added via eslint-plugin-webdevstudios/* which are now going to be required to have custom ES Lint rules.

1.1.1

• WDSCS now requires WPCS 0.14.1 #34; props @jrfoell
• @since is now a warning #39
• @since will not show a warning for files in wp-content/themes/** #39

1.1.0

• @return and @since rules are in place #27
• Find VIM PHPCS configuration here #28
• Brings over eslint rules from wd_s and improves them to be more like old jshint rules from WordPress.org coding standards #10 #22
• How to vote is clearer in CONTRIBUTING.md #32
• Sass linting added #26

This release brings most of WDS up to par with our currently-established coding standards, of which have been missing from our linting thus-far. Props for this release go to @aubreypwd, @gregrickaby, @JayWood, @jrfoell, and @phatsk for all their helpful work!

1.0.1

• Changed WebDevStudios-phpcs to just WebDevStudios for compatibility with namespaces and new sniffs added later #12
• Inclusion of the WordPress-Docs ruleset

Note, this release breaks some things. When you update to this version, you will need to update your coding standard to WebDevStudios vs the old WebDevStudios-phpcs which should no longer work.

1.0.0

• Initial ruleset based on WordPress-Extra