feat: major releases

Author: coderhyh

README-zh.md

@@ -4,11 +4,11 @@
 
 ## 功能特点
 
-- 自动监听指定的文件夹以检测文件变化。
-- 更新这些文件夹内的 `index.ts` 文件，写入正确的 `export` 语句。
-- 可配置以忽略特定文件或文件夹。
-- 支持 `ts | js` 的文件扩展名（默认为 `.ts`）。
-- 处理组件文件夹，并提供选项以指定组件文件夹。
+- 自动监听指定的文件夹以检测文件变化
+- 更新这些文件夹内的 `index.ts` 文件，写入正确的 `export` 语句
+- 可配置以忽略特定文件或文件夹
+- 支持 `ts | js` 的文件扩展名（默认为 `.ts`）
+- 自定义导出格式
 
 ## 安装
 
@@ -37,10 +37,14 @@ export default defineConfig({
 
   plugins: [
     AutoExport({
-      path: ['~/views/**/{components,hooks}/*', '~/hooks/*'], // 要监听的文件夹, 路径可以使用别名
-      ignore: ['**/node_modules'], // 要忽略的文件夹或文件（可选）
-      componentDirs: ['components'], // 处理的组件文件夹（可选）
-      extname: 'ts', // 文件扩展名（默认为 'ts'）'ts' | 'js'
+      // 要监听的文件夹, 路径可以使用别名; 以 /* 结尾即可
+      path: ['~/views/**/{components,hooks}/*', './src/hooks/*'],
+      // 要忽略的文件夹或文件（可选）
+      ignore: ['**/node_modules'],
+      // 文件扩展名（默认为 'ts'）'ts' | 'js'
+      extname: 'ts',
+      // 自定义导出格式
+      formatter: (filename, extname) => `export * from './${filename}'`
     }),
   ],
 });
