Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0.10.0 #565

Merged
merged 186 commits into from
Aug 29, 2016
Merged

0.10.0 #565

merged 186 commits into from
Aug 29, 2016

Conversation

westonruter
Copy link
Member

@westonruter westonruter commented May 12, 2016

PR for tracking changes for 0.10.0.

  • Add changelog for 0.10.0
  • Merge PR
  • Add release tag

shadyvb and others added 30 commits December 12, 2013 06:56
🌈 Hope you like pictures! 🌈
Add Atom Linter instructions to README
Explains how to check whether one of our sniffs is the one flagging a piece of code.
Note about some issues coming from upstream
Add SublimeLinter-phpcs installation instructions
Add sniff and tests for concatenation operator spacing
Include PSR2.ControlStructures.ElseIfDeclaration in WordPress-Core
Ensure translatable strings, and string domains are not dynamic
jrfnl and others added 25 commits July 26, 2016 01:26
…issue-628-undefined-offset

Prevent WPCS throwing an "undefined offset" notice during live code …
* Removes similar checks from existing sniffs (PHP.DiscouragedFunctions and VIP.RestrictedFunctions).
* Makes sure that *all* functions in the POSIX extension are covered by this check - they previously were not.
* Add unit tests for the new sniff covering *all* POSIX functions.
…cover-regex-rules

Better cover the regex related rules.
Add (new) sniff for class opening brace on same line to `core` ruleset.
This PR does not add or remove any new rules, it just re-orders the core ruleset to follow the handbook and documents the rules as they are in the handbook - both covered and not covered.

Closes #602

For any core rules which are not yet covered, but *could* possibly *be* covered, a new issue has been opened if one didn't exist already and the link to the issue is included in the ruleset.

Rules included, but not (explicitly) covered in the handbook are listed in their own section at the bottom of the ruleset.

I've made three changes which should be noted:
* Removed the `WordPress.WP.I18n` sniff from the `extra` ruleset as it is included in the `core` ruleset and `core` is included in `extra`.
* Moved the `WordPress.WP.PreparedSQL` sniff from `extra` to `core` as the checks included in that sniff are actually part of the core rules.
* Moved the `Generic.PHP.Syntax` to `extra` as IRL often enough there will be code which will only be loaded for higher PHP versions with a wrapper and fall-backs for lower PHP versions.

Feedback welcome. Review is probably easiest by just looking at the new version of the file as the diff will be horrible ;-)
Travis CI: Upgrade the HHVM job to use Ubuntu Trusty, and a more recent version of HHVM.
Ensure that any sniff with a dependency on an external sniff has a consistent `class_exists()` check and throws an appropriate error message.
Verified that classes which extend a parent actually *use* that parent and if not, removed the `extend`.
If they use the parent, leverage the properties available in the parent and remove duplicate function calls.
…issue-602-reorder-rules-in-ruleset

Order the `core` ruleset according to the handbook.
…consistent-class-exists

Verify extended classes.
* Update the file and class @Package tag and remove the @category tag.

Follow the standard as described in https://www.phpdoc.org/docs/latest/references/phpdoc/tags/package.html

The @category tag is considered deprecated. A hierarchical @Package tag should be used instead.

Ref: https://www.phpdoc.org/docs/latest/references/phpdoc/tags/category.html

* Use correct version number for the newly deprecated classes.

* Fix some - unintentional - parse errors in the test files.

* Attempt to lead by example comment-wise in the unit tests.

Capitalization, punctuation and some spelling.

* Proper capitalization and punctuation for class end comments.

* Remove `//end` comments for methods and conditionals < 35 lines.

* Simplify the test file method doc blocks.

* Various documentation fixes, largely based on PHPCS Docs output.

* Make sure any function which will be passed the $phpcsFile has the right type hint.

But only if it doesn't conflict with upstream function signatures.

* Verify and update the docblocks for all files and classes.

Based on Git file history:

* Add @SInCE tags to all classes.
* Add @SInCE tags to properties and methods if they weren't included from the start.
* Verify/Fix a number of @author tags.
* Remove old/copied over/incorrect PHPCS tags.
* Where necessary improved/corrected the class description.

Also:
* Consistent tag order in class doc blocks.
* Fix tag alignment.
* Remove redundant explanation in unit test class doc blocks.
* Sync the description line of the unit test class doc blocks.

* Add handbook links to a number of sniffs.

* Add reference to upstream sniff a sniff is based upon.

Includes information on when the sniff was last synced with the upstream sniff if applicable and available.

* Add @license tag and @link tag to the WPCS GH repo, to all file level doc blocks.

License tag as per https://www.phpdoc.org/docs/latest/references/phpdoc/tags/license.html

* Add the docs ruleset to the coding standard for WPCS itself.

* Add @SInCE class changelogs for PR #647.

* Fix minor grammar error.

* Updated `@since` tags for `2014-12-11` release to `0.3.0`.

* Re-instate previously removed @SInCE tags.

* Updated based on feedback.

* Adjusted the @Package tags as per discussion in the PR thread
* Removed the @link tag to the handbook at the file level doc block
* Removed the @author tags
…e-readme

Update readme section on PHPCompatibility
Depending on how the tokenized file is build up, any of the methods in the sniff might be called first, so the whitelist should be also be merged (if not done so already) in the other method which uses the whitelist.
The `urlencode` check was checking for `rawurlencode()` instead of `urlencode()` while at the same time advising to use `rawurlencode()`.
The grammer of the error message was incorrect as well.
Both are now fixed.

In the [same commit](e7707b2) as this was introduced, a number of other restricted functions were added, but none of them were accompanied by unit tests.
This is now fixed as well.
…ve-variable-name-whitelisting

Improve VariableName whitelisting for the `ValidVariableName` sniff.
…ncorrect-restricted-function

Fix bug in VIP restricted functions + unit tests
…elog-0.10.0

(Preliminary) Changelog for the 0.10.0 version
@westonruter westonruter added this to the 0.10.0 milestone Aug 29, 2016
@westonruter
Copy link
Member Author

@jrfnl do you want to do the honours?

@jrfnl jrfnl merged commit b394904 into master Aug 29, 2016
@jrfnl
Copy link
Member

jrfnl commented Aug 29, 2016

@westonruter I appreciate the gesture ;-)

@ntwb
Copy link
Member

ntwb commented Aug 30, 2016

Thanks for all the work gone into this release everyone 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.