-
Notifications
You must be signed in to change notification settings - Fork 84
chore(style): minor code style adjustments for improved consistency #152
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
Conversation
|
@@ -16,8 +16,10 @@ import Default from '@astrojs/starlight/components/Head.astro'; | |||
// @ts-ignore | |||
dataLayer.push(arguments); | |||
} | |||
|
|||
// @ts-ignore |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Nemikolh Would be cool if we can explain why we do this. Feel free to push to this branch.
// @ts-ignore because ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment added! 🙌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency we could use https://typescript-eslint.io/rules/ban-ts-comment/#allow-with-description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love that idea @AriPerkkio 🔥
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is something we should even add to our eslint plugin IMHO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When exactly do these @ts-ignore
here become required? If I remove them from this PR, all tests and builds pass just fine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh right, pnpm docs:build
did fail https://github.com/stackblitz/tutorialkit/actions/runs/10004035387/job/27651984509?pr=152
Deploying tutorialkit-docs-page with
|
Latest commit: |
3a400ef
|
Status: | ✅ Deploy successful! |
Preview URL: | https://66ab711a.tutorialkit-docs-page.pages.dev |
Branch Preview URL: | https://delm-chore-style-consistency.tutorialkit-docs-page.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh this file is completely redone in #143, maybe you want to review that one instead?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh interesting, yea maybe we don't have to fix it then?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah but the other PR might have issues
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Ideally this kind of changes would be automated with linter and formatters. 👍
Yea, some things are harder to automate but I agree with you. The more we can automate the better! |
@d3lm as follow-up I can file a PR against our ESLint plugin to add these improvements. |
That would be wonderful Air! |
Looks like |
Small PR that updates some minor code styling to streamline consistency with the rest of the repo.