Skip to content

Commit

Permalink
Update the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
benmatselby committed Oct 14, 2023
1 parent 8eb1ae0 commit 3b4adb2
Show file tree
Hide file tree
Showing 2 changed files with 289 additions and 138 deletions.
233 changes: 118 additions & 115 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,261 +1,264 @@
CHANGELOG
=========
# CHANGELOG

## 6.9.0

- Turn on tagging

## 6.8.0

6.8.0
-----
* Enhancement for allowing the configuration to use "~" which will be expanded out to your home directory. Thanks to [Quentin Dreyer](https://github.com/qkdreyer) for the [patch](https://github.com/benmatselby/sublime-phpcs/pull/169)


6.7.0
-----
## 6.7.0

* Enhancement for allowing the definition of a `phpcs.xml` in the root of the project. Thanks to [Jason Madrid](https://github.com/jasonmadrid) for the [patch](https://github.com/benmatselby/sublime-phpcs/pull/161)

6.6.3
-----
## 6.6.3

* Fix for [GH-100](https://github.com/benmatselby/sublime-phpcs/issues/100). Issues when opening Sublime Text when the last file was an image

6.6.2
-----
## 6.6.2

* Fix for [GH-155](https://github.com/benmatselby/sublime-phpcs/issues/155). --runtime-set not working correctly

6.6.1
-----
## 6.6.1

* Fix for [GH-129](https://github.com/benmatselby/sublime-phpcs/issues/129), which is the cbf not showing as enabled.

6.6.0
-----
## 6.6.0

* Support for PHP Code Beautifier and Fixer (phpcbf) [GH-127](https://github.com/benmatselby/sublime-phpcs/issues/127)

6.5.3
-----
## 6.5.3

* Fix for [GH-120](https://github.com/benmatselby/sublime-phpcs/issues/120). Thanks to [Hermann Herz](https://github.com/Heart1010) for raising this.

6.5.2
-----
## 6.5.2

* Fix for [GH-117](https://github.com/benmatselby/sublime-phpcs/issues/117). Thanks to [autumnlansing](https://github.com/autumnlansing) for raising.

6.5.1
-----
## 6.5.1

* Fix for [GH-113](https://github.com/benmatselby/sublime-phpcs/issues/113). Thanks to [Rafael Nascimento](https://github.com/Arcane07) for the patch. PHP-CS-Fixer not reporting outcome

6.5.0
-----
## 6.5.0

* Stylise the icon color [GH-114](https://github.com/benmatselby/sublime-phpcs/issues/114)

6.4.2
-----
## 6.4.2

* Bug fix for switching the coding standard when not using a project.
* Set the default coding standard when the plugin is installed to PSR2.

6.4.1
-----
## 6.4.1

* Bug fix for switching the coding standard. It does not rely on php-cs-fixer path being set

6.4.0
-----
## 6.4.0

* Enhancement [GH-112](https://github.com/benmatselby/sublime-phpcs/issues/112). Ability to toggle the coding standard being used.

6.3.5
-----
## 6.3.5

* Enhancement: Always show php-cs-fixer support in context menu in side bar, just not enabled if php-cs-fixer is not configured [GH-103](https://github.com/benmatselby/sublime-phpcs/issues/103)

6.3.4
-----
## 6.3.4

* Fix for [GH-98](https://github.com/benmatselby/sublime-phpcs/issues/98)

6.3.3
-----
## 6.3.3

* Fix for [GH-93](https://github.com/benmatselby/sublime-phpcs/issues/93). If plugin is off, all sub processes should respect that.
* Fix for [GH-94](https://github.com/benmatselby/sublime-phpcs/issues/94). Thanks to [WaveHack](https://github.com/WaveHack) for raising this and proposing a solution
* Fix for [GH-91](https://github.com/benmatselby/sublime-phpcs/issues/91). Thanks to [Alex Russell](https://github.com/alexrussell) for proposing a solution
* Fix for [GH-85](https://github.com/benmatselby/sublime-phpcs/issues/85). Thanks to [Peter Farsinsen](https://github.com/peterfarsinsen) for this patch

6.3.2
-----
## 6.3.2

* Minor enhancement to provide hint with configuration issue [GH-78](https://github.com/benmatselby/sublime-phpcs/issues/78)

6.3.1
-----
## 6.3.1

* Fix for ST2 which does not like trailing commas in the json. Fixes [GH-75](https://github.com/benmatselby/sublime-phpcs/pull/75)

6.3
---
## 6.3

* Enhancement to toggle via the context menu or command palette if the plugin should execute on save or not [GH-73](https://github.com/benmatselby/sublime-phpcs/issues/73)
* Enhancement to blacklist certain extensions if they form part of the main extensions to execute, the example being twig.php [GH-69](https://github.com/benmatselby/sublime-phpcs/issues/69)

6.2
---
## 6.2

* Enhancement to support per project settings. Thanks to [Handrus Stephan Nogueira](https://github.com/handrus) for the contribution
* Enhancement to reload the settings when changed, so you do not have to restart Sublime Text each time.

6.1
---
## 6.1

* Bug fix for users of ST2 and PHP_CodeSniffer1.5.0 (Currently RC1). Essentially we now need to pass cwd so that PHP_CodeSniffer knows where to put the tmp files for its caching mechanism. Fixes [GH-68](https://github.com/benmatselby/sublime-phpcs/issues/68)

6.0.1
-----
## 6.0.1

* Missed a s/SCheck/scheck/ conversion

6.0
---
## 6.0

* Add support for [scheck](https://github.com/facebook/pfff/wiki/Main). Thanks to [Darby Payne](https://github.com/dpayne) for this patch

5.1.1
-----
## 5.1.1

* Minor patch to scrub the last report so the points and line numbers are correct each time. Fixes GH-67

5.1
---
* Only run commands if the *_run preferences are true. Thanks to [Rys Sommefeldt](https://github.com/rys) for this patch.
## 5.1

* Only run commands if the _run preferences_ are true. Thanks to [Rys Sommefeldt](https://github.com/rys) for this patch.

## 5.0

5.0
---
* Support for Sublime Text 3 [GH-60](https://github.com/benmatselby/sublime-phpcs/issues/60)

4.6.3
-----
## 4.6.3

* Patch to fix [GH-53](https://github.com/benmatselby/sublime-phpcs/issues/53) which was php-cs-fixer executing on save for non plugin based files (e.g. running for a python file). Thanks to [John Hoffmann](https://github.com/jhoffmann) for the solution.
* Minor update to the README to cover off a gotcha on installing php-cs-fixer using Homebrew [GH-52](https://github.com/benmatselby/sublime-phpcs/issues/52)

4.6.2
-----
## 4.6.2

* Small patch to fix [GH-51](https://github.com/benmatselby/sublime-phpcs/issues/51). Thanks to [mstaatz](https://github.com/mstaatz) for raising the issue.

4.6.1
-----
## 4.6.1

* Provided configuration option "phpcs_commands_to_php_prefix" that allows you to distinguish which commands should have the php path prefixed. Thanks to [Hamrani ahmed](https://github.com/ahamrani) for raising [GH-49](https://github.com/benmatselby/sublime-phpcs/issues/49)

4.6
---
## 4.6

* Fixes for windows based users and the use of phar files. Thanks to [Hamrani ahmed](https://github.com/ahamrani) for raising [GH-47](https://github.com/benmatselby/sublime-phpcs/issues/47)
* Moved the options to the end of the php-cs-fixer command as per their documentation examples
* Removed reloading settings code, as it seems redundant in latest build of Sublime Text 2

4.5.1
-----
## 4.5.1

* Minor changes to the README to better explain non package control installation.
* Minor change to README for naming of the plugin
* Minor change to when the "Goto Next Error" context menu is enabled

4.5
---
## 4.5

* Define a setting "php_cs_fixer_show_quick_panel" that stops quick panel displaying for php-cs-fixer. Thanks to [Kevin Perrine](https://github.com/kevinsperrine/) for the pull request

4.4.1
-----
## 4.4.1

* Blank out the default setting for php_cs_fixer_executable_path. Thanks to [Eric Lewis](https://github.com/ericandrewlewis/) for the pull request.

4.4
---
## 4.4

* Provide configuration options for each command to execute on save. Thanks to [Jeremy Romey](https://github.com/jeremyFreeAgent) for the [suggestion](https://github.com/benmatselby/sublime-phpcs/issues/36)

4.3
---
## 4.3

* Ehancement for [GH-34](https://github.com/benmatselby/sublime-phpcs/issues/34) which provides a command to "Goto Next Error" which can also have a shortcut key assigned to it. Thanks to [Casey Becking](https://github.com/caseybecking) for raising the feature request
* Ability to fun PHP-CS-Fixer on save now. Thanks to [Cedric Lombardot](https://github.com/cedriclombardot) for raising the feature request

4.2
---
## 4.2

* Ability to configure if you want the errors to be highlighted in the editor. Thanks to [Aleksandr Gornostal](https://github.com/gornostal)

4.1.1
-----
## 4.1.1

* Small patch to be consistent with the naming of the tools. Thanks to [Beau Simensen](https://github.com/simensen)

4.1
---
## 4.1

* Added support to use php-cs-fixer on a directory in the side bar
* Now displays the php-cs-fixer changes in the quick panel

4.0
---
## 4.0

* Added basic support for [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) based on the work by [Jeremy Romey](https://github.com/jeremyFreeAgent/sublime-php-cs-fixer/)

3.13
----
## 3.13

* Setting to configure if phpcs is run when the plugin is invoked [GH-20](https://github.com/benmatselby/sublime-phpcs/issues/20). Thanks to [grEvenX](https://github.com/grEvenX)

3.12
----
## 3.12

* Bug fix for [GH-18](https://github.com/benmatselby/sublime-phpcs/issues/18) which meant the plugin would fail to work when coming across non ascii characters
* Added a show_debug setting for console output. Off by default

3.11
----
## 3.11

* Support added to configure the php path [GH-16](https://github.com/benmatselby/sublime-phpcs/issues/16). Thanks to [Dan Previte](https://github.com/dprevite)
* Added support for multiple file extensions, rather than using Sublimes syntax checker [GH-15](https://github.com/benmatselby/sublime-phpcs/issues/15)

3.10
----
## 3.10

* Bug fix for [GH-13](https://github.com/benmatselby/sublime-phpcs/issues/13) which seems to be apparent when Sublime cannot find/load the settings file

3.9
---
## 3.9

* Bug fix for [GH-12](https://github.com/benmatselby/sublime-phpcs/issues/12)
* Bug fix for incorrectly mismatching sublime line numbers to line numbers from a report *if* there was only one error reported
* Updated name of change log

3.8
---
## 3.8

* Support added for running [phpmd](http://phpmd.org/) - Currently off by default

3.7
---
## 3.7

* Updated Main.sublime-menu so we can change the key bindings from within the Preferences panel

3.6
---
## 3.6

* Added the ability to show previous errors without generating the report again. Thanks to [Drarok](https://github.com/Drarok) [GH-9](https://github.com/benmatselby/sublime-phpcs/pull/9)
* Put the processing back to being threaded which helps with large files. Thanks to [Drarok](https://github.com/Drarok) [GH-10](https://github.com/benmatselby/sublime-phpcs/pull/10)
* Removed Side Bar Menu, as it doesn't make sense to run report against a non-open file
* When selecting an error from the quick panel, also set the status bar message
* Added "Show previous errors" to the context menu to be consistent
* Added keymap for Mac OSX, cannot get the keys right when using Virtual Box to define for Windows and Linux, so leaving for the time being

3.5
---
## 3.5

* Ability to show the errors in the status bar (configurable with on/off setting). Thanks to [Drarok](https://github.com/Drarok)
* Bug fix with clearing the sniffer marks

3.4
---
## 3.4

* Ability to not show the quick_panel errors on save, (errors shown by default). Thanks to [Drarok](https://github.com/Drarok)

3.3
---
## 3.3

* Allow the user to specify the location of the phpcs application [GH-4](https://github.com/benmatselby/sublime-phpcs/issues/4)
* Turned the linter checks on by default

3.2
---
## 3.2

* Added the ability to run the PHP linter alongside the PHP_CodeSniffer
* You can specify if you want the linter to run
* You can specify the regex of the linter output, as it seems to differ on different systems

3.1
---
## 3.1

* Updated the loading of settings to use static method
* Updated the debugging calls to prefix with "Phpcs"
* Added a counter of errors in the console log

3.0
---
## 3.0

* Enables the plugin to work on the Windows platform [GH-1](https://github.com/benmatselby/sublime-phpcs/issues/1)
* Removed some redundant code

2.0
---
## 2.0

* Changed the way the checkstyle report was parsed. due to [GH-2](https://github.com/benmatselby/sublime-phpcs/issues/2) which means it should now work on Linux machines

1.1
---
## 1.1

* Load the settings into memory if changed using _settings.add_on_change_. This only works on User settings rather than defaults, which is a limitation of the API from what I can see at the moment.
* Define the coding standard as PEAR by default.
* Introduced this Changelog.md file.
* Raised [this feature request](http://sublimetext.userecho.com/topic/96221-gutter-hint-bubles-when-hovered-over/) so I can show tool tips in the gutter for each checkstyle error/warning

1.0
---
## 1.0

* Initial release documented [here](http://soulbroken.co.uk/code/sublimephpcs)
* Right click on a php file and generate checkstyle report in the gutter and/or quick panel
* Settings to turn the reporting on/off for gutter and quick panel
Loading

0 comments on commit 3b4adb2

Please # to comment.