Commit graph

95 commits

Author SHA1 Message Date
Ramona Morea
2241bc902d
Update README.md 2017-12-07 22:07:10 +02:00
jrfnl
130c0b9833 Changelog/Readme/Contributing: Use the correct parent package name.
Also: clarify why suggested dependency minimum requirement got bumped (changelog 0.14.0)
2017-11-01 15:20:44 +01:00
jrfnl
e2b10b3f99 Readme: fix markdown for a link 2017-10-24 02:39:33 +02:00
Mikael Korpela
2a81b2d2b1 Fix markdown link at README.md 2017-09-25 21:37:55 +03:00
Thorsten Frommen
ac3e7d1038 Bump version constraint. 2017-09-24 01:34:57 +02:00
Jared Atchison
1a18cfd3bb Clarify Atom instructions 2017-08-04 10:27:41 -05:00
Jared Atchison
591290e48c Update README.md to include Atom setup tips
Give readers a heads up that the tab width needs to be explicitly changed in the package settings and that certain config options may present problems.
2017-08-04 09:10:57 -05:00
jrfnl
76b4e1bb36 Fix the version recommendation 2017-08-02 00:00:02 +02:00
jrfnl
4f41c4b282 Explicitly recommend v0.4.1+ of the DealerDirect Composer plugin
Version 0.4.0 of the DealerDirect Composer plugin registers each standard individually as if they were root-directory standards, not a collection of standards which exposes a bug in PHPCS 3.x.

Refs:
* squizlabs/PHP_CodeSniffer/pull/1581
* DealerDirect/phpcodesniffer-composer-installer/issues/33
2017-08-01 17:14:40 +02:00
jrfnl
e4c86d718c Adjust the URL to the contributing file where relevant 2017-07-27 15:39:54 +02:00
Barry Ceelen
cdd8a7e0e0 Update .travis.yml example 2017-07-25 12:34:00 +02:00
Gary Jones
d3e8ba7b6b Merge pull request #1055 from WordPress-Coding-Standards/feature/readme-textual-improvements
Minor textual improvements to the Readme.md document
2017-07-25 09:18:39 +01:00
jrfnl
96dc7d0c1c 📚 Minor textual improvements to the Readme.md document
While updating the text in the `Readme.md` document regarding the PHPCS 3.x compatibility, I noticed some more room for improvement.
2017-07-25 03:14:41 +02:00
jrfnl
6f42270e1b 📚 Readme: Update the example output
... to reflect the current state of the `wp-load.php` file in combination with the current WPCS sniffs.
2017-07-25 02:22:13 +02:00
jrfnl
3070fb27f4 PHPCS 3.x compat: Update readme, build script and config files
Travis:
* No longer test the build against PHP 5.2.
* Only test against PHP 5.3 icw PHPCS 2.x.
* Test all other PHP versions against both PHPCS 2.x as well as `master` (3.x).
* Test the build against PHPCS 3.x using the `master` branch.
* Removed allowance for build failures against `master`.
* Adjusted phpunit command to allow for testing on both PHPCS 2.x as well as 3.x.

Composer:
* Add the minimum required PHP version.
* Make the PHPCS requirement more specific and allow for PHPCS 3.x.

"Own" PHPCS custom ruleset:
* Enforce PSR1 namespaces.

Readme:
* Adjusted (minimum) requirements information.
* Updated installation instructions.
* Updated travis example code.

Contributing
* Updated unit test instructions.
* Updated example sniff code.
* Removed reference to potentially upstreaming WPCS to PHPCS as reason for using the PHPCS unit test suite. Let's be fair: the sniffs ought to be unit tested anyway, no matter what.
* Update unit testing conventions example. The example was referring to a now deprecated sniff, so selected another sniff for the example code.
2017-07-24 17:57:20 +02:00
Gary Jones
3d376d3cfc Docs: Update for example ruleset filename change
See #1028
2017-07-14 12:37:28 +01:00
Weston Ruter
4f415c0941 Fix markdown syntax for Travis CI link in readme TOC 2017-07-04 15:58:13 -07:00
J.D. Grimes
3d15aa6437 Merge pull request #855 from evilebottnawi/patch-1
Support phpcodesniffer-composer-installer for easy integrate code style
2017-06-30 08:31:08 -04:00
Gary Jones
146666b448 Merge pull request #1011 from dixitadusara/Fix-changes
Fix README.md Text changes
2017-06-30 11:38:37 +01:00
dixitadusara
848b7d84ee Fixed text as per suggestion 2017-06-30 14:57:28 +05:30
dixitadusara
e94726729f Fix README.md Text changes 2017-06-30 10:53:42 +05:30
jrfnl
e986171c4a Composer: suggest composer plugin & update README
Fixes the open actions for PR 855.
2017-06-30 00:58:55 +02:00
dixitadusara
36dd200050 Fix Project history content minor changes in README.md file 2017-06-29 19:04:17 +05:30
jrfnl
4e62faea8b Up PHPCS minimum requirement to take advantage of improved token arrays.
PHPCS 2.9.0 contains a new `PHP_CodeSniffer_Tokens::$textStringTokens` array as well as several other improvements to some of the predefined arrays in `PHP_CodeSniffer_Tokens` which are being used by WPCS.

