Add in Hyperlint Base Style Guide + Spellcheck Configurations

[bllchmbrs]

Change Summary

This adds in the base Hyperlint configurations and shows where to add files to effectively configure your style guide and rules.

Related issue number

NA

Checklist

• The pull request title is a good summary of the changes - it will be used in the changelog
• [-] Unit tests for the changes exist
• [-] Tests pass on CI
• [-] Documentation reflects the changes where applicable
• My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Please review @sydney-runkle

[hyperlint-ai]

style_guide_test.md review details

Line Edit Problems/Proposals

Note: The following 3 comments are grouped by line.

Line 3

Existing text:

# This ia a test file

Issues:

• Style Guide - (Spelling-error) Did you really mean 'ia'?

---

Line 5

Existing text:

it will flag errors like on pydantic.

Issues:

• Style Guide - (Terms-error) Use 'Pydantic' instead of 'pydantic'.

---

Line 11

Existing text:

This is is an issue.

Issues:

• Style Guide - (Repetition-error) 'is' is repeated!
• Style Guide - (hyperlint.repeatedWords-error) 'is' is repeated, did you mean to repeat this word?

[bllchmbrs]

This file will run the checks (but no recommendations) use it to iterate on the styles / dictionary. It doesn't need to be committed to the repo (but can be).

[bllchmbrs]

This is the base style guide check cconfiguration, no action needed here on your part - this won't change much or often.

[bllchmbrs]

This is your custom dictionary: Read more here.

[sydney-runkle]

Great! I'll expand on this when I do some docs updates tomorrow.

[bllchmbrs]

This is a custom rule, lots of possibilities here but best to start simple. Read more here

[bllchmbrs]

style_guide_test.md review details

Line Edit Problems/Proposals

Note: The following 3 comments are grouped by line.

Line 3

Existing text:

This ia a test file

Issues:

• Style Guide - (Spelling-error) Did you really mean 'ia'?

Line 5

Existing text:

it will flag errors like on pydantic.
Issues:

• Style Guide - (Terms-error) Use 'Pydantic' instead of 'pydantic'.

Line 11

Existing text:

This is is an issue.
Issues:

• Style Guide - (Repetition-error) 'is' is repeated!
• Style Guide - (hyperlint.repeatedWords-error) 'is' is repeated, did you mean to repeat this word?

As you make changes, you'll get more comments like this. If the style guide test file is present on a pull request, then it will post a comment like that on every update.

[codspeed-hq]

CodSpeed Performance Report

Merging #10270 will not alter performance

_{Comparing bllchmbrs:main (5b7ce5c) with main (e6145c0)}

Summary

✅ 34 untouched benchmarks

[sydney-runkle]

Looks great - left some comments attempting to fix linting issues.

[hyperlint-ai]

style_guide_test.md review details

Line Edit Problems/Proposals

Note: The following 3 comments are grouped by line.

Line 3

Existing text:

# This ia a test file

Issues:

• Style Guide - (Spelling-error) Did you really mean 'ia'?

---

Line 5

Existing text:

it will flag errors like on pydantic.

Issues:

• Style Guide - (Terms-error) Use 'Pydantic' instead of 'pydantic'.

---

Line 11

Existing text:

This is is an issue.

Issues:

• Style Guide - (hyperlint.repeatedWords-error) 'is' is repeated, did you mean to repeat this word?
• Style Guide - (Repetition-error) 'is' is repeated!

[sydney-runkle]

cc @Viicos, this could be a great way to enforce Pydantic and pydantic across the docs :)

[github-actions]

Coverage report

This PR does not seem to contain any modification to coverable code.