[RFE] Implement transform (--write) functionality for applicable rules

[ganeshrn]

Summary

Implement write functionality for the rules in the below list as applicable.

Must have:

• command-instead-of-shell Add auto-fixing implementation for command-instead-of-shell rule #3675
• deprecated-local-action Add auto-fixing implementation for deprecated-local-action rule #3689
• jinja[spacing] Add auto-fixing implementation for jinja[spacing] rule #3691
• key-order Add auto-fixing implementation for key-order[task] rule #3705
• no-free-form Add auto-fixing implementation for no-free-form rule #3725
• no-jinja-when Add auto-fixing implementation for no-jinja-when rule #3721
• no-log-password Add auto-fixing implementation for no-log-password rule #3708
• partial-become Add auto-fixing implementation for partial-become rule #3692

Good to have:

• deprecated-module
• empty-string-compare
• fqcn
• inline-env-var/
• literal-compare
• no-tabs
• risky-file-permissions
• risky-octal

Won't do:

• package-latest
• var-naming[non-string]
• var-naming[non-ascii]
• var-naming[non-jinja]
• var-naming[pattern]
• var-naming[no-role-prefix]
• var-naming[no-reserved]
• deprecated-bare-vars Add auto-fixing implementation for deprecated-bare-vars rule #3688
• no-handler Add auto-fixing implementation for no-handler rule #3732

ansible-lint --version
6.17.2

[bendem]

Maybe it would be best to stabilise the --write behaviour before implementing more of it? Currently, --write with no rules enabled will reformat every single file parsed based on the non-configurable rueaml parsers. Since the first lint rule is yamllint which has different default and is actually configurable, running ansible-lint with --write produces useless changes, breaks the rules defined in further linting and often times results in broken yaml.

See #3603, #3583, #3226, #2941, #2112.

Rule transforms should make the minimal amount of changes to the file that fixes the problem. Loading the whole file in memory and writing it back means all the formatting is lost which is (at least in my opinion) really problematic.

[cognifloyd]

I have implementations for a variety of rules, but I held off putting them in until I could the the Jinja formatter. Sadly, work priorities have kept me away from this project for awhile but I hope to return to it. I just don't have a precise timeline.

[ganeshrn]

@bendem Thanks for linking the related issues. We are looking into fixing those issues.

@cognifloyd A big thank you for contributing the transform feature. Can you please do a draft PR for rules that you have implemented the transform functionality? We can look into missing rules to implement the transform functionality.

[cidrblock]

#3624

This is releated, we might want to take care of this prior to too many additions.

[justjais]

@cognifloyd Thanks so much for your effort in implementing the transform features from Ansible Lint. As we're currently focusing on implementing transform capabilities for one's that's mentioned in the issue description, it'd be great if you can comment ASAP with the transform capabilities that you've already worked on, as that'd help us in not duplicating the work and the effort.

[shatakshiiii]

Some related bugs: #3670, #3662

[ssbarnea]

I am going to close this as done as all the MUST have were implemented. This does not mean that we will not want to do the others, but we should consider this epic done for now.

Many of the ones that were not implemented were for good reasons: there is no safe way to do it programetely, a human needing to tune the result.