loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Javascript Generator: two small sanitization changes 🦠 (#13268)

Browse Source 
* Javascript Generator: small sanitization changes

Sanitize module name, do not sanitize description.

If we set the project name to "@myorg/mypackage" (scoped package[1]), running `npm test` will fail, as it will generate faulty code due to the module name including the '@' symbol, which is not a valid JS identifier.

Additionally, we don't need to sanitize the description - spaces and special characters are fine. We just need to make sure they are escaped, which we're already doing by invoking escapeText() on line 329

[1]anitize module name, do not sanitize description

* update JS samples
This commit is contained in:
João Neto 2022-08-24 17:18:30 +02:00 committed by GitHub
parent b9a6be0cba
commit 1a5d3926b3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavascriptClientCodegen.java
View File

@ -296,7 +296,7 @@ public class JavascriptClientCodegen extends DefaultCodegen implements CodegenCo
if (StringUtils.isEmpty(info.getDescription())) { if (StringUtils.isEmpty(info.getDescription())) {
projectDescription = "JS API client generated by OpenAPI Generator"; projectDescription = "JS API client generated by OpenAPI Generator";
} else { } else {
projectDescription = sanitizeName(info.getDescription()); projectDescription = info.getDescription();
} }
} }
@ -312,7 +312,7 @@ public class JavascriptClientCodegen extends DefaultCodegen implements CodegenCo
projectName = "openapi-js-client"; projectName = "openapi-js-client";
} }
if (StringUtils.isBlank(moduleName)) { if (StringUtils.isBlank(moduleName)) {
moduleName = camelize(underscore(projectName)); moduleName = camelize(underscore(sanitizeName(projectName)));
} }
if (StringUtils.isBlank(projectVersion)) { if (StringUtils.isBlank(projectVersion)) {
projectVersion = "1.0.0"; projectVersion = "1.0.0";

2
samples/client/petstore/javascript-es6/package.json
View File

@ -1,7 +1,7 @@
{ {
"name": "open_api_petstore", "name": "open_api_petstore",
"version": "1.0.0", "version": "1.0.0",
"description": "This_spec_is_mainly_for_testing_Petstore_server_and_contains_fake_endpoints_models__Please_do_not_use_this_for_any_other_purpose__Special_characters___", "description": "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\",
"license": "Apache-2.0", "license": "Apache-2.0",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {

2
samples/client/petstore/javascript-es6/src/index.js
View File

@ -69,7 +69,7 @@ import UserApi from './api/UserApi';
/** /**
* This_spec_is_mainly_for_testing_Petstore_server_and_contains_fake_endpoints_models__Please_do_not_use_this_for_any_other_purpose__Special_characters___.<br> * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \&quot; \\.<br>
* The <code>index</code> module provides access to constructors for all the classes which comprise the public API. * The <code>index</code> module provides access to constructors for all the classes which comprise the public API.
* <p> * <p>
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:

2
samples/client/petstore/javascript-promise-es6/package.json
View File

@ -1,7 +1,7 @@
{ {
"name": "open_api_petstore", "name": "open_api_petstore",
"version": "1.0.0", "version": "1.0.0",
"description": "This_spec_is_mainly_for_testing_Petstore_server_and_contains_fake_endpoints_models__Please_do_not_use_this_for_any_other_purpose__Special_characters___", "description": "This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\",
"license": "Apache-2.0", "license": "Apache-2.0",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {

2
samples/client/petstore/javascript-promise-es6/src/index.js
View File

@ -69,7 +69,7 @@ import UserApi from './api/UserApi';
/** /**
* This_spec_is_mainly_for_testing_Petstore_server_and_contains_fake_endpoints_models__Please_do_not_use_this_for_any_other_purpose__Special_characters___.<br> * This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \&quot; \\.<br>
* The <code>index</code> module provides access to constructors for all the classes which comprise the public API. * The <code>index</code> module provides access to constructors for all the classes which comprise the public API.
* <p> * <p>
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: * An AMD (recommended!) or CommonJS application will generally do something equivalent to the following: