Consistent options

[m-allanson]

Which issue, if any, is this issue related to?

#1663

Is there anything in the PR that needs further explanation?

This deprecates the options listed in the related issue.

The changes required for each deprecation are listed below.

In the rule:

• trigger a deprecation warning when the old option name is used
• duplicate all code blocks that reference the old option name and modify them to reference the new option name

In the rule's readme:

• rename the option
• add a note to each option describing the previous name of the option

In the rule's tests:

• duplicate all unit tests that reference the old option name and modify them to reference the new option name
• add one or more deprecation unit tests in a new file

Then:

• update system test snapshots affected by previous changes

[m-allanson]

That should be all the option deprecations covered. I'm going to check this with a fresh pair of eyes tomorrow, then mark it up as ready for review.

[m-allanson]

Alright, this is ready for review.

[m-allanson]

I've just noticed this is merging into master, it should be merging into the deprecations branch instead.

[jeddy3]

I've just noticed this is merging into master, it should be merging into the deprecations branch instead.

Phew, I'm glad you saw. I just spotted that too and I thought I'd misunderstood how we were going out these deprecations. I think we should still merge into deprecations, if only because it'll encourage me to hurry #2079 along.

Awesome job on this PR btw. It's epic :)

[m-allanson]

I think we should still merge into deprecations

Agreed, PR updated.

if only because it'll encourage me to hurry #2079 along.

If it's any additional incentive, once there's consensus on #2079 I can go ahead and implement the required changes.

[davidtheclark]

Looks good. Thanks for spearheading this, @m-allanson! Anybody have objections to merging? If not, I say go for it.

[alexander-akait]

@m-allanson maybe squash this commits in one for best history

[jeddy3]

maybe squash this commits in one for best history

I've done this via Github.

@m-allanson Excellent job!

If it's any additional incentive, once there's consensus on #2079 I can go ahead and implement the required changes.

Got the ball rolling for two rules in #2220 :) Hopefully I'll have time for the rest soon!