Skip to content

Removed invalid tokens from generic type names #461

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

Closed
wants to merge 1 commit into from
Closed

Removed invalid tokens from generic type names #461

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
5 changes: 4 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
},
"devDependencies": {
"@types/chai": "^4.2.21",
"@types/lodash": "^4.14.178",
"@types/glob": "^7.1.4",
"@types/mocha": "^9.0.0",
"ajv": "^8.6.3",
Expand All @@ -64,7 +65,9 @@
"mocha": "^9.1.3",
"prettier": "^2.4.1",
"source-map-support": "^0.5.20",
"tslint": "^6.1.3"
"tslint": "^6.1.3",
"jsonpath-plus": "^6.0.1",
"lodash": "^4.17.21"
},
"scripts": {
"prepare": "tsc",
Expand Down
8 changes: 4 additions & 4 deletions test/programs/generic-anonymous/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric<number,string>": {
"MyGeneric_number_string_": {
"properties": {
"a": {
"type": "number"
Expand All @@ -16,7 +16,7 @@
],
"type": "object"
},
"MyGeneric<string,number>": {
"MyGeneric_string_number_": {
"properties": {
"a": {
"type": "string"
Expand All @@ -34,10 +34,10 @@
},
"properties": {
"value1": {
"$ref": "#/definitions/MyGeneric<string,number>"
"$ref": "#/definitions/MyGeneric_string_number_"
},
"value2": {
"$ref": "#/definitions/MyGeneric<number,string>"
"$ref": "#/definitions/MyGeneric_number_string_"
}
},
"required": [
Expand Down
36 changes: 18 additions & 18 deletions test/programs/generic-hell/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"GenericA<\"alias\">": {
"GenericA_\"alias\"_": {
"properties": {
"a": {
"enum": [
Expand All @@ -15,7 +15,7 @@
],
"type": "object"
},
"GenericA<1>": {
"GenericA_1_": {
"properties": {
"a": {
"enum": [
Expand All @@ -29,7 +29,7 @@
],
"type": "object"
},
"GenericA<string>": {
"GenericA_string_": {
"properties": {
"a": {
"type": "string"
Expand All @@ -40,7 +40,7 @@
],
"type": "object"
},
"GenericC<\"alias\">": {
"GenericC_\"alias\"_": {
"properties": {
"c": {
"enum": [
Expand All @@ -54,7 +54,7 @@
],
"type": "object"
},
"GenericC<2>": {
"GenericC_2_": {
"properties": {
"c": {
"enum": [
Expand All @@ -68,29 +68,29 @@
],
"type": "object"
},
"GenericC<GenericA<string>>": {
"GenericC_GenericA_string__": {
"properties": {
"c": {
"$ref": "#/definitions/GenericA<string>"
"$ref": "#/definitions/GenericA_string_"
}
},
"required": [
"c"
],
"type": "object"
},
"GenericC<GenericC<GenericA<string>>>": {
"GenericC_GenericC_GenericA_string___": {
"properties": {
"c": {
"$ref": "#/definitions/GenericC<GenericA<string>>"
"$ref": "#/definitions/GenericC_GenericA_string__"
}
},
"required": [
"c"
],
"type": "object"
},
"SomeGeneric<\"alias\",\"alias\">": {
"SomeGeneric_\"alias\",\"alias\"_": {
"properties": {
"a": {
"enum": [
Expand All @@ -105,10 +105,10 @@
"type": "string"
},
"c": {
"$ref": "#/definitions/GenericA<\"alias\">"
"$ref": "#/definitions/GenericA_\"alias\"_"
},
"d": {
"$ref": "#/definitions/GenericC<\"alias\">"
"$ref": "#/definitions/GenericC_\"alias\"_"
}
},
"required": [
Expand All @@ -119,7 +119,7 @@
],
"type": "object"
},
"SomeGeneric<1,2>": {
"SomeGeneric_1_2_": {
"properties": {
"a": {
"enum": [
Expand All @@ -134,10 +134,10 @@
"type": "number"
},
"c": {
"$ref": "#/definitions/GenericA<1>"
"$ref": "#/definitions/GenericA_1_"
},
"d": {
"$ref": "#/definitions/GenericC<2>"
"$ref": "#/definitions/GenericC_2_"
}
},
"required": [
Expand All @@ -154,13 +154,13 @@
"type": "number"
},
"c": {
"$ref": "#/definitions/GenericC<GenericC<GenericA<string>>>"
"$ref": "#/definitions/GenericC_GenericC_GenericA_string___"
},
"someAlias": {
"$ref": "#/definitions/SomeGeneric<\"alias\",\"alias\">"
"$ref": "#/definitions/SomeGeneric_\"alias\",\"alias\"_"
},
"someGeneric": {
"$ref": "#/definitions/SomeGeneric<1,2>"
"$ref": "#/definitions/SomeGeneric_1_2_"
}
},
"required": [
Expand Down
8 changes: 4 additions & 4 deletions test/programs/generic-multiargs/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric<number,string>": {
"MyGeneric_number_string_": {
"properties": {
"a": {
"type": "number"
Expand All @@ -16,7 +16,7 @@
],
"type": "object"
},
"MyGeneric<string,number>": {
"MyGeneric_string_number_": {
"properties": {
"a": {
"type": "string"
Expand All @@ -34,10 +34,10 @@
},
"properties": {
"value1": {
"$ref": "#/definitions/MyGeneric<string,number>"
"$ref": "#/definitions/MyGeneric_string_number_"
},
"value2": {
"$ref": "#/definitions/MyGeneric<number,string>"
"$ref": "#/definitions/MyGeneric_number_string_"
}
},
"required": [
Expand Down
8 changes: 4 additions & 4 deletions test/programs/generic-multiple/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric<number>": {
"MyGeneric_number_": {
"properties": {
"field": {
"type": "number"
Expand All @@ -12,7 +12,7 @@
],
"type": "object"
},
"MyGeneric<string>": {
"MyGeneric_string_": {
"properties": {
"field": {
"type": "string"
Expand All @@ -26,10 +26,10 @@
},
"properties": {
"value1": {
"$ref": "#/definitions/MyGeneric<number>"
"$ref": "#/definitions/MyGeneric_number_"
},
"value2": {
"$ref": "#/definitions/MyGeneric<string>"
"$ref": "#/definitions/MyGeneric_string_"
}
},
"required": [
Expand Down
10 changes: 5 additions & 5 deletions test/programs/generic-recursive/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@
"$ref": "#/definitions/MyObject",
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric<number,string>": {
"MyGeneric_number_string_": {
"properties": {
"field": {
"$ref": "#/definitions/MyGeneric<string,number>"
"$ref": "#/definitions/MyGeneric_string_number_"
}
},
"required": [
"field"
],
"type": "object"
},
"MyGeneric<string,number>": {
"MyGeneric_string_number_": {
"properties": {
"field": {
"$ref": "#/definitions/MyGeneric<number,string>"
"$ref": "#/definitions/MyGeneric_number_string_"
}
},
"required": [
Expand All @@ -27,7 +27,7 @@
"MyObject": {
"properties": {
"value": {
"$ref": "#/definitions/MyGeneric<string,number>"
"$ref": "#/definitions/MyGeneric_string_number_"
}
},
"required": [
Expand Down
7 changes: 7 additions & 0 deletions test/programs/generic-simple-unique/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface MyGeneric<T> {
field: T;
}

export interface MyObject {
value: MyGeneric<number>;
}
26 changes: 26 additions & 0 deletions test/programs/generic-simple-unique/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric_number_.7590b3ed": {
"properties": {
"field": {
"type": "number"
}
},
"required": [
"field"
],
"type": "object"
}
},
"properties": {
"value": {
"$ref": "#/definitions/MyGeneric_number_.7590b3ed"
}
},
"required": [
"value"
],
"type": "object"
}

4 changes: 2 additions & 2 deletions test/programs/generic-simple/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"MyGeneric<number>": {
"MyGeneric_number_": {
"properties": {
"field": {
"type": "number"
Expand All @@ -15,7 +15,7 @@
},
"properties": {
"value": {
"$ref": "#/definitions/MyGeneric<number>"
"$ref": "#/definitions/MyGeneric_number_"
}
},
"required": [
Expand Down
11 changes: 10 additions & 1 deletion test/schema.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { readFileSync } from "fs";
import { resolve } from "path";
import { versionMajorMinor as typescriptVersionMajorMinor } from "typescript";
import * as TJS from "../typescript-json-schema";
import {JSONPath} from "jsonpath-plus";
import {isEmpty} from "lodash";

let ajvWarnings: string[] = [];
const ajv = new Ajv({
Expand Down Expand Up @@ -47,7 +49,6 @@ export function assertSchema(

const files = [resolve(BASE + group + "/main.ts")];
const actual = TJS.generateSchema(TJS.getProgramFromFiles(files, compilerOptions), type, settings, files);

// writeFileSync(BASE + group + "/schema.json", stringify(actual, {space: 4}) + "\n\n");

const file = readFileSync(BASE + group + "/schema.json", "utf8");
Expand All @@ -68,6 +69,13 @@ export function assertSchema(
ajv.compile(actual);
assert.deepEqual(ajvWarnings, ajvOptions.expectedWarnings || [], "Got unexpected AJV warnings");
}

const refs:{$ref: string}[] = JSONPath({path: "$..[?(@ && @.$ref)]", json: actual});
if (!isEmpty(refs)) {
assert.isTrue(refs.every(({$ref: r}) => {
return !(/[<>,]/.test(r));
}));
}
}
});
}
Expand Down Expand Up @@ -282,6 +290,7 @@ describe("schema", () => {

describe("generics", () => {
assertSchema("generic-simple", "MyObject");
assertSchema("generic-simple-unique", "MyObject", {uniqueNames: true});
assertSchema("generic-arrays", "MyObject");
assertSchema("generic-multiple", "MyObject");
assertSchema("generic-multiargs", "MyObject");
Expand Down
Loading