fix: fix bug #640

Author: rookie-luochao

.changeset/soft-icons-lay.md

@@ -0,0 +1,5 @@
+---
+'openapi-ts-request': patch
+---
+
+fix: fix bug #640

src/generator/serviceGenarator.ts

@@ -77,6 +77,7 @@ import type {
 import { type MergeOption } from './type';
 import {
   capitalizeFirstLetter,
+  escapeStringForJs,
   genDefaultFunctionName,
   getAxiosResponseType,
   getBasePrefix,
@@ -1156,6 +1157,7 @@ export default class ServiceGenerator {
       });
 
       env.addFilter('capitalizeFirst', capitalizeFirstLetter);
+      env.addFilter('escapeJs', escapeStringForJs);
       const destPath = join(this.config.serversPath, fileName);
       const destCode = nunjucks.renderString(template, {
         disableTypeCheck: false,

src/generator/util.ts

@@ -594,6 +594,20 @@ export function capitalizeFirstLetter(str: string) {
   return str.replace(/^[a-z]/, (match) => match.toUpperCase());
 }
 
+/**
+ * 转义字符串，用于 JavaScript 字符串字面量
+ * 将换行符、单引号等特殊字符转义为转义序列
+ */
+export function escapeStringForJs(str: string): string {
+  if (!str) return str;
+  return str
+    .replace(/\\/g, '\\\\') // 先转义反斜杠
+    .replace(/'/g, "\\'") // 转义单引号
+    .replace(/\n/g, '\\n') // 转义换行符
+    .replace(/\r/g, '\\r') // 转义回车符
+    .replace(/\t/g, '\\t'); // 转义制表符
+}
+
 // 解析 description 中的枚举翻译
 export const parseDescriptionEnum = (
   description: string

templates/displayTypeLabel.njk

@@ -23,7 +23,7 @@ import * as {{ namespace }} from './{{ interfaceFileName }}';
             {%- if p["$ref"] and not p.name %}
               display{{ p.type | safe }}(field as keyof {{ namespace }}.{{ p.type }})
             {%- else %}
-              {{ p.name }}: '{{ p.desc if p.desc else p.name }}',
+              {{ p.name }}: '{{ (p.desc if p.desc else p.name) | escapeJs }}',
             {%- endif %}
           {%- endfor %}
         {%- if prop.length > 1 %}

test/__snapshots__/common/测试描述信息支持换行.snap

@@ -16,9 +16,24 @@ export function displayMajorEnum(field: API.Major) {
 }
 /* eslint-disable */
 // @ts-ignore
+import * as API from './types';
+
+export function displayStudent(field: keyof API.Student) {
+  return {
+    name: 'name',
+    age: 'age',
+    gender: 'gender',
+    major:
+      '\n * Major enum \n * COMPUTER SCIENCE: Computer Science\n * MATHEMATICS: Mathematics\n * PHYSICS: Physics\n * LITERATURE: Literature\n',
+  }[field];
+}
+/* eslint-disable */
+// @ts-ignore
 export * from './types';
 export * from './displayEnumLabel';
 
+export * from './displayTypeLabel';
+
 export * from './student';
 /* eslint-disable */
 // @ts-ignore