校验路径规则插件使用说明

使用方式

npm install @tcly-pangu/vite-plugin-path-checker -D

// vite.config.ts
import VitePluginPathChecker from '@tcly-pangu/vite-plugin-path-checker'

export default defineConfig(() => {
  return {
    plugins: [
      VitePluginPathChecker([
        {
          hierarchy: 'src/types/*/*/#.d.ts',
          '*': 'kebab-case',
          '#': 'kebab-case',
          ignore: ['src/types/common.d.ts']
        }
      ])
    ]
  }
})

参数说明

VitePluginPathChecker 接收一个配置列表，每个列表项都是一个文件夹的目录规则配置：

• hierarchy：必填配置，路径规则配置字符串，以指定文件目录开头，可以用来限制文件目录层数以及文件类型校验。一个 * 号代表一层文件目录，如果需要动态添加一层不确定的文件夹（即可有可无的文件夹），可以使用()来包裹一层指定的目录。如需限制文件类型，可以在字符串结尾添加 # 号并拼接指定文件后缀；
• *：必填配置，设置文件夹命名规则，可选值有 kebab-case、PascalCase、camelCase；
• #：必填配置，设置文件命名规则，可选值有 kebab-case、PascalCase、camelCase；
• ignore: 可选配置，设置忽略校验的文件路径列表，可以是文件夹路径或具体的文件路径。