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

refactor: use typescript #21

Merged
merged 7 commits into from
Jun 13, 2023
Merged

refactor: use typescript #21

merged 7 commits into from
Jun 13, 2023

Conversation

Weetbix
Copy link
Collaborator

@Weetbix Weetbix commented Jun 13, 2023

This PR converts the project to typescript with no other functional changes.

It uses the template settings for jest/eslint etc from here: https://github.com/actions/typescript-action

There are some cases which had to be @ts-ignore'd and we can improve later, mainly around remarker usage.

You can see the action working as intended in this PR.

@github-actions
Copy link

Overall readability score: 24.55/100 (🟢 +4.13)

File Readability
README.md 39.85 (🟢 +16.54)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
README.md 39.85 52.12 13.15 23.6 11.61 6.92
  🟢 +16.54 🟢 +7.3 🟢 +3.29 🟢 +4.9 🟢 +0.18 🟢 +0.72

Averages:

  Readability FRE GF ARI CLI DCRS
Average 24.55 16 16.06 17.9 15.05 9.34
  🟢 +4.13 🟢 +1.82 🟢 +0.82 🟢 +1.23 🟢 +0.04 🟢 +0.18
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@Weetbix Weetbix marked this pull request as ready for review June 13, 2023 10:16
@Weetbix Weetbix requested a review from noon-dawg June 13, 2023 10:16
Copy link
Contributor

@noon-dawg noon-dawg left a comment

Choose a reason for hiding this comment

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

🚀

@Weetbix Weetbix merged commit 204b0ad into main Jun 13, 2023
@Weetbix Weetbix deleted the jh/use-typescript branch June 13, 2023 11:17
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