Skip to content
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

fix: schema generation when property name cannot be escaped #2018

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions src/NodeParser/TypeLiteralNodeParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,10 @@ export class TypeLiteralNodeParser implements SubNodeParser {
} catch {
// When propertyName was programmatically created, it doesn't have a source file.
// Then, getText() will throw an error. But, for programmatically created nodes,`
// `escapedText` is available.
return (propertyName as ts.Identifier).escapedText as string;
// `escapedText` or `text` is available.
// Only `text` will be available when propertyName contains strange characters and it cannot be escaped
// or if it is a number.
return ((propertyName as ts.Identifier).escapedText as string) ?? (propertyName as ts.StringLiteral).text;
}
}
}
2 changes: 2 additions & 0 deletions test/valid-data-struct.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,6 @@ describe("valid-data-struct", () => {
it("structure-anonymous", assertValidSchema("structure-anonymous", "MyObject"));
it("structure-recursion", assertValidSchema("structure-recursion", "MyObject"));
it("structure-extra-props", assertValidSchema("structure-extra-props", "MyObject"));

it("string-literal-property-names", assertValidSchema("string-literal-property-names", "*"));
});
38 changes: 38 additions & 0 deletions test/valid-data/string-literal-property-names/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// Class props has only implicit types!
export class MyClass {
PROP_1 = '';
"PROP_2" = '';
"PROP.3" = '';
"{PROP_4}" = '';
"400" = '';
500 = '';
'' = '';
CHILD = {
PROP_1: '',
"PROP_2": '',
"PROP.3": '',
"{PROP_4}": '',
"400": '',
500: '',
'': '',
};
}

export interface MyInterface {
PROP_1: string;
"PROP_2": string;
"PROP.3": string;
"{PROP_4}": string;
"400": string;
500: string;
'': string;
CHILD : {
PROP_1: string,
"PROP_2": string,
"PROP.3": string,
"{PROP_4}": string,
"400": string,
500: string,
'': string
};
}
151 changes: 151 additions & 0 deletions test/valid-data/string-literal-property-names/schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyClass": {
"additionalProperties": false,
"properties": {
"": {
"type": "string"
},
"400": {
"type": "string"
},
"500": {
"type": "string"
},
"CHILD": {
"additionalProperties": false,
"properties": {
"": {
"type": "string"
},
"400": {
"type": "string"
},
"500": {
"type": "string"
},
"PROP.3": {
"type": "string"
},
"PROP_1": {
"type": "string"
},
"PROP_2": {
"type": "string"
},
"{PROP_4}": {
"type": "string"
}
},
"required": [
"PROP_1",
"PROP_2",
"PROP.3",
"{PROP_4}",
"400",
"500",
""
],
"type": "object"
},
"PROP.3": {
"type": "string"
},
"PROP_1": {
"type": "string"
},
"PROP_2": {
"type": "string"
},
"{PROP_4}": {
"type": "string"
}
},
"required": [
"PROP_1",
"PROP_2",
"PROP.3",
"{PROP_4}",
"400",
"500",
"",
"CHILD"
],
"type": "object"
},
"MyInterface": {
"additionalProperties": false,
"properties": {
"": {
"type": "string"
},
"400": {
"type": "string"
},
"500": {
"type": "string"
},
"CHILD": {
"additionalProperties": false,
"properties": {
"": {
"type": "string"
},
"400": {
"type": "string"
},
"500": {
"type": "string"
},
"PROP.3": {
"type": "string"
},
"PROP_1": {
"type": "string"
},
"PROP_2": {
"type": "string"
},
"{PROP_4}": {
"type": "string"
}
},
"required": [
"PROP_1",
"PROP_2",
"PROP.3",
"{PROP_4}",
"400",
"500",
""
],
"type": "object"
},
"PROP.3": {
"type": "string"
},
"PROP_1": {
"type": "string"
},
"PROP_2": {
"type": "string"
},
"{PROP_4}": {
"type": "string"
}
},
"required": [
"PROP_1",
"PROP_2",
"PROP.3",
"{PROP_4}",
"400",
"500",
"",
"CHILD"
],
"type": "object"
}
}
}
Loading