Add MegaLinter for Linting and Fixing

[ScottGibb]

Summary

This PR aims to add Linting to the project via MegaLinter(https://github.com/oxsecurity/megalinter). The reason we want to use MegaLinter as it has a lot of out of the box setup and runs in docker so can be used cross platform and allows everyone to use the same linters.

Locally Running the Linter

npx mega-linter-runner

This command will also auto format and fix various files as they are configured via the .mega-linter.yml file.

Linting Workflow

This PR aims to fix both the codebase files and add the linting workflow.

The linting workflow at present works as follows:

On a Pull Request:

• Checks all Code using the Linting process, fails on Errors
• If code has fixable errors such as formatting or easy linting errors, a new branch will be created and a second pull request opened with these fixes.

The Linting workflow will pass when all checked files have zero errors.

Due to some limitations in cargo clippy tool and rustfmt in MegaLinter an extra stage workflow was added to ensure full coverage.

Tasks

• Add Auto PR formatting - Couldn't be added due to it not working correctly and more hassle than its worse.
• Make Sure Clippy is looking at entire project - Posted on Discussion to find out more (Rust Clippy Linter Settings: How to run Clippy and fmt on different crates and example directories with manifest files oxsecurity/megalinter#4318)
• Make sure Markdownlint is looking at entire project (Confirmed and will auto fix things if the .markdownlint.json is present )
• Create Ticket for updating MegaLinter Configuration when it uses cargo fmt and can scan the esp32c3 example
• Confirm with MegaLinter Devs about PR workflow
• Resolve Line Length Standard
• PAT Token for actionlint fixes
• Add Markdownlint and yamllint line count settings to main`.mega-linter.yaml' settings

[ScottGibb]

Line Length has taken the standard of no new line characters except for paragraphs and relying on the developers/githubs soft line wraps for display

[ScottGibb]

Ive removed the dead workflow code and think the best way to move forward is to leave an issue on the repo linking to my question on the megalinter question. That way when there is a response we can update the repo workflow with an updated flow or append the example in megalinter.

[ScottGibb]

For removing the markdownlint.json we have some issues. I cant seem to override the default config without providing our own.

The default is this

{
  "MD004": false,
  "MD007": {
    "indent": 2
  },
  "MD013": {
    "line_length": 400
  },
  "MD026": {
    "punctuation": ".,;:!。，；:"
  },
  "MD029": false,
  "MD033": false,
  "MD036": false,
  "blank_lines": false
}

Personally I dont like the default as its not the actual default that markdownlint provides.

Ive tried overriding it through the .mega-linter.yaml by using command arguments sadly this doesnt work.

Im opting for us using our own config at the root level

[github-actions]

MegaLinter has automatically applied linters fixes on this PR.
Please review the changes and merge if they are correct.
PR: #16

[jamessizeland]

Excellent work