add --top-scope-variables cli argument, fix #228

[jcharaoui]

Summary

This adds the --top-scope-variables CLI option that sets PuppetLint.configuration.top_scope_variables.

Related Issues (if any)

#228

Checklist

• 🟢 Spec tests.
• 🟢 Acceptance tests.
• Manually verified.

[pmcmaw]

Can you remove this?

[jcharaoui]

I can remove it, but the test will fail with [documentation] defined type not documented.

[jcharaoui]

Also, I simply copied this # foo header from other similar test manifest fixtures, eg. spec/fixtures/test/manifests/fail.pp and spec/fixtures/test/manifests/init.pp and others.

[LukasAud]

We are trying to avoid this type of meaningless documentation. If a one-liner description doesn't make sense for this function then feel free to remove the entire comment and let Rubocop add it to the list of exceptions by running bundle exec rubocop --auto-gen-config.

[jcharaoui]

Removed an extra blank line.

[jcharaoui]

Not sure how to deal with this issue, though:

spec (ruby 3.3) / spec: lib/puppet-lint/optparser.rb#L20
Metrics/MethodLength: Method has too many lines. [111/108]

[LukasAud]

Not sure how to deal with this issue, though:

spec (ruby 3.3) / spec: lib/puppet-lint/optparser.rb#L20
Metrics/MethodLength: Method has too many lines. [111/108]

Manually adjusting the Metrics/MethodLength variable in the rubocop_todo.yml file should do the trick. Alternatively, you can run bundle exec rubocop --auto-gen-config to have Rubocop regenerate the file with the new exception.