@@ -61,16 +65,14 @@ module.exports = {
 
 ## 配置选项
 
-- `path`（`string` 或 `string[]`）：要监听变化的文件夹。可以是单个字符串或字符串数组
+- `path`(`string` 或 `string[]`): 要监听变化的文件夹。可以是单个字符串或字符串数组
   - 可以使用自己配置的路径别名
-  - **要使用通配符匹配模式, 如: `~/views/**/{components,hooks}/*` 或者 `src/hooks/*.ts`**
-- `ignore`（`string[]`）：在监听时要忽略的文件夹或文件。**（可选）**
+  - **使用通配符匹配模式, 如: `~/views/**/{components,hooks}/*` 或者 `src/hooks/*.ts`**
+- `ignore`(`string[]`): 在监听时要忽略的文件夹或文件。**（可选）**
   - 同 `path` 规则
-- `extname`（`string`）：用于 `index` 文件的文件扩展名（默认为 `ts`）
+- `extname`(`string`): 用于 `index` 文件的文件扩展名（默认为 `ts`）
   - 支持 `ts | js`
-- `componentDirs`（`string[]`）：要处理的组件文件夹。 **（可选）**
-  - 比如以上的例子中传入的是 `componentDirs: ['components']`
-  - 那么输出的 `export` 语句就是: `export { default as ZForm } from './z-form.vue'`
+- `formatter`(`(filename: string, extname: string) => string`): 自定义导出格式
 
 ## 错误处理
 
@@ -79,7 +81,7 @@ module.exports = {
   - 因为只有这样才会表示监听某个文件夹内部文件
 - 如果路径不符合此规则，插件将抛出错误，并显示消息：`Path rule does not match. Please check the path format.`
 - 正确例子: `~/views/**/{components,hooks}/*` 或者 `src/hooks/*.ts`
-  - `~` 是 `Vite` 中配置的路径别名
+  - `~` 是配置的路径别名
 
 ## 例子
 

README.md

@@ -10,7 +10,7 @@
 - Updates the `index.ts` file within those directories with the appropriate `export` statements.
 - Configurable to ignore specific files or directories.
 - Supports `ts | js` file extensions (default is `.ts`).
-- Handles component directories with options to specify component directories.
+- Custom export format.
 
 ## Installation
 
@@ -39,10 +39,14 @@ export default defineConfig({
 
   plugins: [
     AutoExport({
-      path: ['~/views/**/{components,hooks}/*', '~/hooks/*'], // Directories to watch, paths can use aliases
-      ignore: ['**/node_modules'], // Directories or files to ignore (optional)
-      componentDirs: ['components'], // Component directories to handle (optional)
-      extname: 'ts', // File extension (default is 'ts') `ts` | `js`
+      // Directories to watch, paths can use aliases; It just needs to end with /*
+      path: ['~/views/**/{components,hooks}/*', '~/hooks/*'],
+      // Directories or files to ignore (optional)
+      ignore: ['**/node_modules'],
+      // File extension (default is 'ts') `ts` | `js`
+      extname: 'ts',
+      // Custom export format
+      formatter: (filename, extname) => `export * from './${filename}'`
     }),
   ],
 });
@@ -70,9 +74,7 @@ module.exports = {
   - Follows the same path rule as `path`.
 - `extname` (`string`): The file extension to use for the `index` files (default is `ts`).
   - support `ts | js`.
-- `componentDirs` (`string[]`): Component directories to handle. **(optional)**
-  - For example, if you pass `componentDirs: ['components']`,
-  - The generated `export` statement will be: `export { default as ZForm } from './z-form.vue'`.
+- `formatter`(`(filename: string, extname: string) => string`): Custom export format
 
 ## Error Handling
 
@@ -81,7 +83,7 @@ module.exports = {
   - Because this is the only way to indicate monitoring files within a specific folder.
 - If the path does not match this rule, the plugin will throw an error with the message: `Path rule does not match. Please check the path format.`
 - Correct examples: `~/views/**/{components,hooks}/* or src/hooks/*.ts`
-  - `~` is the path alias configured in `Vite`.
+  - "~" is a configured path alias.
 
 ## Example
 

playground/vite/vite.config.ts

@@ -2,14 +2,12 @@ import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
 import AutoExport from 'unplugin-auto-export/vite'
 
-
 // https://vitejs.dev/config/
 export default defineConfig({
   plugins: [
     vue(),
     AutoExport({
       path: ['src/components/*'],
-      componentDirs: ['components'],
     }),
   ],
 })

playground/webpack/vue.config.js

@@ -7,7 +7,6 @@ module.exports = defineConfig({
     plugins: [
       AutoExport({
         path: ['src/components/*'],
-        componentDirs: ['components'],
       }),
     ],
   },

src/core/index.ts

@@ -2,44 +2,49 @@ import fs from 'node:fs'
 import path from 'node:path'
 import chokidar from 'chokidar'
 import type { Alias, AliasOptions } from 'vite'
-import type { Options } from '../types'
+import type { IOptions, TFileType } from '../types'
 import { replacePath, throwError, toHump } from './utils'
 
-export function unpluginAutoExport(config: Options, alias: AliasOptions & Alias[]) {
+export function unpluginAutoExport(config: IOptions, alias: AliasOptions & Alias[]): chokidar.FSWatcher {
   const reg = /\/\*(\.[\w\d]+)?$/
+  const splitReg = /\.(?=[^\.]+$)/g
+  const defaultOptions: IOptions = {
+    path: [],
+    ignore: [],
+    extname: 'ts',
+  }
+  config = Object.assign(defaultOptions, config)
 
   const handleDir = (_path: string) => {
-    const { extname = 'ts', componentDirs = [] } = config
-    const indexFileName = `index.${extname}`
+    const { extname } = config
     const dirPath = path.dirname(_path)
+    const indexFileName = `index.${extname}`
     const indexFilePath = `${dirPath}/${indexFileName}`
-    const dir = dirPath.split('/').at(-1)!
-    const isVue = componentDirs.includes(dir)
     const files = fs.readdirSync(dirPath).filter(e => e !== indexFileName && fs.statSync(`${dirPath}/${e}`).isFile())
     if (path.basename(_path) === indexFileName)
       return
-    const indexFileContent
-      = `${files
-        .map((file) => {
-          const basename = path.basename(file)
-          const [filename] = basename.split('.')
-          const s = isVue ? `{ default as ${toHump(filename)} }` : '*'
-          const name = isVue ? basename : filename
-          return `export ${s} from './${name}'`
-        })
-        .join('\n')}\n`
+    const exportList = files
+      .map((basename) => {
+        const [filename, extname] = basename.split(splitReg) as [string, TFileType]
+        if (config.formatter)
+          return config.formatter(filename, extname)
+
+        switch (extname) {
+          case 'vue':
+          case 'json':
+            return `export { default as ${toHump(filename)} } from './${filename}.${extname}'`
+          case 'js':
+          case 'ts':
+          default:
+            return `export * from './${filename}'`
+        }
+      }).join('\n')
+    const indexFileContent = `${exportList || 'export {}'}\n`
     fs.writeFileSync(indexFilePath, indexFileContent)
   }
-  const setupWatcher = (watcher: fs.FSWatcher) => {
-    watcher.on('unlink', handleDir)
-    watcher.on('add', handleDir)
-  }
-  const init = (path: string | string[], ignore: string[]) => {
-    setupWatcher(chokidar.watch(path, { ignored: ignore }))
-  }
-  const handleAlias = () => {
+  const init = () => {
     let path = config.path
-    let ignore = config.ignore ?? []
+    let ignore = config.ignore
     if (Array.isArray(path)) {
       !path.every(p => reg.test(p)) && throwError()
       path = path.map(e => replacePath(e, alias))
@@ -48,11 +53,14 @@ export function unpluginAutoExport(config: Options, alias: AliasOptions & Alias[
       !reg.test(path) && throwError()
       path = replacePath(path, alias)
     }
-    !ignore.every(p => reg.test(p)) && throwError()
+    !ignore?.every(p => reg.test(p)) && throwError()
     ignore = ignore?.map(e => replacePath(e, alias))
 
-    init(path, ignore)
+    const watcher = chokidar.watch(path, { ignored: ignore })
+    watcher.on('unlink', handleDir)
+    watcher.on('add', handleDir)
+    return watcher
   }
 
-  handleAlias()
+  return init()
 }

src/index.ts

@@ -1,11 +1,12 @@
 import type { UnpluginFactory } from 'unplugin'
 import { createUnplugin } from 'unplugin'
 import type { Alias, AliasOptions, ResolvedConfig } from 'vite'
-import type { Options } from './types'
-
+import type chokidar from 'chokidar'
+import type { IOptions } from './types'
 import { unpluginAutoExport } from './core'
 
-export const unpluginFactory: UnpluginFactory<Options | undefined> = options => ({
+let watcher: chokidar.FSWatcher | undefined
+export const unpluginFactory: UnpluginFactory<IOptions> = options => ({
   name: 'unplugin-auto-export',
   // transformInclude(id) {
   //   return id.endsWith('main.ts')
@@ -18,13 +19,13 @@ export const unpluginFactory: UnpluginFactory<Options | undefined> = options =>
       find: k,
       replacement: alias![k as keyof typeof alias],
     }))
-    unpluginAutoExport(options!, aliasList)
+    unpluginAutoExport(options, aliasList)
   },
   vite: {
+    apply: 'serve',
     configResolved(config: ResolvedConfig) {
-      if (config.env.PROD)
-        return
-      unpluginAutoExport(options!, config.resolve.alias)
+      watcher?.close()
+      watcher = unpluginAutoExport(options, config.resolve.alias)
     },
   },
 })

src/types.ts

@@ -1,6 +1,8 @@
-export interface Options {
+export interface IOptions {
   path: string | string[]
   ignore?: string[]
   extname?: 'ts' | 'js'
-  componentDirs?: string[]
+  formatter?: (filename: string, extname: string) => string
 }
+
+export type TFileType = 'ts' | 'js' | 'vue' | 'json'