-
Notifications
You must be signed in to change notification settings - Fork 0
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: Some QOL changes to improve DX #15
Conversation
This project doesn't do anything special, so we can use the default departmental configuration.
To improve consistency with other projects across the department.
To have fewer config files.
This makes it easier to see application code vs config etc.
deployments: Record< | ||
string, | ||
{ | ||
sources?: string[]; | ||
[name: string]: unknown; | ||
} | ||
>; | ||
}; |
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.
This has changed from:
deployments: { [name: string]: any }
To provide more type information for index.ts
.
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 great! 🚢
If possible, it would be great to use git mv
in future to simplify the diff (rather than it thinking everything is deleted/new), though I realise it doesn't always work.
I had used |
@akash1810 ah yep thanks! It's the linting that is confusing GH. |
What does this change?
Make a few QOL improvements to improve the DX:
src
directory, this makes it easier to see code vs config etc.dist
directoryHow to test
CI should continue to pass.
How can we measure success?
Improved consistency with projects across the department.
Footnotes
These changes could be made in a separate PR to reduce the diff, as GH is showing the changes as delete and recreate rather than file moves. ↩