Add a Make target to expand generics in schema.json (#1763)

Author: swallez

Makefile

@@ -44,6 +44,9 @@ clean-dep:	## Clean npm dependencies
 	@rm -rf compiler/node_modules
 	@rm -rf typescript-generator/node_modules
 
+transform-expand-generics: ## Create a new schema with all generics expanded
+	@npm run transform-expand-generics --prefix compiler
+
 contrib: | generate license-check spec-format-fix 	## Pre contribution target
 
 help:  ## Display help

compiler/package.json

@@ -9,6 +9,7 @@
     "format:check": "prettier --config .prettierrc.json --check ../specification/",
     "format:fix": "prettier --config .prettierrc.json --write ../specification/",
     "generate-schema": "ts-node src/index.ts",
+    "transform-expand-generics": "ts-node src/transform/expand-generics.ts",
     "compile:specification": "tsc --project ../specification/tsconfig.json --noEmit",
     "build": "rm -rf lib && tsc",
     "validate-ts-view": "tsc --noEmit ../output/typescript/types.ts",

compiler/src/model/build-model.ts

@@ -54,7 +54,7 @@ import {
   verifyUniqueness,
   parseJsDocTags,
   deepEqual,
-  sourceLocation
+  sourceLocation, sortTypeDefinitions
 } from './utils'
 
 const jsonSpec = buildJsonSpec()
@@ -150,17 +150,7 @@ export function compileSpecification (endpointMappings: Record<string, model.End
   }
 
   // Sort the types in alphabetical order
-  model.types.sort((a, b) => {
-    if (a.name.namespace === b.name.namespace) {
-      if (a.name.name > b.name.name) return 1
-      if (a.name.name < b.name.name) return -1
-      return 0
-    }
-
-    if (a.name.namespace > b.name.namespace) return 1
-    if (a.name.namespace < b.name.namespace) return -1
-    return 0
-  })
+  sortTypeDefinitions(model.types)
 
   return model
 }

compiler/src/model/utils.ts

@@ -1278,3 +1278,20 @@ export function sourceLocation (node: Node): string {
   const sourceFile = node.getSourceFile()
   return `${sourceFile.getFilePath().replace(basePath, '')}#L${node.getStartLineNumber(true)}-L${node.getEndLineNumber()}`
 }
+
+/**
+ * Sort an array of type definitions by type name
+ */
+export function sortTypeDefinitions (types: model.TypeDefinition[]): void {
+  types.sort((a, b) => {
+    if (a.name.namespace === b.name.namespace) {
+      if (a.name.name > b.name.name) return 1
+      if (a.name.name < b.name.name) return -1
+      return 0
+    }
+
+    if (a.name.namespace > b.name.namespace) return 1
+    if (a.name.namespace < b.name.namespace) return -1
+    return 0
+  })
+}