Fix escaping in kanel-kysely

kristiandupont · Dec 7, 2023 · d7ed61c · d7ed61c
1 parent fbb8d43
commit d7ed61c
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 12 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/kanel-kysely/src/MakeKyselyConfig.ts b/packages/kanel-kysely/src/MakeKyselyConfig.ts
@@ -1,4 +1,4 @@
-import { CompositeDetails, InstantiatedConfig } from "kanel";
+import { CompositeDetails, escapeIdentifier, InstantiatedConfig } from "kanel";
 
 interface MakeKyselyConfig {
   databaseFilename: string;
@@ -19,10 +19,14 @@ interface MakeKyselyConfig {
 export const defaultConfig: MakeKyselyConfig = {
   databaseFilename: "Database",
   getKyselyItemMetadata: (d, selectorName, canInitialize, canMutate) => ({
-    tableInterfaceName: `${selectorName}Table`,
-    selectableName: selectorName,
-    insertableName: canInitialize ? `New${selectorName}` : undefined,
-    updatableName: canMutate ? `${selectorName}Update` : undefined,
+    tableInterfaceName: `${escapeIdentifier(selectorName)}Table`,
+    selectableName: escapeIdentifier(selectorName),
+    insertableName: canInitialize
+      ? `New${escapeIdentifier(selectorName)}`
+      : undefined,
+    updatableName: canMutate
+      ? `${escapeIdentifier(selectorName)}Update`
+      : undefined,
   }),
 };
 

diff --git a/packages/kanel-kysely/src/processFile.ts b/packages/kanel-kysely/src/processFile.ts
@@ -194,7 +194,7 @@ const processFile = (
   }
 
   const tableImport: TypeImport = {
-    name: `${selectorName}Table`,
+    name: tableInterfaceName,
     isDefault: true,
     path,
     isAbsolute: false,

diff --git a/packages/kanel/src/ImportGenerator.ts b/packages/kanel/src/ImportGenerator.ts
@@ -1,5 +1,6 @@
 import path from "path";
 
+import escapeString from "./escapeString";
 import TypeImport from "./TypeImport";
 
 type ImportSet = {
@@ -114,7 +115,9 @@ class ImportGenerator {
         importParts.push(bracketedImportString);
       }
 
-      const line = `import ${importParts.join(", ")} from '${relativePath}';`;
+      const line = `import ${importParts.join(", ")} from '${escapeString(
+        relativePath,
+      )}';`;
       return [line];
     });
   }

diff --git a/packages/kanel/src/escapeFieldName.ts b/packages/kanel/src/escapeFieldName.ts
@@ -1,3 +1,5 @@
+import escapeString from "./escapeString";
+
 /** Used for object fields. If the name is illegal Typescript, put it in quotes. */
 const escapeFieldName = (name: string): string => {
   let isLegalIdentifier = true;
@@ -12,7 +14,7 @@ const escapeFieldName = (name: string): string => {
     isLegalIdentifier = false;
   }
 
-  return isLegalIdentifier ? name : `'${name}'`;
+  return isLegalIdentifier ? name : `'${escapeString(name)}'`;
 };
 
 export default escapeFieldName;
diff --git a/packages/kanel/src/generators/resolveType.ts b/packages/kanel/src/generators/resolveType.ts
@@ -10,7 +10,6 @@ import { tryParse } from "tagged-comment-parser";
 
 import { InstantiatedConfig } from "../config-types";
 import Details from "../Details";
-import escapeIdentifier from "../escapeIdentifier";
 import TypeDefinition from "../TypeDefinition";
 import { CompositeDetails, CompositeProperty } from "./composite-types";
 
@@ -166,7 +165,7 @@ const resolveType = (
     );
 
     return {
-      name: escapeIdentifier(name),
+      name,
       typeImports: [
         {
           name,

diff --git a/packages/kanel/src/index.ts b/packages/kanel/src/index.ts
@@ -2,7 +2,12 @@ export * from "./config-types";
 export * from "./declaration-types";
 export * from "./default-metadata-generators";
 export { default as Details } from "./Details";
+export { default as escapeComment } from "./escapeComment";
 export { default as escapeFieldName } from "./escapeFieldName";
+// For backwards compatibility
+export { default as escapeName } from "./escapeFieldName";
+export { default as escapeIdentifier } from "./escapeIdentifier";
+export { default as escapeString } from "./escapeString";
 export {
   CompositeDetails,
   CompositeProperty,