Revert "feat: automatically quote property keys if necessary when wri…

…ting structures (#1451)" This reverts commit 601f214.
dsherret · Sep 15, 2023 · 055bf21 · 055bf21
1 parent 601f214
commit 055bf21
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 68 deletions.
diff --git a/packages/ts-morph/src/structurePrinters/class/GetAccessorDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/GetAccessorDeclarationStructurePrinter.ts
@@ -1,7 +1,6 @@
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { StructurePrinterFactory } from "../../factories";
 import { GetAccessorDeclarationStructure, OptionalKind } from "../../structures";
-import { WriterUtils } from "../../utils";
 import { BlankLineFormattingStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -20,8 +19,7 @@ export class GetAccessorDeclarationStructurePrinter extends NodePrinter<Optional
     this.factory.forJSDoc().printDocs(writer, structure.docs);
     this.factory.forDecorator().printTexts(writer, structure.decorators);
     this.factory.forModifierableNode().printText(writer, structure);
-    writer.write("get ");
-    WriterUtils.writePropertyName(writer, structure.name);
+    writer.write(`get ${structure.name}`);
     this.factory.forTypeParameterDeclaration().printTextsWithBrackets(writer, structure.typeParameters);
     this.factory.forParameterDeclaration().printTextsWithParenthesis(writer, structure.parameters);
     this.factory.forReturnTypedNode().printText(writer, structure);

diff --git a/packages/ts-morph/src/structurePrinters/class/MethodDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/MethodDeclarationStructurePrinter.ts
@@ -2,7 +2,7 @@ import { ObjectUtils } from "@ts-morph/common";
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { StructurePrinterFactory } from "../../factories";
 import { MethodDeclarationOverloadStructure, MethodDeclarationStructure, OptionalKind } from "../../structures";
-import { setValueIfUndefined, WriterUtils } from "../../utils";
+import { setValueIfUndefined } from "../../utils";
 import { NodePrinter } from "../NodePrinter";
 
 export class MethodDeclarationStructurePrinter extends NodePrinter<OptionalKind<MethodDeclarationStructure>> {
@@ -81,7 +81,7 @@ export class MethodDeclarationStructurePrinter extends NodePrinter<OptionalKind<
       this.factory.forDecorator().printTexts(writer, (structure as MethodDeclarationStructure).decorators);
 
     this.factory.forModifierableNode().printText(writer, structure);
-    WriterUtils.writePropertyName(writer, name);
+    writer.write(name);
     writer.conditionalWrite(structure.hasQuestionToken, "?");
     this.factory.forTypeParameterDeclaration().printTextsWithBrackets(writer, structure.typeParameters);
     this.factory.forParameterDeclaration().printTextsWithParenthesis(writer, structure.parameters);

diff --git a/packages/ts-morph/src/structurePrinters/class/PropertyDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/PropertyDeclarationStructurePrinter.ts
@@ -1,6 +1,5 @@
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { OptionalKind, PropertyDeclarationStructure } from "../../structures";
-import { WriterUtils } from "../../utils";
 import { NewLineFormattingStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -16,7 +15,7 @@ export class PropertyDeclarationStructurePrinter extends NodePrinter<OptionalKin
     this.factory.forDecorator().printTexts(writer, structure.decorators);
 
     this.factory.forModifierableNode().printText(writer, structure);
-    WriterUtils.writePropertyName(writer, structure.name);
+    writer.write(structure.name);
     writer.conditionalWrite(structure.hasQuestionToken, "?");
     writer.conditionalWrite(structure.hasExclamationToken && !structure.hasQuestionToken, "!");
     this.factory.forTypedNode(":").printText(writer, structure);

diff --git a/packages/ts-morph/src/structurePrinters/class/SetAccessorDeclarationStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/class/SetAccessorDeclarationStructurePrinter.ts
@@ -1,7 +1,6 @@
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { StructurePrinterFactory } from "../../factories";
 import { OptionalKind, SetAccessorDeclarationStructure } from "../../structures";
-import { WriterUtils } from "../../utils";
 import { BlankLineFormattingStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -21,8 +20,7 @@ export class SetAccessorDeclarationStructurePrinter extends NodePrinter<Optional
     this.factory.forDecorator().printTexts(writer, structure.decorators);
 
     this.factory.forModifierableNode().printText(writer, structure);
-    writer.write("set ");
-    WriterUtils.writePropertyName(writer, structure.name);
+    writer.write(`set ${structure.name}`);
     this.factory.forTypeParameterDeclaration().printTextsWithBrackets(writer, structure.typeParameters);
     this.factory.forParameterDeclaration().printTextsWithParenthesis(writer, structure.parameters);
     this.factory.forReturnTypedNode().printText(writer, structure);

diff --git a/packages/ts-morph/src/structurePrinters/enum/EnumMemberStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/enum/EnumMemberStructurePrinter.ts
@@ -2,7 +2,7 @@ import { StringUtils } from "@ts-morph/common";
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { EnumMemberStructure, OptionalKind } from "../../structures";
 import { WriterFunction } from "../../types";
-import { isValidVariableName, WriterUtils } from "../../utils";
+import { isValidVariableName } from "../../utils";
 import { CommaNewLineSeparatedStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -26,7 +26,12 @@ export class EnumMemberStructurePrinter extends NodePrinter<OptionalKind<EnumMem
     }
 
     this.factory.forJSDoc().printDocs(writer, structure.docs);
-    WriterUtils.writePropertyName(writer, structure.name);
+    // Adds quotes if structure is not a valid variable name
+    // AND the string is not enclosed in quotation marks
+    if (isValidVariableName(structure.name) || StringUtils.isQuoted(structure.name))
+      writer.write(structure.name);
+    else
+      writer.quote(structure.name);
 
     if (typeof structure.value === "string") {
       const { value } = structure;

diff --git a/packages/ts-morph/src/structurePrinters/interface/MethodSignatureStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/interface/MethodSignatureStructurePrinter.ts
@@ -1,6 +1,5 @@
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { MethodSignatureStructure, OptionalKind } from "../../structures";
-import { WriterUtils } from "../../utils";
 import { NewLineFormattingStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -13,7 +12,7 @@ export class MethodSignatureStructurePrinter extends NodePrinter<OptionalKind<Me
 
   protected printTextInternal(writer: CodeBlockWriter, structure: OptionalKind<MethodSignatureStructure>) {
     this.factory.forJSDoc().printDocs(writer, structure.docs);
-    WriterUtils.writePropertyName(writer, structure.name);
+    writer.write(structure.name);
     writer.conditionalWrite(structure.hasQuestionToken, "?");
     this.factory.forTypeParameterDeclaration().printTextsWithBrackets(writer, structure.typeParameters);
     this.factory.forParameterDeclaration().printTextsWithParenthesis(writer, structure.parameters);

diff --git a/packages/ts-morph/src/structurePrinters/interface/PropertySignatureStructurePrinter.ts b/packages/ts-morph/src/structurePrinters/interface/PropertySignatureStructurePrinter.ts
@@ -1,6 +1,5 @@
 import { CodeBlockWriter } from "../../codeBlockWriter";
 import { OptionalKind, PropertySignatureStructure } from "../../structures";
-import { WriterUtils } from "../../utils";
 import { NewLineFormattingStructuresPrinter } from "../formatting";
 import { NodePrinter } from "../NodePrinter";
 
@@ -14,7 +13,7 @@ export class PropertySignatureStructurePrinter extends NodePrinter<OptionalKind<
   protected printTextInternal(writer: CodeBlockWriter, structure: OptionalKind<PropertySignatureStructure>) {
     this.factory.forJSDoc().printDocs(writer, structure.docs);
     this.factory.forModifierableNode().printText(writer, structure);
-    WriterUtils.writePropertyName(writer, structure.name);
+    writer.write(structure.name);
     writer.conditionalWrite(structure.hasQuestionToken, "?");
     this.factory.forTypedNode(":").printText(writer, structure);
     // why would someone write an initializer? I guess let them do it...

diff --git a/packages/ts-morph/src/tests/structurePrinters/class/classDeclarationStructurePrinterTests.ts b/packages/ts-morph/src/tests/structurePrinters/class/classDeclarationStructurePrinterTests.ts
@@ -34,7 +34,7 @@ describe("ClassDeclarationStructurePrinter", () => {
             name: "pPrivate",
           }, {
             scope: Scope.Protected,
-            name: "p-Protected",
+            name: "pProtected",
           }],
           ctors: [{}],
           methods: [{
@@ -45,10 +45,10 @@ describe("ClassDeclarationStructurePrinter", () => {
             name: "m2",
           }, {
             scope: Scope.Public,
-            name: "m3-2",
+            name: "m3",
           }],
-          getAccessors: [{ name: "g" }, { name: "g-2" }],
-          setAccessors: [{ name: "s" }, { name: "s-2" }],
+          getAccessors: [{ name: "g" }],
+          setAccessors: [{ name: "s" }],
         };
 
         doTest(
@@ -57,30 +57,24 @@ describe("ClassDeclarationStructurePrinter", () => {
     pNoKeyword;
     public pPublic;
     private pPrivate;
-    protected "p-Protected";
+    protected pProtected;
 
     constructor() {
     }
 
     get g() {
     }
 
-    get "g-2"() {
-    }
-
     set s() {
     }
 
-    set "s-2"() {
-    }
-
     private m1() {
     }
 
     protected m2() {
     }
 
-    public "m3-2"() {
+    public m3() {
     }
 }`,
         );

diff --git a/...-morph/src/tests/structurePrinters/interface/interfaceDeclarationStructurePrinterTests.ts b/...-morph/src/tests/structurePrinters/interface/interfaceDeclarationStructurePrinterTests.ts
@@ -32,34 +32,5 @@ describe("InterfaceDeclarationStructurePrinter", () => {
         doTest({ name: "I", extends: _ => {} }, `interface I {\n}`);
       });
     });
-
-    describe("props and methods", () => {
-      it("should write properties and methods", () => {
-        // todo: more tests
-        doTest(
-          {
-            name: "I",
-            properties: [{
-              name: "prop",
-              type: "string",
-            }, {
-              name: "prop-1",
-              type: "string",
-            }],
-            methods: [{
-              name: "method",
-            }, {
-              name: "method-1",
-            }],
-          },
-          `interface I {
-    prop: string;
-    "prop-1": string;
-    method();
-    "method-1"();
-}`,
-        );
-      });
-    });
   });
 });
diff --git a/packages/ts-morph/src/utils/WriterUtils.ts b/packages/ts-morph/src/utils/WriterUtils.ts
@@ -1,6 +1,4 @@
-import { StringUtils } from "@ts-morph/common";
 import { CodeBlockWriter } from "../codeBlockWriter";
-import { isValidVariableName } from "./namingValidator";
 
 /** Utilities for code block writer. */
 export class WriterUtils {
@@ -21,13 +19,4 @@ export class WriterUtils {
     });
     return chars.join("");
   }
-
-  /* Adds quotes if structure is not a valid variable name
-   * AND the string is not enclosed in quotation marks */
-  static writePropertyName(writer: CodeBlockWriter, text: string) {
-    if (isValidVariableName(text) || StringUtils.isQuoted(text))
-      writer.write(text);
-    else
-      writer.quote(text);
-  }
 }