Added Super /Mega Linter #1

ScottGibb · 2024-11-20T14:58:02Z

Adding Linting to the Project

This PR is focused on adding the following languages checks

yaml
Rust
Markdown

How it does this is up to discussion, currently investigating https://github.com/super-linter/super-linter/tree/v7.2.0.

Linting is currently set to be triggered on pull requests

Add Some form of Text Linting (TextLint)
Ensure All Markdown Files are being scanned
Get Linter Auto PR Fixes operational
Transition to using MegaLinter

petekubiak · 2024-11-22T13:15:43Z

.github/workflows/Linting.yaml

+
+      # Remove this section when Super Linter is updated (https://github.com/dysonltd/tmag5273/issues/3)
+      Clippy:
+        name: Clippy


With a little jiggery-pokery it's possible to run clippy on doc examples too

Info can be found here - the bits you need are kind of dotted about but if you think it's worth implementing I've got a working example I was using on one of our other repos

I think this would be good to add. Especially since the Super Linter isnt upgraded yet for the latest rust version (#3). Are you able to share here and il add it in?

petekubiak · 2024-11-22T13:17:02Z

ReadMe.md

+optimize  throughput  and  accuracy.  A  dedicated
+INT pin  can  act  as  a  system  interrupt  during
+low  power wake-up and sleep mode, and can also be used by a
+microcontroller to trigger a new sensor conversion.An  integrated


Missing space after full stop

So Super Linter has a natural language linter, I wonder if this will flag these?

Yup Textlint
https://textlint.github.io/

petekubiak · 2024-11-22T13:21:30Z

ReadMe.md

-integrates  three  independent  Hall-effect  sensors  in the  X,  Y,  and  Z  axes.  A  precision  analog  signal-chain  along  with  an  integrated  12-bit  ADC  digitizes
+integrates  three  independent  Hall-effect  sensors  in
+the  X,  Y,  and  Z  axes.  A  precision  analog  signal-chain
+along  with  an  integrated  12-bit  ADC  digitizes


I appreciate that (presumably) the linter is keeping line lengths reasonably short, but it does make editing a bit of a pain due to having to change where all the newline characters are located.

I'm keen on the one-line-per-sentence approach as markdown renderers will automatically reformat into paragraphs, and this way you don't need to worry about where the line breaks occur. Then in the editor, line wrapping can be used to avoid sentences running off the right of the screen.

Is there a way we could get the linter to do this instead?

Il have a look

I like the idea of the convention being newline on every sentence, im happy to change that. Im currently experimenting with the markdownlint-cli --fix, this looks promising.

petekubiak · 2024-11-22T13:21:55Z

ReadMe.md

 provides full 360° angular position information for both
 on-axis  and  off-axis  angle  measurement  topologies.
 The  angle  calculation  is  performed  using  two
 user-selected  magnetic  axes.  The  device  features
 magnetic  gain  and  offset  correction  to  mitigate  the
-impact of system mechanical error sources.The  TMAG5273  is  offered  in  four  different  factory-programmed I2C addresses. The device also supports
-additional  I2C  addresses  through  the  modification
+impact of system mechanical error sources.The  TMAG5273  is


Missing space after full stop

hmmm this is interesting, the markdownlint should of picked up on that

examples/ReadMe.md

petekubiak · 2024-11-22T14:51:35Z

examples/ReadMe.md

+the library should be able to run in `no-std` environment such as baremetal. A
+[esp32c3](https://github.com/esp-rs/esp-rust-board)example is shown [here](./esp32-c3/src/main.rs).
+Due to it using a baremetal environment its recommended to go to that directory
+and call `cargo run` from within it and flash the code on to the device.


There's a lot of "it"s in this sentence, maybe worth rephrasing as a set of instructions?

ScottGibb · 2024-11-22T17:17:45Z

After some googling and issues with getting the fix_LANGUAGE_x in the SuperLinter configuration to work. Ive shifted my attention over to MegaLinter which may be better maintained. It also has rust support with the most up to date Rust version alongside some other improvements.

github-actions · 2024-11-22T17:37:06Z

🦙 MegaLinter status: ❌ ERROR

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ ACTION	actionlint	1		0	0.02s
❌ COPYPASTE	jscpd	yes		7	1.47s
✅ MARKDOWN	markdownlint	4	0	0	0.49s
❌ MARKDOWN	markdown-link-check	4		1	4.0s
✅ MARKDOWN	markdown-table-formatter	4	0	0	0.19s
✅ RUST	clippy	yes		no	22.99s
❌ YAML	yamllint	2		30	0.36s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

jamessizeland · 2024-11-22T17:49:08Z

.cspell.json

How does this spell check work? I tend to find them to just add noise where code uses nonstandard words and contractions all over the place.

jamessizeland · 2024-11-22T17:50:07Z

.github/workflows/Linting.yaml

+    name: Linting
+
+    on: # yamllint disable-line rule:truthy
+      # push: null


Is this line required still?

I think we will be moving away from this actually after finding MegaLinter
https://megalinter.io/v8/
It handles the analysis slightly differently.

jamessizeland · 2024-11-22T17:52:15Z

.jscpd.json

What does this file do?

I believe this one is for the Natural language Check, but will need to check it.

jamessizeland · 2024-11-22T17:56:20Z

.markdownlint.yaml

Is it possible to inherit a lint standard for markdown instead of having a long file of custom configuration like this?

So you can run markdownlint with the standard and we would need to apply two settings around line length. This is how it was originally and was in json, but then SuperLinter needed a yaml file as it wasnt reading the json for some reason....

We should be able to solve this by moving to MegaLinter

jamessizeland · 2024-11-22T17:57:57Z

.textlintrc.json

Like the spelling config, I'd prefer to limit the number of custom lint config files we need to track across repos as they add visual noise.

examples/README.md

petekubiak · 2024-11-22T18:42:25Z

utils/README.md

@@ -2,14 +2,21 @@

 ## Summary

-This internal crate is a utilities package designed for connecting the Embedded Targets to the Library as such it is not to be used as part of the library.
+This internal crate is a utilities package designed for connecting the Embedded


Again I'm not really a fan of line breaks in the middle of sentences because it makes editing a pain. We can have a discussion about this when all three of us are about.

Agreed, i'm not sure how best to handle this. Because we cant break on a sentence end because some sentences go really long.

v1.0.0 of the cross platform i2c driver

ScottGibb · 2024-11-25T13:53:23Z

Closing PR to reopen. To continue testing workflow

ScottGibb added 20 commits November 20, 2024 14:57

Added Super Linter

8cfff98

added Linting badge

182aa29

Added Markdownlint settings

59f25af

Turning on linters for all file types present in repo

e32a1b1

disabling on push trigger

02ca4ac

added Rust linting

8b80603

changed markdownlint from json to yaml

97f0d3c

Fixed Markdown linting issues

9e1acb2

updated all ReadMe Violations

1a2f1b9

Adding lint fixing

2b5a2aa

Added fmt stage

f45055a

Added .gitignore

5740033

Updated linting and formatting

1c44ac3

Added Checkout Code Stage

e275a84

Added Clippy and fmt into workflow

e405099

Updating src fmt

502d2b9

Fixed clippy issue

a703659

Added comment about issue

7818031

Added linting rules

e7bee80

Added todo

44e0667

ScottGibb marked this pull request as ready for review November 22, 2024 12:28

Fixed script formatting

54c84f9

ScottGibb requested review from petekubiak and jamessizeland November 22, 2024 12:33

Fixed badge

593a20f

petekubiak approved these changes Nov 22, 2024

View reviewed changes

ScottGibb added 4 commits November 22, 2024 15:20

Added some new linters

4a2d876

using instead of ``

604f94f

removed "such as baremetal"

265842c

Adding markdown glob that should catch all files now

1c5c78c

mega linter settings

d86dd57

jamessizeland reviewed Nov 22, 2024

View reviewed changes

petekubiak reviewed Nov 22, 2024

View reviewed changes

removed the 'the'

e6ae701

ScottGibb self-assigned this Nov 25, 2024

ScottGibb added the enhancement New feature or request label Nov 25, 2024

ScottGibb linked an issue Nov 25, 2024 that may be closed by this pull request

Remove Cargo Clippy and Format Workflow when Super Linter Updates #3

Closed

ScottGibb removed a link to an issue Nov 25, 2024

Remove Cargo Clippy and Format Workflow when Super Linter Updates #3

Closed

ScottGibb added a commit that referenced this pull request Nov 25, 2024

Feature/KAB-23433 create a rust crate for the mag5273 sensor (#1)

f8f5648

v1.0.0 of the cross platform i2c driver

configured megalinter

9183a4c

ScottGibb changed the title ~~Added Super Linter~~ Added Super /Mega Linter Nov 25, 2024

ScottGibb added 15 commits November 25, 2024 10:15

created two markdown errors

570d002

Messing around with CI configuration

9bd1558

testing

653ba86

added MegaLinter

2f2ee60

updated linter

45c7284

fixed env variable

aedae88

possivble syntax error

d36dfdb

reformatting

5033865

test

1246eee

attempting to fix the aply fix stage

9b5f461

further testing

87fde33

ovveride

836dafa

reset workflow

e8abc7f

Added more markdown lints

e3d8e0e

Updated Megalinter settings

259dad2

ScottGibb closed this Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Super /Mega Linter #1

Added Super /Mega Linter #1

ScottGibb commented Nov 20, 2024 •

edited

Loading

petekubiak Nov 22, 2024 •

edited

Loading

ScottGibb Nov 22, 2024

petekubiak Nov 22, 2024

ScottGibb Nov 22, 2024

ScottGibb Nov 22, 2024

petekubiak Nov 22, 2024

ScottGibb Nov 22, 2024

ScottGibb Nov 22, 2024

petekubiak Nov 22, 2024

ScottGibb Nov 22, 2024

petekubiak Nov 22, 2024

ScottGibb commented Nov 22, 2024

github-actions bot commented Nov 22, 2024 •

edited

Loading

jamessizeland Nov 22, 2024

jamessizeland Nov 22, 2024

ScottGibb Nov 25, 2024

jamessizeland Nov 22, 2024

ScottGibb Nov 25, 2024

jamessizeland Nov 22, 2024

ScottGibb Nov 25, 2024

jamessizeland Nov 22, 2024

petekubiak Nov 22, 2024

ScottGibb Nov 25, 2024

ScottGibb commented Nov 25, 2024

Added Super /Mega Linter #1

Added Super /Mega Linter #1

Conversation

ScottGibb commented Nov 20, 2024 • edited Loading

Adding Linting to the Project

petekubiak Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ScottGibb commented Nov 22, 2024

github-actions bot commented Nov 22, 2024 • edited Loading

🦙 MegaLinter status: ❌ ERROR

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ScottGibb commented Nov 25, 2024

ScottGibb commented Nov 20, 2024 •

edited

Loading

petekubiak Nov 22, 2024 •

edited

Loading

github-actions bot commented Nov 22, 2024 •

edited

Loading