Merged
requested to merge github/fork/joaomlneto/javascript-generator-small-sanitization-fix into master
Created by: joaomlneto
These two fixes have already been applied to the javascript-apollo generator, so I'm just porting them here.
Sanitize module name
If we set the project name to "@myorg/mypackage" (scoped package), 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.
Do not sanitize description
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
CC Node/Javascript technical committee: @CodeNinjai @frol @cliffano
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master(6.1.0) (minor release - breaking changes with fallbacks),7.0.x(breaking changes without fallbacks) -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.