perf:refactor code about create file and fulfill question

Author: wh131462

common/utils/question-handler/createQuestion.js

@@ -1,7 +1,6 @@
 import fs from 'node:fs'
 import path from 'node:path'
 import { fulfillQuestion } from '#common/utils/question-handler/fulfillQuestion.js'
-import { template } from '#resources/template/template.js'
 import { getQuestionFileExtension } from '#common/utils/question-handler/questionLanguage.js'
 
 /**
@@ -18,7 +17,9 @@ export function createQuestion(question, questionDir) {
         `question${getQuestionFileExtension(question.lang)}`,
       ),
     )
-    if (fs.existsSync(filePath)) { resolve(false) }
+    if (fs.existsSync(filePath)) {
+      resolve(false)
+    }
     else {
       createQuestionFile(questionDir, filePath, question)
         .then(path => resolve(path))
@@ -29,12 +30,12 @@ export function createQuestion(question, questionDir) {
 export function createQuestionFile(questionDir, questionFilePath, question) {
   return new Promise((resolve, reject) => {
     try {
+      // 创建题目的目录
       fs.mkdir(questionDir, { recursive: true }, () => {
-        fs.writeFile(questionFilePath, template, null, () => {
-          fulfillQuestion(questionFilePath, question).then(() =>
-            resolve(questionFilePath),
-          )
-        })
+        // 写入文件和模板
+        fulfillQuestion(questionFilePath, question).then(() =>
+          resolve(questionFilePath),
+        )
       })
     }
     catch (e) {

common/utils/question-handler/fulfillQuestion.js

@@ -1,15 +1,20 @@
 import fs from 'node:fs'
 import { removeDomTags } from '../functions/removeDomTags.js'
 import { getTestCase } from './getTestCase.js'
-import { getQuestionUrl } from './getQuestionUrl.js'
 import { createMarkdown } from './createMarkdown.js'
 import { getQuestionChineseName } from '#common/utils/question-handler/getQuestionChineseName.js'
+import { getConsoleText } from '#common/utils/question-handler/getConsoleText.js'
+import { template } from '#resources/template/template.js'
+import { setBlockComment } from '#common/utils/question-handler/questionLanguage.js'
 
 /**
  * @typedef {object} Question
  * @property {string} title
+ * @property {string} title
  * @property {number} date
  * @property {string} detail
+ * @property {string} lang
+ * @property {string} code
  */
 
 /**
@@ -22,42 +27,34 @@ import { getQuestionChineseName } from '#common/utils/question-handler/getQuesti
  * @param {Question} question
  *
  */
-export function generateTemplateContent(data, question) {
-  return data
-    .replace(
-      '@题目',
-      `${getQuestionChineseName(question)} ${question.date ? `[${question.date}]` : ''}`,
-    )
-    .replace(
-      '@描述',
-      removeDomTags(question.detail)
-        .replace('@url', question.url)
-        .replace(/\n+/g, '\n')
-        .replaceAll('\n', '\n * '),
-    )
-    .replace('// @Function', question.code)
-    .replace('// @TestCase', getTestCase(question))
-    .replace('@url', getQuestionUrl(question.slug))
+export function generateTemplateContent(question) {
+  const title = `${getQuestionChineseName(question)} ${question.date ? `[${question.date}]` : ''}\n`
+  const describe = removeDomTags(question.detail).replace(/\n+/g, '\n')
+  const code = question.code
+  return template
+    .replace('@Title', setBlockComment(question.lang, title + describe))
+    .replace('@Describe', '')
+    .replace('@Function', code)
+    .replace('@TestCase', getTestCase(question))
+    .replace('@Console', getConsoleText(question))
 }
 /**
- * 填充模板文件
+ * 模板文件内容替换并生成文件
  * @param questionPath
  * @param question
  */
 export function fulfillQuestion(questionPath, question) {
   return new Promise((resolve) => {
+    // 创建描述文件 md
+    createMarkdown(question.detail, questionPath)
+    // 创建填充内容并创建
     // 开始填充内容
-    fs.readFile(questionPath, 'utf8', (err, data) => {
+    const newData = generateTemplateContent(question)
+    // 创建文件
+    fs.writeFile(questionPath, newData, (err) => {
       if (err)
         throw err
-      // 修改文件内容
-      const newData = generateTemplateContent(data, question)
-      createMarkdown(question.detail, questionPath)
-      fs.writeFile(questionPath, newData, (err) => {
-        if (err)
-          throw err
-        resolve()
-      })
+      resolve()
     })
   })
 }

common/utils/question-handler/getConsoleText.js

@@ -0,0 +1,11 @@
+import { DefaultLang } from '#common/constants/question.const.js'
+import { getQuestionUrl } from '#common/utils/question-handler/getQuestionUrl.js'
+import { setLineComment } from '#common/utils/question-handler/questionLanguage.js'
+
+export function getConsoleText(question) {
+  const url = getQuestionUrl(question.slug)
+  if (question.lang === DefaultLang)
+    return `console.log('点击跳转到题目提交: ${url}');`
+  else
+    return setLineComment(question.lang, `题目地址：${url}`)
+}

common/utils/question-handler/getHot100QuestionList.js common/utils/question-handler/getHot100QuestionListCode.js

@@ -20,7 +20,7 @@ async function getPromiseList() {
   )
 }
 
-export async function getHot100QuestionListJSCode() {
+export async function getHot100QuestionListCode() {
   const promiseList = await getPromiseList()
   return await Promise.all(promiseList)
 }

common/utils/question-handler/getTestCase.js

@@ -1,6 +1,7 @@
 import { removeDomTags } from '../functions/removeDomTags.js'
 import { getDataStructure } from './parseStructure.js'
 import { DefaultLang } from '#common/constants/question.const.js'
+import { setBlockComment } from '#common/utils/question-handler/questionLanguage.js'
 
 /**
  * test case 需要从两个地方拿到内容
@@ -48,14 +49,18 @@ export function getTestCase(question) {
   }
   else {
     // 其他语言无法支持测试 只能提供测试数据
-    console.log(cases, expires)
-    let showText = `\/* 暂无法支持除JS外的语言测试,提取的一些入参和返回值供自行测试，每一个case中的第一行为入参，第二行为返回值\n`
-    for (let i = 0; i < Math.max(cases.length, expires.length); i++) {
+    // 生成注释语句
+    let showText = `暂无法支持除JS外的语言测试,提取的一些入参和返回值供自行测试，每一个case中的第一行为入参，第二行为返回值\n`
+    for (
+      let i = 0;
+      i < Math.max(cases?.length ?? 0, expires?.length ?? 0);
+      i++
+    ) {
       showText += `case ${i + 1}:\n`
       showText += `${cases?.[i]}\n` ?? '[参数获取错误]\n'
       showText += `${expires?.[i]}\n` ?? '[返回值获取错误]\n'
     }
-    showText += `\n*\/`
-    return showText
+    showText += `\n`
+    return setBlockComment(question.lang, showText)
   }
 }