Skip to content

Add warp guard #20

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.

Sign up for GitHub

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

Merged
owjs3901 merged 1 commit into from
Dec 12, 2025
Merged

Add warp guard #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changepacks/changepack_log_s2ifFSZjZS9Av0TpjQsEW.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"changes":{"packages/generator/package.json":"Patch"},"note":"Add warp guard","date":"2025-12-12T03:17:58.146361300Z"}
15 changes: 15 additions & 0 deletions packages/generator/src/__tests__/wrap-interface-key-guard.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,18 @@ test.each([
] as const)('wrapInterfaceKeyGuard wraps key with multiple slashes: %s -> %s', (key, expected) => {
expect(wrapInterfaceKeyGuard(key)).toBe(expected)
})

test.each([
['field"name', '[`field"name`]'],
["field'name", "[`field'name`]"],
['field`name', '[`field`name`]'],
['field-name', '[`field-name`]'],
['field name', '[`field name`]'],
['field@name', '[`field@name`]'],
['field#name', '[`field#name`]'],
['field$name', 'field$name'], // $ is valid in identifiers
['field_name', 'field_name'], // _ is valid in identifiers
['123field', '[`123field`]'], // cannot start with number
] as const)('wrapInterfaceKeyGuard wraps key with forbidden characters: %s -> %s', (key, expected) => {
expect(wrapInterfaceKeyGuard(key)).toBe(expected)
})
16 changes: 15 additions & 1 deletion packages/generator/src/wrap-interface-key-guard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
export function wrapInterfaceKeyGuard(key: string): string {
if (key.includes('/') || key.includes('.')) {
// Empty string should be returned as-is
if (key === '') {
return key
}

// Check if key contains forbidden characters that require wrapping
// TypeScript identifier pattern: starts with letter/underscore/dollar, followed by letters/numbers/underscore/dollar
const isValidIdentifier = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/.test(key)

if (
!isValidIdentifier ||
key.includes('"') ||
key.includes("'") ||
key.includes('`')
) {
return `[\`${key}\`]`
}
return key
Expand Down