dev: Add a script to auto fix all lint violations

[2010YOUY01]

Which issue does this PR close?

Part of #19227

Rationale for this change

See issue for details.

The existing script ./dev/rust_lint.sh do checks for all non-functional tests include formater/clippy checks.

Some check tools support auto fix options, so this PR add an option to the lint scripts to perform auto-fixes.

Now ./dev/rust_lint.sh --write --allow-dirty can perform auto-fixes for all linter etc. violations

yongting@Yongtings-MacBook-Pro-2 ~/C/datafusion (auto-fix)> ./dev/rust_lint.sh --help
Usage: ./dev/rust_lint.sh [--write] [--allow-dirty]

Runs the local Rust lint suite similar to CI.
--write        Run formatters, clippy and other non-functional checks in best-effort write/fix mode (requires a clean git worktree, no uncommitted changes; some checks are test-only and ignore this flag).
--allow-dirty  Allow `--write` to run even when the git worktree has uncommitted changes.

What changes are included in this PR?

• Adds [--write] [--allow-dirty] flag to rust_lint.sh to support auto fixes
• rust_lint.sh consists of several sub-scripts like rust_fmt.sh, they're all extended with auto-fix feature through --write flag, and the rust_lint.sh is optionally calling them with an additional flag for auto fixes.
• Clean up rust_lint.sh

Are these changes tested?

Yes, commit 8c99417 intentionally introduced one violation for each available lint check, and the auto-fix command is able to fix all of them.

The test may not be comprehensive, but it provides a reasonable starting point. We can begin using this script now and iterate on it if we discover cases where the auto-fix does not behave correctly.

Are there any user-facing changes?

No

[martin-g]

Is there a reason to keep using this old version ?
Latest is https://www.npmjs.com/package/prettier/v/3.7.4

[2010YOUY01]

No, I think it's supposed to get updated manually.
We can do so separately since it might have a large code diff.

[martin-g]

nit: It seems there is no newline (\n) at the end here (non POSIX complaint).
It is recommended to have it otherwise "it may break some old tools".
Even Github UI marks it as a warning.

[2010YOUY01]

Good point, updated.

Perhaps we should introduce some lint tools to check the existing bash scripts, to prevent similar issues in the future 🤔

[2010YOUY01]

@martin-g Thank you for the review, all comments are addressed in ae7fc70

After the change, I have tested again the following step, and it's working as expected.

Are these changes tested?

Yes, commit 8c99417 intentionally introduced one violation for each available lint check, and the auto-fix command is able to fix all of them.

The test may not be comprehensive, but it provides a reasonable starting point. We can begin using this script now and iterate on it if we discover cases where the auto-fix does not behave correctly.