Skip to content

Commit 12d3a0c

Browse files
committed
support x prefix name
1 parent 7920ac5 commit 12d3a0c

1 file changed

Lines changed: 12 additions & 3 deletions

File tree

tools/proto-convert/src/Sanitizer.ts

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
import _ from "lodash";
22
import type {OpenAPIV3} from "openapi-types";
33
import {traverse} from "./utils/OpenApiTraverser";
4+
import Logger from "./utils/logger";
45
/**
56
* Sanitizer class:
67
* Provides a static method to sanitize a spec by updating $ref strings
78
* and renaming schema definitions.
89
*/
910
export class Sanitizer {
11+
logger: Logger;
12+
13+
constructor(logger: Logger = new Logger()) {
14+
this.logger = logger;
15+
}
16+
1017
public sanitize(spec: any): any {
1118
this.sanitize_ref(spec);
1219
this.sanitize_spec_name(spec as OpenAPIV3.Document);
@@ -73,7 +80,9 @@ export class Sanitizer {
7380
onResponseSchema: (schema) => this.sanitize_schema(schema),
7481
onParameter: (param, _paramName) => {
7582
if (param.name.startsWith('_')) {
76-
param.name = `underscore${param.name}`;
83+
const oldName = param.name;
84+
param.name = `x${param.name}`;
85+
this.logger.info(`Renamed parameter: ${oldName} -> ${param.name}`);
7786
}
7887
}
7988
});
@@ -93,7 +102,7 @@ export class Sanitizer {
93102
public rename_properties_name(properties: Record<string, OpenAPIV3.SchemaObject>) {
94103
for (var propName in properties) {
95104
if(propName.startsWith("_")) {
96-
const newPropName = "underscore" + propName;
105+
const newPropName = "x" + propName;
97106
properties[newPropName] = properties[propName];
98107
delete properties[propName];
99108
}
@@ -104,7 +113,7 @@ export class Sanitizer {
104113
for (var index in requireList) {
105114
var propName = requireList[index];
106115
if(propName.startsWith("_")) {
107-
requireList[index] = "underscore" + propName;
116+
requireList[index] = "x" + propName;
108117
}
109118
}
110119
}

0 commit comments

Comments
 (0)