Atom-beautify: Warning about "php cs fixer"

[devSonicgirl]

Description

An alert appears after updating to version 0.30.2.

The "PHP - PHP-CS-Fixer Path (cs_fixer_path)" configuration option has been deprecated. Please switch to using the option named "Executables - PHP-CS-Fixer - Path" in Atom-Beautify package settings now.

There was no problem in previous versions.
How should we solve it?

[Glavin001]

How should we solve it?

The solution is in the error message:

The "PHP - PHP-CS-Fixer Path (cs_fixer_path)" configuration option has been deprecated. Please switch to using the option named "Executables - PHP-CS-Fixer - Path" in Atom-Beautify package settings now.

I will elaborate.

Go into Atom-Beautify package settings.

Before (currently what you have):

^ Delete it from there.

After (new correct way):

Does this help? How would you recommend I change this error message so it would be clear what to do?

[Glavin001]

@nicholas-ooi, you had the same question from https://github.com/Glavin001/atom-beautify/issues/1725#issuecomment-309413358

How would you recommend I change this error message to be more clear?

[devSonicgirl]

@Glavin001 Thank you.
It was difficult to find the PHP-CS-Fixer entry.
Well solved.

[Glavin001]

@LIANGWEIBIAO what do you think would make this message clearer and more self explanatory?

[ryanpcmcquen]

Perhaps we could change:

The "PHP - PHP-CS-Fixer Path (cs_fixer_path)" configuration option has been deprecated. Please switch to using the option named "Executables - PHP-CS-Fixer - Path" in Atom-Beautify package settings now.

To:

The "PHP - PHP-CS-Fixer Path (cs_fixer_path)" configuration option has been deprecated. Please switch to using the option under "Executables", labeled "PHP-CS-Fixer - Path" in this package's settings (scroll up).

[Glavin001]

Thank you for your feedback @ryanpcmcquen!

Before:

Please switch to using the option named "Executables - PHP-CS-Fixer - Path" in Atom-Beautify package settings now.

After:

Please switch to using the option under "Executables", labeled "PHP-CS-Fixer - Path" in this package's settings (scroll up).

I think this is an improvement.
I'm not sure what you meant by (scroll up)? Is this because the Executables section is at the top?

Let's go even further, how about the following:

Please switch to using the option in section "Executables" (near the top) in subsection "PHP-CS-Fixer" labelled "Path" in Atom-Beautify package settings.

I'm not sure about in this package's settings versus Atom-Beautify's package settings.

Please keep the feedback coming! I will make this change in the next couple days and publish.

[ryanpcmcquen]

I like _near the top_! I just found the wording confusing, although I am not sure in this package's settings is any less confusing ...

[Glavin001]

Awesome! Changing it to the following now:

The "PHP-CS-Fixer" configuration option has been deprecated. Please switch to using the option in section "Executables" (near the top) in subsection "PHP - PHP-CS-Fixer Path (cs_fixer_path)" labelled "Path" in Atom-Beautify package settings.

Will be in the next release.

[PeterStavrou]

How do you get the menu "PHP-CS-FIXER" below PHP?
I have:
Perl
PHP
Puppet

[keisukefunatsu]

@PeterStavrou
You can see "PHP-CS-FIXER" in "Executables" below General.

[Glavin001]

Published to v0.30.4

The error message should now be:

The "PHP - PHP-CS-Fixer Path (cs_fixer_path)" configuration option has been deprecated. Please switch to using the option in section "Executables" (near the top) in subsection "PHP-CS-Fixer" labelled "Path" in Atom-Beautify package settings.

[295black]

it is so difficult to find the PHP-CS-Fixer under the Executables ~~

[Glavin001]

@Treasu is it? This is what it looks like:

Any recommendations for how it could be improved?

[k2levin]

Just a small add on, for those who is confuse and cannot find the "PHP-CS-Fixer"
Please expand the "Executables", "PHP-CS-Fixer" is inside "Executables"

[Samnan]

This is a mess really. I have tried everything to update the php cs fixer path, in executables section, in php cs fixer path ,removed one of them to keep the other , nothing works. The warning continues.

[Glavin001]

@Samnan the applicable line of code can be found at https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/php-cs-fixer.coffee#L92-L93

    if options.cs_fixer_path
      @deprecateOptionForExecutable("PHP-CS-Fixer", "PHP - PHP-CS-Fixer Path (cs_fixer_path)", "Path")

Where options.cs_fixer_path is the old, deprecated PHP - CS-Fixer Path option.
By deleting the value for this option -- making it an empty string, falsy -- it will not show the deprecation message.

If you find there is an issue, I recommend creating a debug.md Gist by following instructions at https://github.com/Glavin001/atom-beautify/blob/master/docs/troubleshooting.md
Without this debug.md information nothing can/will be done to investigate your issue. Once provided, I am confident we can figure out the issue.

---

@Treasu and @k2levin if you have recommendations for how to improve the deprecation message, please let me know and preferably submit a Pull Request changing the code found at https://github.com/Glavin001/atom-beautify/blob/master/src/beautifiers/beautifier.coffee#L99-L101

[Berg93]

@Glavin001