TypeScript: Convert text-sets package
#12274
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spacedmonkey
added
Type: Infrastructure
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
|
Plugin builds for 366b793 are ready 🛎️!
|
|
Size Change: +29 B (0%) Total Size: 2.72 MB ℹ️ View Unchanged
|
swissspidy
reviewed
Oct 7, 2022
miina
reviewed
Oct 10, 2022
barklund
approved these changes
Oct 10, 2022
barklund
reviewed
Oct 12, 2022
| @@ -89,5 +92,5 @@ export default async function loadTextSets() { | |||
| }) | |||
| ); | |||
|
|
|||
| return Object.fromEntries(results); | |||
| return Object.fromEntries(results) as TextSets; | |||
There was a problem hiding this comment.
as is a rather crude tool that should only be applied if no better tool exists, as it will actually ignore and suppress some potential errors. However, moving it to a typed variable or just setting the return type won't do the trick, because fromEntries doesn't play nice (typed as returning any).
This required updating the type system a bit as:
export enum TextSetType {
Cover = 'cover',
Step = 'step',
SectionHeader = 'section_header',
Editorial = 'editorial',
Contact = 'contact',
Table = 'table',
List = 'list',
Quote = 'quote',
}
export type TextSets = Partial<Record<TextSetType, TextSet[]>>;And then loadTextSets becomes:
export default async function loadTextSets(): Promise<TextSets> {
const results: [TextSetType, TextSet[]][] = await Promise.all(
Object.values(TextSetType).map(async (name) => [
name,
await loadTextSet(name),
])
);
return Object.fromEntries(results);
}The Partial<> is a bit annoying but I don't see a clean way around it? I feel this is cleaner, but it's probably just a nit really.
There was a problem hiding this comment.
If I am honest, I don't find your code easier to read or understand. I have pushed up my own version of the code, that is a little easier to follow. See ed4be89
There was a problem hiding this comment.
@barklund Can you take a look ?
swissspidy
approved these changes
Oct 18, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Summary
Relevant Technical Choices
To-do
User-facing changes
Testing Instructions
This PR can be tested by following these steps:
Reviews
Does this PR have a security-related impact?
Does this PR change what data or activity we track or use?
Does this PR have a legal-related impact?
Checklist
Type: XYZlabel to the PRFixes #12175