fix: plugin 格式处理

Author: sunlin92

script/lib/generate-plugin-config.js

@@ -1,16 +1,27 @@
 const fs = require('fs-extra')
 const path = require('path')
 const ejs = require('ejs')
+const prettier = require('prettier')
 const getAllPlugin = require('./plugin-get-all')
 
-function generatePluginConfig() {
-  const targetPath = path.resolve(__dirname, '../../src/config/stage/plugin.js')
-  const pluginsPath = path.resolve(__dirname, '../../src/plugin')
-  const templatePath = path.resolve(__dirname, '../template/plugin-stage-config.js.ejs')
+const targetPath = path.resolve(__dirname, '../../src/config/stage/plugin.js')
+const pluginsPath = path.resolve(__dirname, '../../src/plugin')
+const templatePath = path.resolve(__dirname, '../template/plugin-stage-config.js.ejs')
 
+async function renderPluginConfig(plugins) {
   const template = fs.readFileSync(templatePath, 'utf8')
-  const plugins = getAllPlugin(pluginsPath)
   const result = ejs.render(template, { plugins })
+  const prettierConfig = (await prettier.resolveConfig(targetPath)) || {}
+
+  return prettier.format(result, {
+    ...prettierConfig,
+    filepath: targetPath,
+  })
+}
+
+async function generatePluginConfig() {
+  const plugins = getAllPlugin(pluginsPath)
+  const result = await renderPluginConfig(plugins)
 
   fs.outputFileSync(targetPath, result)
 
@@ -22,3 +33,4 @@ function generatePluginConfig() {
 }
 
 module.exports = generatePluginConfig
+module.exports.renderPluginConfig = renderPluginConfig

script/plugin-get-config.js

@@ -4,8 +4,20 @@ const generatePluginConfig = require('./lib/generate-plugin-config')
 
 const targetDir = path.resolve(__dirname, '../src/config/stage/plugin.js')
 
-console.log(chalk.green('配置插件...'))
+async function main() {
+  console.log(chalk.green('配置插件...'))
 
-generatePluginConfig()
+  await generatePluginConfig()
 
-console.log(chalk.green(`插件配置完成: ${targetDir}\n`))
+  console.log(chalk.green(`插件配置完成: ${targetDir}\n`))
+}
+
+if (require.main === module) {
+  main().catch(error => {
+    console.log(chalk.red('插件配置失败'))
+    console.error(error)
+    process.exit(1)
+  })
+}
+
+module.exports = main

script/plugin-init.js

@@ -85,6 +85,10 @@ async function handler() {
   })
 }
 
-handler().then(() => {
-  require('./plugin-get-config')
-})
+handler()
+  .then(() => require('./plugin-get-config')())
+  .catch(error => {
+    console.log(chalk.red('插件初始化失败'))
+    console.error(error)
+    process.exit(1)
+  })

script/plugin-new.js

@@ -140,7 +140,7 @@ inquirer
     console.log(chalk.green(`创建插件 ${answers.name}: ${targetPath}`))
   })
   .then(() => {
-    require('./plugin-get-config.js')
+    return require('./plugin-get-config.js')()
   })
   .catch(err => {
     console.log(chalk.red('创建插件失败'))

script/template/plugin-stage-config.js.ejs

@@ -1,9 +1,19 @@
-// 本文件是自动生成, 请勿修改
-<% plugins.forEach(function(plugin){ %>import <%= plugin.camelCaseName %> from '@/plugin/<%= plugin.name %>/stage-config'
-<% }); %>
+<%
+const lines = ['// 本文件是自动生成, 请勿修改']
 
-const pluginsConfig = [
-<% plugins.forEach(function(plugin){ %>  <%= plugin.camelCaseName %>,
-<% }); %>]
+plugins.forEach(plugin => {
+  lines.push(`import ${plugin.camelCaseName} from '@/plugin/${plugin.name}/stage-config'`)
+})
 
-export default pluginsConfig
+lines.push('')
+lines.push('const pluginsConfig = [')
+
+plugins.forEach(plugin => {
+  lines.push(`  ${plugin.camelCaseName},`)
+})
+
+lines.push(']')
+lines.push('')
+lines.push('export default pluginsConfig')
+-%>
+<%- `${lines.join('\n')}\n` %>

tests/unit/plugin-config-generator.spec.js

@@ -0,0 +1,23 @@
+import { createRequire } from 'node:module'
+
+import * as prettier from 'prettier'
+import { describe, expect, it } from 'vitest'
+
+const require = createRequire(import.meta.url)
+const { renderPluginConfig } = require('../../script/lib/generate-plugin-config')
+
+describe('plugin config generator', () => {
+  it('renders plugin config that passes prettier when plugins exist', async () => {
+    const result = await renderPluginConfig([
+      { camelCaseName: 'demoPlugin', name: 'demo-plugin' },
+      { camelCaseName: 'fooBar', name: 'foo-bar' },
+    ])
+
+    const prettierConfig = (await prettier.resolveConfig('src/config/stage/plugin.js')) || {}
+
+    await expect(prettier.check(result, { ...prettierConfig, filepath: 'src/config/stage/plugin.js' })).resolves.toBe(
+      true,
+    )
+    expect(result).not.toContain('\n\n\n')
+  })
+})