add "module" to reservedKeywords (#167)

* add "module" to reservedKeywords * Add changelog * Update changelog Co-authored-by: Damian Rusak <[email protected]>
palantir · Sep 15, 2021 · 2a910c3 · 2a910c3
1 parent fc1d326
commit 2a910c3
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/changelog/@unreleased/pr-167.v2.yml b/changelog/@unreleased/pr-167.v2.yml
@@ -0,0 +1,5 @@
+type: break
+break:
+  description: Add `module` to reserved keywords. This can break generated types with fields called `module` which get renamed to `module_`.
+  links:
+  - https://github.com/palantir/conjure-typescript/pull/167
diff --git a/src/commands/generate/utils.ts b/src/commands/generate/utils.ts
@@ -41,6 +41,7 @@ export function isValidFunctionName(value: string) {
 }
 
 // Keywords taken from https://github.com/Microsoft/TypeScript/blob/master/doc/spec.md#221-reserved-words
+// with the addition of some build tools' specific keywords like "module"
 const reservedKeywords = new Set([
     "break",
     "case",
@@ -66,6 +67,7 @@ const reservedKeywords = new Set([
     "instanceof",
     "new",
     "null",
+    "module",
     "return",
     "super",
     "switch",