Skip to content

Commit 06f5037

Browse files
authored
Add links to issues in the 3.0.0RC4, 3.0.0RC3, 3.0.0RC2, 3.0.0RC1 and 3.0.0a1 sections of the changelog (#388)
Also fixed a few typos.
1 parent 9905515 commit 06f5037

File tree

1 file changed

+46
-22
lines changed

1 file changed

+46
-22
lines changed

CHANGELOG.md

Lines changed: 46 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2649,20 +2649,23 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
26492649
- Includes all changes from the 2.8.1 release
26502650

26512651
### Fixed
2652-
- Fixed bug #1333 : The new autoloader breaks some frameworks with custom autoloaders
2653-
- Fixed bug #1334 : Undefined offset when explaining standard with custom sniffs
2652+
- Fixed bug [#1333] : The new autoloader breaks some frameworks with custom autoloaders
2653+
- Fixed bug [#1334] : Undefined offset when explaining standard with custom sniffs
2654+
2655+
[#1333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1333
2656+
[#1334]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1334
26542657

26552658
## [3.0.0RC3] - 2017-02-02
26562659
### Changed
26572660
- Added support for ES6 class declarations
26582661
- Previously, these class were tokenized as JS objects but are now tokenized as normal T_CLASS structures
26592662
- Added support for ES6 method declarations, where the "function" keyword is not used
2660-
- Previously, these methods were tokenized as JS objects (fixes bug #1251)
2663+
- Previously, these methods were tokenized as JS objects (fixes bug [#1251])
26612664
- The name of the ES6 method is now assigned the T_FUNCTION keyword and treated like a normal function
2662-
- Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function"
2665+
- Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function"
26632666
- Check the contents of the token first, or use $phpcsFile->getDeclarationName($stackPtr) if you just want its name
26642667
- There is no change for custom sniffs that only check PHP code
2665-
- PHPCBF exit codes have been changed so they are now more useful (request #1270)
2668+
- PHPCBF exit codes have been changed so they are now more useful (request [#1270])
26662669
- Exit code 0 is now used to indicate that no fixable errors were found, and so nothing was fixed
26672670
- Exit code 1 is now used to indicate that all fixable errors were fixed correctly
26682671
- Exit code 2 is now used to indicate that PHPCBF failed to fix some of the fixable errors it found
@@ -2674,26 +2677,35 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
26742677
- Fixed an issue where excluding a file using a @codingStandardsIgnoreFile comment would produce errors
26752678
- For PHPCS, it would show empty files being processed
26762679
- For PHPCBF, it would produce a PHP error
2677-
- Fixed bug #1233 : Can't set config data inside ruleset.xml file
2678-
- Fixed bug #1241 : CodeSniffer.conf not working with 3.x PHAR file
2680+
- Fixed bug [#1233] : Can't set config data inside ruleset.xml file
2681+
- Fixed bug [#1241] : CodeSniffer.conf not working with 3.x PHAR file
2682+
2683+
[#1233]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1233
2684+
[#1241]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1241
2685+
[#1251]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1251
2686+
[#1270]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1270
26792687

26802688
## [3.0.0RC2] - 2016-11-30
26812689
### Changed
26822690
- Made the Runner class easier to use with wrapper scripts
2683-
- Full usage information is no longer printed when a usage error is encountered (request #1186)
2691+
- Full usage information is no longer printed when a usage error is encountered (request [#1186])
26842692
- Makes it a lot easier to find and read the error message that was printed
26852693
- Includes all changes from the 2.7.1 release
26862694

26872695
### Fixed
26882696
- Fixed an undefined var name error that could be produced while running PHPCBF
2689-
- Fixed bug #1167 : 3.0.0RC1 PHAR does not work with PEAR standard
2690-
- Fixed bug #1208 : Excluding files doesn't work when using STDIN with a filename specified
2697+
- Fixed bug [#1167] : 3.0.0RC1 PHAR does not work with PEAR standard
2698+
- Fixed bug [#1208] : Excluding files doesn't work when using STDIN with a filename specified
2699+
2700+
[#1167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1167
2701+
[#1186]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1186
2702+
[#1208]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1208
26912703

26922704
## [3.0.0RC1] - 2016-09-02
26932705
### Changed
26942706
- Progress output now shows E and W in green when a file has fixable errors or warnings
26952707
- Only supported if colors are enabled
2696-
- PHPCBF no longer produces verbose output by default (request #699)
2708+
- PHPCBF no longer produces verbose output by default (request [#699])
26972709
- Use the -v command line argument to show verbose fixing output
26982710
- Use the -q command line argument to disable verbose information if enabled by default
26992711
- PHPBF now prints a summary report after fixing files
@@ -2708,24 +2720,26 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27082720
### Fixed
27092721
- Fixed shell error appearing on some systems when trying to find executable paths
27102722

2723+
[#699]: https://github.com/squizlabs/PHP_CodeSniffer/issues/699
2724+
27112725
## [3.0.0a1] - 2016-07-20
27122726
### Changed
27132727
- Min PHP version increased from 5.1.2 to 5.4.0
2714-
- Added optional caching of results between runs (request #530)
2728+
- Added optional caching of results between runs (request [#530])
27152729
- Enable the cache by using the --cache command line argument
27162730
- If you want the cache file written somewhere specific, use --cache=/path/to/cacheFile
27172731
- Use the command "phpcs --config-set cache true" to turn caching on by default
27182732
- Use the --no-cache command line argument to disable caching if it is being turned on automatically
2719-
- Add support for checking file in parallel (request #421)
2733+
- Add support for checking file in parallel (request [#421])
27202734
- Tell PHPCS how many files to check at once using the --parallel command line argument
27212735
- To check 100 files at once, using --parallel=100
27222736
- To disable parallel checking if it is being turned on automatically, use --parallel=1
27232737
- Requires PHP to be compiled with the PCNTL package
2724-
- The default encoding has been changed from iso-8859-1 to utf-8 (request #760)
2738+
- The default encoding has been changed from iso-8859-1 to utf-8 (request [#760])
27252739
- The --encoding command line argument still works, but you no longer have to set it to process files as utf-8
27262740
- If encoding is being set to utf-8 in a ruleset or on the CLI, it can be safely removed
27272741
- If the iconv PHP extension is not installed, standard non-multibyte aware functions will be used
2728-
- Added a new "code" report type to show a code snippet for each error (request #419)
2742+
- Added a new "code" report type to show a code snippet for each error (request [#419])
27292743
- The line containing the error is printed, along with 2 lines above and below it to show context
27302744
- The location of the errors is underlined in the code snippet if you also use --colors
27312745
- Use --report=code to generate this report
@@ -2738,7 +2752,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27382752
- Added support for only checking files that have been locally modified or added in a git repo
27392753
- Use --filter=gitmodified to check these files
27402754
- You still need to give PHPCS a list of files or directories in which to check
2741-
- Added automatic discovery of executable paths (request #571)
2755+
- Added automatic discovery of executable paths (request [#571])
27422756
- Thanks to [Sergei Morozov][@morozov] for the patch
27432757
- You must now pass "-" on the command line to have PHPCS wait for STDIN
27442758
- E.g., phpcs --standard=PSR2 -
@@ -2748,32 +2762,32 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27482762
- This should stop bugs inside sniffs causing infinite loops
27492763
- Also stops invalid reports being produced as errors don't print to the screen directly
27502764
- Sniff codes are no longer optional
2751-
- If a sniff throws and error or a warning, it must specify an internal code for that message
2765+
- If a sniff throws an error or a warning, it must specify an internal code for that message
27522766
- The installed_paths config setting can now point directly to a standard
27532767
- Previously, it had to always point to the directory in which the standard lives
27542768
- Multiple reports can now be specified using the --report command line argument
27552769
- Report types are separated by commas
27562770
- E.g., --report=full,summary,info
27572771
- Previously, you had to use one argument for each report such as --report=full --report=summary --report=info
2758-
- You can now set the severity, message type, and exclude patterns for and entire sniff, category, or standard
2772+
- You can now set the severity, message type, and exclude patterns for an entire sniff, category, or standard
27592773
- Previously, this was only available for a single message
27602774
- You can now include a single sniff code in a ruleset instead of having to include an entire sniff
27612775
- Including a sniff code will automatically exclude all other messages from that sniff
27622776
- If the sniff is already included by an imported standard, set the sniff severity to 0 and include the specific message you want
27632777
- PHPCBF no longer uses patch
27642778
- Files are now always overwritten
27652779
- The --no-patch option has been removed
2766-
- Added a --basepath option to strip a directory from the front of file paths in output (request #470)
2780+
- Added a --basepath option to strip a directory from the front of file paths in output (request [#470])
27672781
- The basepath is absolute or relative to the current directory
27682782
- E.g., to output paths relative to current dir in reports, use --basepath=.
2769-
- Ignore rules are now checked when using STDIN (request #733)
2770-
- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request #656)
2783+
- Ignore rules are now checked when using STDIN (request [#733])
2784+
- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request [#656])
27712785
- This is the exact opposite of the exclude-pattern tag
27722786
- This option is only usable within sniffs, not globally like exclude-patterns are
27732787
- Added a new -m option to stop error messages from being recorded, which saves a lot of memory
27742788
- PHPCBF always uses this setting to reduce memory as it never outputs error messages
27752789
- Setting the $recordErrors member var inside custom report classes is no longer supported (use -m instead)
2776-
- Exit code 2 is now used to indicate fixable errors were found (request #930)
2790+
- Exit code 2 is now used to indicate fixable errors were found (request [#930])
27772791
- Exit code 3 is now used for general script execution errors
27782792
- Exit code 1 is used to indicate that coding standard errors were found, but none are fixable
27792793
- Exit code 0 is unchanged and continues to mean no coding standard errors found
@@ -2785,6 +2799,16 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27852799
- The included SVN pre-commit hook has been removed
27862800
- Hooks for version control systems will no longer be maintained within the PHPCS project
27872801

2802+
[#419]: https://github.com/squizlabs/PHP_CodeSniffer/issues/419
2803+
[#421]: https://github.com/squizlabs/PHP_CodeSniffer/issues/421
2804+
[#470]: https://github.com/squizlabs/PHP_CodeSniffer/issues/470
2805+
[#530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/530
2806+
[#571]: https://github.com/squizlabs/PHP_CodeSniffer/pull/571
2807+
[#656]: https://github.com/squizlabs/PHP_CodeSniffer/issues/656
2808+
[#733]: https://github.com/squizlabs/PHP_CodeSniffer/issues/733
2809+
[#760]: https://github.com/squizlabs/PHP_CodeSniffer/issues/760
2810+
[#930]: https://github.com/squizlabs/PHP_CodeSniffer/issues/930
2811+
27882812
## [2.9.0] - 2017-05-04
27892813
### Changed
27902814
- Added Generic.Debug.ESLint sniff to run ESLint over JS files and report errors

0 commit comments

Comments
 (0)