Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial cspell and prettier support #451

Merged
merged 4 commits into from
Jan 13, 2024
Merged

Initial cspell and prettier support #451

merged 4 commits into from
Jan 13, 2024

Conversation

davidjharder
Copy link
Member

@davidjharder davidjharder commented Jan 12, 2024

Changes

  • Add cspell and prettier to the project as yarn dependencies
  • Create a config and custom word-list for cspell
  • Update README
  • Add Actions for cspell and prettier

Actions description

  • spellcheck
    • cspell is used to check spelling against standard dictionaries and a custom word list.
    • Warnings are generated for bad spellings, but the check will still pass
  • prettier
    • Format changed markdown pages and write the changes as a new commit on the PR

See these checks in action here:

@davidjharder davidjharder marked this pull request as draft January 12, 2024 02:35
@davidjharder davidjharder force-pushed the spelling branch 3 times, most recently from 95166e1 to 6c77e00 Compare January 12, 2024 18:54
- Add cspell and prettier to yarn
- Create a config and custom word-list for cspell
- Update README
- Add Github Action for cspell
- Add Githun Action for prettier
@davidjharder davidjharder marked this pull request as ready for review January 13, 2024 18:09
name: 'Format with Prettier'
on:
pull_request:
branches: [master]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason this one only runs when PR'ing against master?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, I just copied an example

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, then it should be removed (for when we rename the branch to main 😉)

Copy link
Member Author

@davidjharder davidjharder Jan 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be required. I do not know why

This is works on my fork, I think it fails here for some other reason I don't understand

.github/workflows/prettier.yml Outdated Show resolved Hide resolved
.github/workflows/spellcheck.yml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
davidjharder and others added 2 commits January 13, 2024 13:41
Co-authored-by: Silke Hofstra <[email protected]>
@davidjharder
Copy link
Member Author

YOLO

@davidjharder davidjharder merged commit da0b85a into master Jan 13, 2024
1 of 2 checks passed
@davidjharder davidjharder deleted the spelling branch January 13, 2024 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants