Skip to content

Commit 8176050

Browse files
rodrigoprimojrfnl
authored andcommitted
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 2497a0c commit 8176050

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
@@ -2751,20 +2751,23 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27512751
- Includes all changes from the 2.8.1 release
27522752

27532753
### Fixed
2754-
- Fixed bug #1333 : The new autoloader breaks some frameworks with custom autoloaders
2755-
- Fixed bug #1334 : Undefined offset when explaining standard with custom sniffs
2754+
- Fixed bug [#1333] : The new autoloader breaks some frameworks with custom autoloaders
2755+
- Fixed bug [#1334] : Undefined offset when explaining standard with custom sniffs
2756+
2757+
[#1333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1333
2758+
[#1334]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1334
27562759

27572760
## [3.0.0RC3] - 2017-02-02
27582761
### Changed
27592762
- Added support for ES6 class declarations
27602763
- Previously, these class were tokenized as JS objects but are now tokenized as normal T_CLASS structures
27612764
- Added support for ES6 method declarations, where the "function" keyword is not used
2762-
- Previously, these methods were tokenized as JS objects (fixes bug #1251)
2765+
- Previously, these methods were tokenized as JS objects (fixes bug [#1251])
27632766
- The name of the ES6 method is now assigned the T_FUNCTION keyword and treated like a normal function
2764-
- Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function"
2767+
- Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function"
27652768
- Check the contents of the token first, or use $phpcsFile->getDeclarationName($stackPtr) if you just want its name
27662769
- There is no change for custom sniffs that only check PHP code
2767-
- PHPCBF exit codes have been changed so they are now more useful (request #1270)
2770+
- PHPCBF exit codes have been changed so they are now more useful (request [#1270])
27682771
- Exit code 0 is now used to indicate that no fixable errors were found, and so nothing was fixed
27692772
- Exit code 1 is now used to indicate that all fixable errors were fixed correctly
27702773
- Exit code 2 is now used to indicate that PHPCBF failed to fix some of the fixable errors it found
@@ -2776,26 +2779,35 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
27762779
- Fixed an issue where excluding a file using a @codingStandardsIgnoreFile comment would produce errors
27772780
- For PHPCS, it would show empty files being processed
27782781
- For PHPCBF, it would produce a PHP error
2779-
- Fixed bug #1233 : Can't set config data inside ruleset.xml file
2780-
- Fixed bug #1241 : CodeSniffer.conf not working with 3.x PHAR file
2782+
- Fixed bug [#1233] : Can't set config data inside ruleset.xml file
2783+
- Fixed bug [#1241] : CodeSniffer.conf not working with 3.x PHAR file
2784+
2785+
[#1233]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1233
2786+
[#1241]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1241
2787+
[#1251]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1251
2788+
[#1270]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1270
27812789

27822790
## [3.0.0RC2] - 2016-11-30
27832791
### Changed
27842792
- Made the Runner class easier to use with wrapper scripts
2785-
- Full usage information is no longer printed when a usage error is encountered (request #1186)
2793+
- Full usage information is no longer printed when a usage error is encountered (request [#1186])
27862794
- Makes it a lot easier to find and read the error message that was printed
27872795
- Includes all changes from the 2.7.1 release
27882796

27892797
### Fixed
27902798
- Fixed an undefined var name error that could be produced while running PHPCBF
2791-
- Fixed bug #1167 : 3.0.0RC1 PHAR does not work with PEAR standard
2792-
- Fixed bug #1208 : Excluding files doesn't work when using STDIN with a filename specified
2799+
- Fixed bug [#1167] : 3.0.0RC1 PHAR does not work with PEAR standard
2800+
- Fixed bug [#1208] : Excluding files doesn't work when using STDIN with a filename specified
2801+
2802+
[#1167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1167
2803+
[#1186]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1186
2804+
[#1208]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1208
27932805

27942806
## [3.0.0RC1] - 2016-09-02
27952807
### Changed
27962808
- Progress output now shows E and W in green when a file has fixable errors or warnings
27972809
- Only supported if colors are enabled
2798-
- PHPCBF no longer produces verbose output by default (request #699)
2810+
- PHPCBF no longer produces verbose output by default (request [#699])
27992811
- Use the -v command line argument to show verbose fixing output
28002812
- Use the -q command line argument to disable verbose information if enabled by default
28012813
- PHPBF now prints a summary report after fixing files
@@ -2810,24 +2822,26 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
28102822
### Fixed
28112823
- Fixed shell error appearing on some systems when trying to find executable paths
28122824

2825+
[#699]: https://github.com/squizlabs/PHP_CodeSniffer/issues/699
2826+
28132827
## [3.0.0a1] - 2016-07-20
28142828
### Changed
28152829
- Min PHP version increased from 5.1.2 to 5.4.0
2816-
- Added optional caching of results between runs (request #530)
2830+
- Added optional caching of results between runs (request [#530])
28172831
- Enable the cache by using the --cache command line argument
28182832
- If you want the cache file written somewhere specific, use --cache=/path/to/cacheFile
28192833
- Use the command "phpcs --config-set cache true" to turn caching on by default
28202834
- Use the --no-cache command line argument to disable caching if it is being turned on automatically
2821-
- Add support for checking file in parallel (request #421)
2835+
- Add support for checking file in parallel (request [#421])
28222836
- Tell PHPCS how many files to check at once using the --parallel command line argument
28232837
- To check 100 files at once, using --parallel=100
28242838
- To disable parallel checking if it is being turned on automatically, use --parallel=1
28252839
- Requires PHP to be compiled with the PCNTL package
2826-
- The default encoding has been changed from iso-8859-1 to utf-8 (request #760)
2840+
- The default encoding has been changed from iso-8859-1 to utf-8 (request [#760])
28272841
- The --encoding command line argument still works, but you no longer have to set it to process files as utf-8
28282842
- If encoding is being set to utf-8 in a ruleset or on the CLI, it can be safely removed
28292843
- If the iconv PHP extension is not installed, standard non-multibyte aware functions will be used
2830-
- Added a new "code" report type to show a code snippet for each error (request #419)
2844+
- Added a new "code" report type to show a code snippet for each error (request [#419])
28312845
- The line containing the error is printed, along with 2 lines above and below it to show context
28322846
- The location of the errors is underlined in the code snippet if you also use --colors
28332847
- Use --report=code to generate this report
@@ -2840,7 +2854,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
28402854
- Added support for only checking files that have been locally modified or added in a git repo
28412855
- Use --filter=gitmodified to check these files
28422856
- You still need to give PHPCS a list of files or directories in which to check
2843-
- Added automatic discovery of executable paths (request #571)
2857+
- Added automatic discovery of executable paths (request [#571])
28442858
- Thanks to [Sergei Morozov][@morozov] for the patch
28452859
- You must now pass "-" on the command line to have PHPCS wait for STDIN
28462860
- E.g., phpcs --standard=PSR2 -
@@ -2850,32 +2864,32 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
28502864
- This should stop bugs inside sniffs causing infinite loops
28512865
- Also stops invalid reports being produced as errors don't print to the screen directly
28522866
- Sniff codes are no longer optional
2853-
- If a sniff throws and error or a warning, it must specify an internal code for that message
2867+
- If a sniff throws an error or a warning, it must specify an internal code for that message
28542868
- The installed_paths config setting can now point directly to a standard
28552869
- Previously, it had to always point to the directory in which the standard lives
28562870
- Multiple reports can now be specified using the --report command line argument
28572871
- Report types are separated by commas
28582872
- E.g., --report=full,summary,info
28592873
- Previously, you had to use one argument for each report such as --report=full --report=summary --report=info
2860-
- You can now set the severity, message type, and exclude patterns for and entire sniff, category, or standard
2874+
- You can now set the severity, message type, and exclude patterns for an entire sniff, category, or standard
28612875
- Previously, this was only available for a single message
28622876
- You can now include a single sniff code in a ruleset instead of having to include an entire sniff
28632877
- Including a sniff code will automatically exclude all other messages from that sniff
28642878
- If the sniff is already included by an imported standard, set the sniff severity to 0 and include the specific message you want
28652879
- PHPCBF no longer uses patch
28662880
- Files are now always overwritten
28672881
- The --no-patch option has been removed
2868-
- Added a --basepath option to strip a directory from the front of file paths in output (request #470)
2882+
- Added a --basepath option to strip a directory from the front of file paths in output (request [#470])
28692883
- The basepath is absolute or relative to the current directory
28702884
- E.g., to output paths relative to current dir in reports, use --basepath=.
2871-
- Ignore rules are now checked when using STDIN (request #733)
2872-
- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request #656)
2885+
- Ignore rules are now checked when using STDIN (request [#733])
2886+
- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request [#656])
28732887
- This is the exact opposite of the exclude-pattern tag
28742888
- This option is only usable within sniffs, not globally like exclude-patterns are
28752889
- Added a new -m option to stop error messages from being recorded, which saves a lot of memory
28762890
- PHPCBF always uses this setting to reduce memory as it never outputs error messages
28772891
- Setting the $recordErrors member var inside custom report classes is no longer supported (use -m instead)
2878-
- Exit code 2 is now used to indicate fixable errors were found (request #930)
2892+
- Exit code 2 is now used to indicate fixable errors were found (request [#930])
28792893
- Exit code 3 is now used for general script execution errors
28802894
- Exit code 1 is used to indicate that coding standard errors were found, but none are fixable
28812895
- Exit code 0 is unchanged and continues to mean no coding standard errors found
@@ -2887,6 +2901,16 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
28872901
- The included SVN pre-commit hook has been removed
28882902
- Hooks for version control systems will no longer be maintained within the PHPCS project
28892903

2904+
[#419]: https://github.com/squizlabs/PHP_CodeSniffer/issues/419
2905+
[#421]: https://github.com/squizlabs/PHP_CodeSniffer/issues/421
2906+
[#470]: https://github.com/squizlabs/PHP_CodeSniffer/issues/470
2907+
[#530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/530
2908+
[#571]: https://github.com/squizlabs/PHP_CodeSniffer/pull/571
2909+
[#656]: https://github.com/squizlabs/PHP_CodeSniffer/issues/656
2910+
[#733]: https://github.com/squizlabs/PHP_CodeSniffer/issues/733
2911+
[#760]: https://github.com/squizlabs/PHP_CodeSniffer/issues/760
2912+
[#930]: https://github.com/squizlabs/PHP_CodeSniffer/issues/930
2913+
28902914
## [2.9.0] - 2017-05-04
28912915
### Changed
28922916
- Added Generic.Debug.ESLint sniff to run ESLint over JS files and report errors

0 commit comments

Comments
 (0)