Added rule: AvoidLongLines

[thomasrayner]

PR Summary

Addresses #1243. This rule issues a warning for lines that are longer than 120 characters. This default value can be override and the rule is not enabled by default.

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.

[bergmeister]

Thanks but running this rule by default will break a lot of people.
The rule should be disabled by default and the width should also be configurable. Have a look at rules that inherit from ConfigurableRule for that.

[thomasrayner]

@bergmeister I have made the changes you requested :)

[bergmeister]

The 2 tests need fixing:
The first one is trivial, the expectation can be changed to 59 due to the new rule (maybe we can add some better logic to automatically determine the number of total rules to avoid having to update this test every time...):
[-] get Rules with no parameters supplied 60ms
Expected 58, but got 59.
74: $defaultRules.Count | Should -Be $expectedNumRules
at , C:\projects\psscriptanalyzer\Tests\Engine\GetScriptAnalyzerRule.tests.ps1: line 74
[+] is a positional parameter 14ms
Context When used incorrectly

The second test is for the documentation to have a matching rule document for every rule. Somehow it does not find the PSAvoidLongLines rules. It uses Get-ScriptAnalyzerRule for that, check if the rule gets returned here or maybe it is simply missing the PS prefix in the name?

[-] Every rule must have an entry in the rule documentation README.md file 26ms
Expected $null or empty, but got PSAvoidLongLines.
46: $rulesReadmeDiff | Where-Object SideIndicator -eq "<=" | Foreach-Object InputObject | Should -BeNullOrEmpty
at , C:\projects\psscriptanalyzer\Tests\Documentation\RuleDocumentation.tests.ps1: line 46

[bergmeister]

I've just pushed a fix for the 2 tests and pulled from master. This should make everything green now. Will add some docs and then we should be ready to go.