It therefore makes sense to take advantage of these upstream improvements to automatically improve the results of our sniffing.

In two places, replacing an existing manually created array with the new `PHP_CodeSniffer_Tokens::$textStringTokens` array means that the `T_INLINE_HTML` token is added to the array.
For both instances, the code has been reviewed and it was determined that the `T_INLINE_HTML` token can never be encountered there anyway as both examine function calls, so this should not cause any issues.

Includes some extra unit tests.

Note: in some unit tests the `??=` syntax is being used. This is a new syntax which is expected to be introduced in PHP 7.2.
The RFC for this has been approved, though the actual change has not been merged yet into PHP itself. All the same, PHPCS already accounts for it, so we may as well test that it does so correctly.
2017-05-04 05:23:46 +02:00
Weston Ruter
c4db415f63 Flesh out explanation of phpcs.xml (#932)
Flesh out explanation of phpcs.xml

Include link to PHPCS docs
2017-04-16 06:18:50 +02:00
jrfnl
67cd011382 📚 README: Add information about setting the installed_path via the ruleset.
This option is available since PHPCS 2.6.0 and as the minimum required PHPCS version for WPCS > 2.6.0, we can safely mention this in the readme.
2017-04-15 22:43:28 +02:00
Michael Torbert
8998036534 Update PHPStorm link.
The old link 404ed.
2017-03-24 15:13:07 -04:00
jrfnl
bb84ca02fc Change wording used in the requirements sections of the README. 2017-03-02 12:40:59 +01:00
jrfnl
0f0c58273a Up the minimum PHPCS version to 2.8.1
PHPCS 2.8.1 has just been released and contains a fix for security vulnerability.
2017-03-02 08:18:07 +01:00
jrfnl
efbe25443e Update README and CONTRIBUTING regarding the new properties wiki page. 2017-02-25 20:56:18 +01:00
jrfnl
c09c0b83d8 Add note about minimum PHP version to the readme 2017-02-11 02:04:17 -05:00
Weston Ruter
c254661f97 Update project history 2017-02-01 09:47:17 -08:00
jrfnl
6c4130e072 Add a TOC to the readme and move rulesets info up
* Add a table of contents to the readme which has become quite long.
   Auto-generated with: http://ecotrust-canada.github.io/markdown-toc/ and then manually tweaked a little
* Add extra header and indent subheader for rulesets section
* Move the rulesets section up, as it was - by now - quite far down what with all the information on the different integrations
2016-12-28 21:59:23 +01:00
Juliette
5083cd963b Add section about integration with CI tools to the Readme. (#753)
For now, it only covers running WPCS on Travis without using Composer.
2016-12-28 20:07:02 +00:00
Gary Jones
50290180c1 Merge pull request #741 from grappler/feature/subsets
Improve documentation on subsets
2016-12-26 21:12:32 +00:00
jrfnl
b6757343e1 Make the minimum PHPCS requirements more explicit.
This adds a `Requirements` section to the Readme.
2016-12-25 12:45:49 +01:00
Ulrich Pogson
f2fffce54c Improve documention on subsets 2016-12-24 21:11:26 +01:00
jrfnl
46d8215c19 Add link to tutorial about using PHPCS + WPCS in Visual Studio to the readme.
Fixes #732
2016-12-23 23:59:38 +01:00
Andrey Savchenko
3178c95751 Removed dev-master from installation instructions
Modern Composer versions will magically pick up latest stable release
2016-12-12 18:32:53 +02:00
Andrey Savchenko
b3c41f7f15 Added downloads count badge to readme. 2016-11-21 21:57:31 +02:00
jrfnl
43d69498d9 Add some additional relevant information about running the PHPCompatibility sniffs. 2016-08-25 16:37:25 +02:00
jrfnl
22e427c551 Update the readme file.
* Update the sniff output example (run against core, extra and docs, not vip)
* Added section about PHPCompatibility sniffs
* Added reference to the wiki
2016-07-18 15:43:31 +02:00
Cory Simmons
882ff3a8f6 Update README.md 2016-02-10 06:44:30 -05:00
Cory Simmons
94c0030445 Add Atom Linter instructions to README
🌈 Hope you like pictures! 🌈
2016-02-02 00:17:06 -05:00
John Blackbourn
bb3e03d8b1 Add brief docs for running WPCS in Sublime Text 2015-09-10 00:07:43 +02:00
Weston Ruter
693f808fdd Update maintainers to include JDGrimes and GaryJones 2015-08-30 17:06:16 -07:00
Andrey Savchenko
c5215e4d7b Clarified ruleset nesting in readme
Rewrote "Standards subsets" section in readme:

 - added new `WordPress-Docs` subset
 - made list nesting reflect actual nesting structure
 - reworded for shorter and more uniform descriptions
2015-06-04 13:17:13 +03:00
Weston Ruter
02bc38e662 Add another concise set of commands to install phpcs and wpcs 2015-05-16 17:05:15 -07:00
J.D. Grimes
ac54d6ab2d Update comment about required phpcs version
See https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/pull/378#issuecomment-98499800.
2015-05-07 09:52:36 -04:00
Weston Ruter
8643176154 Fix link to PhpStorm instructions 2015-03-20 11:50:55 +11:00