feat: support to import the types from the dirs (#544)

Co-authored-by: Anthony Fu <github@antfu.me>

Author: noootwo

README.md

@@ -273,12 +273,27 @@ AutoImport({
   // Enable auto import by filename for default module exports under directories
   defaultExportByFilename: false,
 
+  // Options for scanning directories for auto import
+  dirsScanOptions: {
+    types: true // Enable auto import the types under the directories
+  },
+
   // Auto import for module exports under directories
   // by default it only scan one level of modules under the directory
   dirs: [
-    // './hooks',
-    // './composables' // only root modules
-    // './composables/**', // all nested modules
+    './hooks',
+    './composables', // only root modules
+    './composables/**', // all nested modules
+    // ...
+
+    {
+      glob: './hooks',
+      types: true // enable import the types
+    },
+    {
+      glob: './composables',
+      types: false // If top level dirsScanOptions.types importing enabled, just only disable this directory
+    }
     // ...
   ],
 

examples/vite-react/src/types/index.ts

@@ -0,0 +1 @@
+export type SpecialType = string

examples/vite-react/src/views/PageA.tsx

@@ -23,4 +23,6 @@ function PageA() {
   )
 }
 
+export type TypeA = number
+
 export default PageA

examples/vite-react/src/views/PageB.tsx

@@ -32,4 +32,6 @@ function PageB() {
   )
 }
 
+export type TypeB = number
+
 export default PageB

package.json

@@ -165,10 +165,9 @@
   "dependencies": {
     "@antfu/utils": "^0.7.10",
     "@rollup/pluginutils": "^5.1.3",
-    "fast-glob": "^3.3.2",
     "local-pkg": "^0.5.1",
     "magic-string": "^0.30.15",
-    "minimatch": "^9.0.5",
+    "picomatch": "^4.0.2",
     "unimport": "^3.14.5",
     "unplugin": "^2.1.0"
   },
@@ -178,11 +177,13 @@
     "@nuxt/kit": "^3.14.1592",
     "@svgr/plugin-jsx": "^8.1.0",
     "@types/node": "^22.10.2",
+    "@types/picomatch": "^3.0.1",
     "@types/resolve": "^1.20.6",
     "@vueuse/metadata": "^12.0.0",
     "bumpp": "^9.9.1",
     "eslint": "^9.16.0",
     "esno": "^4.8.0",
+    "fast-glob": "^3.3.2",
     "publint": "^0.2.12",
     "rollup": "^4.28.1",
     "tsup": "^8.3.5",

pnpm-lock.yaml

@@ -1,48 +1,29 @@
 import type { Import, InlinePreset } from 'unimport'
 import type { BiomeLintrc, ESLintGlobalsPropValue, ESLintrc, ImportExtended, Options } from '../types'
 import { existsSync, promises as fs } from 'node:fs'
-import { dirname, isAbsolute, join, relative, resolve } from 'node:path'
+import { dirname, isAbsolute, relative, resolve } from 'node:path'
 import process from 'node:process'
 import { slash, throttle, toArray } from '@antfu/utils'
 import { createFilter } from '@rollup/pluginutils'
-import fg from 'fast-glob'
 import { isPackageExists } from 'local-pkg'
 import MagicString from 'magic-string'
-import { createUnimport, resolvePreset, scanExports } from 'unimport'
+import { createUnimport, resolvePreset } from 'unimport'
 import { presets } from '../presets'
 import { generateBiomeLintConfigs } from './biomelintrc'
 import { generateESLintConfigs } from './eslintrc'
 import { resolversAddon } from './resolvers'
 
-function resolveGlobsExclude(root: string, glob: string) {
-  const excludeReg = /^!/
-  return `${excludeReg.test(glob) ? '!' : ''}${resolve(root, glob.replace(excludeReg, ''))}`
-}
-
-async function scanDirExports(dirs: string[], root: string) {
-  const result = await fg(dirs, {
-    absolute: true,
-    cwd: root,
-    onlyFiles: true,
-    followSymbolicLinks: true,
-  })
-
-  const files = Array.from(new Set(result.flat())).map(slash)
-  return (await Promise.all(files.map(i => scanExports(i, false)))).flat()
-}
-
 export function createContext(options: Options = {}, root = process.cwd()) {
   root = slash(root)
 
   const {
     dts: preferDTS = isPackageExists('typescript'),
+    dirsScanOptions,
+    dirs,
     vueDirectives,
     vueTemplate,
   } = options
 
-  const dirs = options.dirs?.concat(options.dirs.map(dir => join(dir, '*.{tsx,jsx,ts,js,mjs,cjs,mts,cts}')))
-    .map(dir => slash(resolveGlobsExclude(root, dir)))
-
   const eslintrc: ESLintrc = options.eslintrc || {}
   eslintrc.enabled = eslintrc.enabled === undefined ? false : eslintrc.enabled
   eslintrc.filepath = eslintrc.filepath || './.eslintrc-auto-import.json'
@@ -64,6 +45,11 @@ export function createContext(options: Options = {}, root = process.cwd()) {
   const unimport = createUnimport({
     imports: [],
     presets: options.packagePresets?.map(p => typeof p === 'string' ? { package: p } : p) ?? [],
+    dirsScanOptions: {
+      ...dirsScanOptions,
+      cwd: root,
+    },
+    dirs,
     injectAtEnd,
     parser: options.parser,
     addons: {
@@ -266,16 +252,15 @@ ${dts}`.trim()}\n`
   }
 
   async function scanDirs() {
-    if (dirs?.length) {
-      await unimport.modifyDynamicImports(async (imports) => {
-        const exports_ = await scanDirExports(dirs, root) as ImportExtended[]
-        exports_.forEach(i => i.__source = 'dir')
-        return modifyDefaultExportsAlias([
-          ...imports.filter((i: ImportExtended) => i.__source !== 'dir'),
-          ...exports_,
-        ], options)
-      })
-    }
+    await unimport.modifyDynamicImports(async (imports) => {
+      const exports_ = await unimport.scanImportsFromDir() as ImportExtended[]
+      exports_.forEach(i => i.__source = 'dir')
+      return modifyDefaultExportsAlias([
+        ...imports.filter((i: ImportExtended) => i.__source !== 'dir'),
+        ...exports_,
+      ], options)
+    })
+
     writeConfigFilesThrottled()
   }
 

src/core/ctx.ts

@@ -1,7 +1,7 @@
 import type { Options } from '../types'
 import { slash } from '@antfu/utils'
 import { isPackageExists } from 'local-pkg'
-import { minimatch } from 'minimatch'
+import pm from 'picomatch'
 import { createUnplugin } from 'unplugin'
 import { createContext } from './ctx'
 
@@ -41,7 +41,7 @@ export default createUnplugin<Options>((options) => {
         }
       },
       async handleHotUpdate({ file }) {
-        if (ctx.dirs?.some(glob => minimatch(slash(file), slash(glob))))
+        if (ctx.dirs?.some(dir => pm.isMatch(slash(file), slash(typeof dir === 'string' ? dir : dir.glob))))
           await ctx.scanDirs()
       },
       async configResolved(config) {

src/core/unplugin.ts

@@ -51,6 +51,25 @@ export type Resolver = ResolverFunction | ResolverResultObject
  */
 export type ImportsMap = Record<string, (string | ImportNameAlias)[]>
 
+export interface ScanDirExportsOptions {
+  /**
+   * Register type exports
+   *
+   * @default true
+   */
+  types?: boolean
+}
+
+/**
+ * Directory to search for import
+ */
+export interface ScanDir {
+  glob: string
+  types?: boolean
+}
+
+export type NormalizedScanDir = Required<ScanDir>
+
 export type ESLintGlobalsPropValue = boolean | 'readonly' | 'readable' | 'writable' | 'writeable'
 
 export interface ESLintrc {
@@ -118,10 +137,15 @@ export interface Options {
    */
   injectAtEnd?: boolean
 
+  /**
+   * Options for scanning directories for auto import
+   */
+  dirsScanOptions?: ScanDirExportsOptions
+
   /**
    * Path for directories to be auto imported
    */
-  dirs?: string[]
+  dirs?: (string | ScanDir)[]
 
   /**
    * Pass a custom function to resolve the component importing path from the component name.

src/types.ts

@@ -1,5 +1,5 @@
 import { resolve } from 'node:path'
-import { describe, it } from 'vitest'
+import { describe, expect, it } from 'vitest'
 import { createContext } from '../src/core/ctx'
 
 const root = resolve(__dirname, '../examples/vite-react')
@@ -19,7 +19,7 @@ describe('search', () => {
     expect(data).toContain('PageB')
   })
 
-  it('should dir excude work', async () => {
+  it('should dir exclude work', async () => {
     const ctx = createContext({
       dts: false,
       dirs: [
@@ -34,3 +34,58 @@ describe('search', () => {
     expect(data).not.toContain('PageB')
   })
 })
+
+describe('import the types from the dirs', () => {
+  it('should top level types enable work', async () => {
+    const ctx = createContext({
+      dts: false,
+      dirsScanOptions: { types: true },
+      dirs: ['src/**'],
+    }, root)
+
+    await ctx.scanDirs()
+    const data = await ctx.generateDTS('')
+    expect(data).toContain('TypeA')
+    expect(data).toContain('TypeB')
+    expect(data).toContain('SpecialType')
+  })
+
+  it('should specific dirs types enable work', async () => {
+    const ctx = createContext({
+      dts: false,
+      dirsScanOptions: { types: true },
+      dirs: [
+        {
+          glob: 'src/views',
+          types: true,
+        },
+      ],
+    }, root)
+
+    await ctx.scanDirs()
+    const data = await ctx.generateDTS('')
+    expect(data).toContain('TypeA')
+    expect(data).toContain('TypeB')
+    expect(data).not.toContain('SpecialType')
+  })
+
+  it('should specific dirs types disable work', async () => {
+    const ctx = createContext({
+      dts: false,
+      dirsScanOptions: { types: true },
+      dirs: [
+        'src/types',
+        {
+          glob: 'src/views',
+          types: false,
+        },
+      ],
+    }, root)
+
+    await ctx.scanDirs()
+    const data = await ctx.generateDTS('')
+    expect(data).not.toContain('TypeA')
+    expect(data).not.toContain('TypeB')
+    expect(data).toContain('SpecialType')
+  })
+})

test/search.test.ts

@@ -1,6 +1,6 @@
 import { promises as fs } from 'node:fs'
 import { resolve } from 'node:path'
-import fg from 'fast-glob'
+import glob from 'fast-glob'
 import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
 import { describe, expect, it } from 'vitest'
 import { createContext } from '../src/core/ctx'
@@ -61,7 +61,7 @@ describe('transform', async () => {
   })
 
   const root = resolve(__dirname, 'fixtures')
-  const files = await fg('*', {
+  const files = await glob('*', {
     cwd: root,
     onlyFiles: true,
   })
@@ -85,7 +85,7 @@ describe('transform-vue-macro', async () => {
   })
 
   const root = resolve(__dirname, 'fixtures-vue-macro')
-  const files = await fg('*', {
+  const files = await glob('*', {
     cwd: root,
     onlyFiles: true,
   })

test/transform.test.ts

@@ -1,4 +1,4 @@
-import { defineConfig } from 'vite'
+import { defineConfig } from 'vitest/config'
 import AutoImport from './src/vite'
 
 export default defineConfig({