Add new AvoidUsingArrayList rule

[iRon7]

to warn when the ArrayList class is used in PowerShell scripts (#2147).
Add tests for both violations and non-violations of this rule.
Update documentation to include the new rule and its guidelines.
(For this, I followed Liam Peters' blog post, also note that this is my first formal C# contribution to any GitHub project)

PR Summary

PR Checklist

• PR has a meaningful title
  • Use the present tense and imperative mood when describing your changes
• Summarized changes
• Change is not breaking
• Make sure all .cs, .ps1 and .psm1 files have the correct copyright header
• Make sure you've added a new test if existing tests do not effectively test the code changed and/or updated documentation
• This PR is ready to merge and is not Work in Progress.
  • If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.

[liamjpeters]

👋 @iRon7 - great that you've taken the plunge, and thanks for being one of 3 people to read my blog post (myself included) 😊.

I hope you don't mind, but I took a look over the PR and left some suggestions. I'm happy to discuss or elaborate on anything.

Thanks,

[liamjpeters]

I don't think that this rule should be enabled by default

[iRon7]

The fact that in a lot of cases the use of the ArrayList class might cause a PowerShell pitfall (due to unintentionally polluting the PowerShell pipeline with the Add method), I would really like to see it enabled by default.
Anyways, I leave it to your team to make the final decision on this.

[iRon7]

Liam,
Thanks you for your help and feedback, I learned a lot!

One general thought that came up:
Instead of testing all things afterwards (and still making a lot of copy-pasta misstakes, as I did), a small cmdlet like:

New-CSRule -Name <name> -Description <Description> -Message <Message> -Configurable ...

That prepares things as a stripped .cs rule and .ps1 test (without logic) along with the Strings.resx and the readme updates etc. could in my opinion be helpful and prevent a lot of issues at forehand.

[liamjpeters]

Liam, Thanks you for your help and feedback, I learned a lot!

One general thought that came up: Instead of testing all things afterwards (and still making a lot of copy-pasta misstakes, as I did), a small cmdlet like:

New-CSRule -Name <name> -Description <Description> -Message <Message> -Configurable ...

That prepares things as a stripped .cs rule and .ps1 test (without logic) along with the Strings.resx and the readme updates etc. could in my opinion be helpful and prevent a lot of issues at forehand.

There's the RuleMaker module. I've tried it before with mixed results. It needs a little TLC (copyright is outdated, doesn't append to string resources super well etc).