feat: allow specifying imports to be ignored during the DTS file generation (#412)

Author: minenwerfer

README.md

@@ -263,6 +263,13 @@ AutoImport({
       type: true,
     },
   ],
+
+  // Array of strings of regexes that contains imports meant to be filtered out.
+  ignore: [
+    'useMouse',
+    'useFetch'
+  ],
+
   // Enable auto import by filename for default module exports under directories
   defaultExportByFilename: false,
 
@@ -280,6 +287,14 @@ AutoImport({
   // Set `false` to disable.
   dts: './auto-imports.d.ts',
 
+  // Array of strings of regexes that contains imports meant to be ignored during
+  // the declaration file generation. You may find this useful when you need to provide
+  // a custom signature for a function.
+  ignoreDts: [
+    'ignoredFunction',
+    /^ignore_/
+  ],
+
   // Auto import inside Vue template
   // see https://github.com/unjs/unimport/pull/15 and https://github.com/unjs/unimport/pull/72
   vueTemplate: false,

src/core/ctx.ts

@@ -80,10 +80,20 @@ ${dts}`.trim()}\n`
       if (!imports.length && !resolvers.length && !dirs?.length)
         console.warn('[auto-import] plugin installed but no imports has defined, see https://github.com/antfu/unplugin-auto-import#configurations for configurations')
 
+      const compare = (left: string|undefined, right: NonNullable<(Options['ignore'] | Options['ignoreDts'])>[number]) => {
+        return right instanceof RegExp
+          ? right.test(left!)
+          : right === left
+      }
+
       options.ignore?.forEach((name) => {
-        const i = imports.find(i => i.as === name)
-        if (i)
-          i.disabled = true
+        const i = imports.find(i => compare(i.as, name))
+        if (i) i.disabled = true
+      })
+
+      options.ignoreDts?.forEach((name) => {
+        const i = imports.find(i => compare(i.as, name))
+        if (i) i.dtsDisabled = true
       })
 
       return unimport.getInternalContext().replaceImports(imports)

src/types.ts

@@ -93,6 +93,11 @@ export interface Options {
    */
   ignore?: (string | RegExp)[]
 
+  /**
+   * These identifiers won't be put on the DTS file
+   */
+  ignoreDts?: (string | RegExp)[]
+
   /**
    * Inject the imports at the end of other imports
    *

test/dts.ignore.test.ts

@@ -0,0 +1,28 @@
+import { join } from 'node:path'
+import { expect, it } from 'vitest'
+import { createContext } from '../src/core/ctx'
+
+it('dts ignore', async () => {
+  const cwd = process.cwd()
+  const ctx = createContext({
+    imports: [{
+      custom: [
+        'shouldBePresent',
+        'shouldAlsoBePresent',
+        'shouldBeIgnored',
+        'ignoreme_shoudAlsoBeIgnored'
+      ]
+    }],
+    ignoreDts: [
+      'shouldBeIgnored',
+      /^ignoreme_/
+    ]
+  })
+
+  const dtsContent = await ctx.generateDTS(join(cwd, 'index.d.ts'))
+
+  expect(dtsContent).toContain('shouldBePresent')
+  expect(dtsContent).toContain('shouldAlsoBePresent')
+  expect(dtsContent).not.toContain('shouldBeIgnored')
+  expect(dtsContent).not.toContain('ignoreme_shoudAlsoBeIgnored')
+})