TypeScript: Convert wp-utils package
#12247
Merged
Conversation
This file contains hidden or 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
barklund
reviewed
Sep 8, 2022
Contributor
barklund
left a comment
barklund
left a comment
There was a problem hiding this comment.
Great start, adding some pointer to getting the last bits over the line.
Contributor
Author
|
I have one last error, than I think we are good. |
swissspidy
reviewed
Sep 8, 2022
Collaborator
swissspidy
left a comment
swissspidy
left a comment
There was a problem hiding this comment.
This should resolve the remaining type errors in snakeToCamelCase.ts:
/**
* Takes a string that is in snake case and returns the same
* term in camel case.
*
* @param string The key in snake case
* @return The key in camel case
*/
export function snakeToCamelCase(string = ''): string {
if (!string.includes('_') && !string.includes('-')) {
return string;
}
return string
.toLowerCase()
.replace(
/([a-z])([_|-][a-z])/g,
(_match, group1: string, group2: string) =>
group1 + group2.toUpperCase().replace('_', '').replace('-', '')
);
}
type ObjectOrPrimitive = SnakeOrCamelCaseObject | unknown;
interface SnakeOrCamelCaseObject {
[key: string]: ObjectOrPrimitive;
}
const isObject = (obj: unknown) =>
obj && 'object' === typeof obj && !Array.isArray(obj);
/**
* Transform a given object keys from snake case to camel case recursively.
*
* @param obj Object to be transformed.
* @param ignore Array of keys to be ignored for camelcase.
* @return Transformed object.
*/
export function snakeToCamelCaseObjectKeys(
obj: ObjectOrPrimitive,
ignore: string[] = []
): ObjectOrPrimitive {
if (!isObject(obj)) {
return obj;
}
return Object.fromEntries(
Object.entries(obj as SnakeOrCamelCaseObject).map(
([key, value]: [string, ObjectOrPrimitive]) => {
return [
snakeToCamelCase(key),
isObject(value) && !ignore.includes(key)
? snakeToCamelCaseObjectKeys(value)
: value,
] as [string, SnakeOrCamelCaseObject];
}
)
);
}
Collaborator
|
Plugin builds for 20ed6d7 are ready 🛎️!
|
Contributor
|
Size Change: -20 B (0%) Total Size: 2.68 MB
ℹ️ View Unchanged
|
swissspidy
added
Type: Infrastructure
Contributor
|
There are some non-TypeScript lint issues to fix. |
Contributor
Author
Fixed. |
swissspidy
reviewed
Sep 10, 2022
| "main": "./src/index.js", | ||
| "main": "./src/index.ts", | ||
| "types": "dist-types/index.d.ts", | ||
| "source": "src/index.ts", |
Collaborator
There was a problem hiding this comment.
Nit: this shouldn't be needed for this package
swissspidy
approved these changes
Sep 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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
Convert wp-utils to typescript.
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 #12235