feat: generate IntelliJ ide helper file

Author: superbiche

package.json

@@ -81,6 +81,7 @@
     "local-pkg": "^0.4.0",
     "magic-string": "^0.25.7",
     "minimatch": "^3.0.4",
+    "pnpm": "^6.23.6",
     "resolve": "^1.20.0",
     "unplugin": "^0.2.21"
   },

pnpm-lock.yaml

@@ -8,13 +8,15 @@ import { pascalCase, getNameFromFilePath, resolveAlias, matchGlobs, parseId } fr
 import { resolveOptions } from './options'
 import { searchComponents } from './fs/glob'
 import { generateDeclaration } from './declaration'
+import { generateIdeHelper } from './ideHelper'
 import transformer from './transformer'
 
 const debug = {
   components: Debug('unplugin-vue-components:context:components'),
   search: Debug('unplugin-vue-components:context:search'),
   hmr: Debug('unplugin-vue-components:context:hmr'),
   decleration: Debug('unplugin-vue-components:decleration'),
+  ideHelper: Debug('unplugin-vue-components:ideHelper'),
   env: Debug('unplugin-vue-components:env'),
 }
 
@@ -37,6 +39,7 @@ export class Context {
   ) {
     this.options = resolveOptions(rawOptions, this.root)
     this.generateDeclaration = throttle(500, false, this.generateDeclaration.bind(this))
+    this.generateIdeHelper = throttle(500, false, this.generateIdeHelper.bind(this))
     this.setTransformer(this.options.transformer)
   }
 
@@ -130,6 +133,7 @@ export class Context {
 
   onUpdate(path: string) {
     this.generateDeclaration()
+    this.generateIdeHelper()
 
     if (!this._server)
       return
@@ -251,6 +255,14 @@ export class Context {
     generateDeclaration(this, this.options.root, this.options.dts)
   }
 
+  generateIdeHelper() {
+    if (!this.options.generateIdeHelper)
+      return
+
+    debug.ideHelper('generating')
+    generateIdeHelper(this, this.options.root, this.options.generateIdeHelper)
+  }
+
   get componentNameMap() {
     return this._componentNameMap
   }

src/core/context.ts

@@ -0,0 +1,71 @@
+import { dirname, relative, isAbsolute } from 'path'
+import { promises as fs, existsSync } from 'fs'
+import { notNullish, slash } from '@antfu/utils'
+import { Context } from './context'
+import { getVueVersion } from './options'
+import { getTransformedPath } from './utils'
+
+export async function generateIdeHelper(ctx: Context, root: string, filepath: string) {
+  const imports: Record<string, string> = Object.fromEntries(
+    Object.values({
+      ...ctx.componentNameMap,
+      ...ctx.componentCustomMap,
+    })
+      .map(({ path, name, importName }) => {
+        if (!name)
+          return undefined
+        path = getTransformedPath(path, ctx)
+        const related = isAbsolute(path)
+          ? `./${relative(dirname(filepath), path)}`
+          : path
+
+        let entry = 'import '
+        if (importName)
+          entry += `{ ${importName} as ${name} }`
+        else
+          entry += name
+        entry += ` from '${slash(related)}';`
+        return [name, entry]
+      })
+      .filter(notNullish),
+  )
+
+  if (!Object.keys(imports).length)
+    return
+
+  const originalContent = existsSync(filepath) ? await fs.readFile(filepath, 'utf-8') : ''
+
+  const lines = Object.entries(imports)
+    .sort((a, b) => a[0].localeCompare(b[0]))
+
+  let code = `// generated by unplugin-vue-components
+// We suggest you to NOT commit this file into source control
+// Read more: https://github.com/antfu/unplugin-vue-components/issues/135
+`
+
+  if (getVueVersion() === 'vue3') {
+    code += `import { createApp } from "vue";
+    
+${lines.map(line => line[1]).join('\n')}
+
+const app = createApp({});
+
+${lines.map(line => `app.component('${line[0]}', ${line[0]})`).join('\n')}
+
+app.mount("body");
+
+`
+  }
+  else {
+    code += `import Vue from "vue";
+    
+${lines.map(line => line[1]).join('\n')}
+
+${lines.map(line => `Vue.component('${line[0]}', ${line[0]});\nVue.component('Lazy${line[0]}', ${line[0]});`).join('\n')}
+
+`
+  }
+
+  if (code !== originalContent)
+    await fs.writeFile(filepath, code, 'utf-8')
+}

src/core/ideHelper.ts

@@ -19,6 +19,8 @@ export const defaultOptions: Omit<Required<Options>, 'include' | 'exclude' | 'tr
   importPathTransform: v => v,
 
   allowOverrides: false,
+
+  generateIdeHelper: false,
 }
 
 function normalizeResolvers(resolvers: (ComponentResolver | ComponentResolver[])[]): ComponentResolverObject[] {
@@ -60,6 +62,16 @@ export function resolveOptions(options: Options, root: string): ResolvedOptions
         ? options.dts
         : 'components.d.ts',
     )
+
+  resolved.generateIdeHelper = !options.generateIdeHelper
+    ? false
+    : resolve(
+      root,
+      typeof options.generateIdeHelper === 'string'
+        ? options.generateIdeHelper
+        : '.components.gen.js',
+    )
+
   resolved.root = root
   resolved.transformer = options.transformer || getVueVersion() || 'vue3'
   resolved.directives = (typeof options.directives === 'boolean')
@@ -71,7 +83,7 @@ export function resolveOptions(options: Options, root: string): ResolvedOptions
   return resolved
 }
 
-function getVueVersion() {
+export function getVueVersion() {
   try {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const vue = require('vue')

src/core/options.ts

@@ -15,7 +15,7 @@ export interface ResolveResult {
   replace: (resolved: string) => void
 }
 
-export default function tranformer(ctx: Context, transformer: SupportedTransformer): Transformer {
+export default function transformer(ctx: Context, transformer: SupportedTransformer): Transformer {
   return async(code, id, path) => {
     ctx.searchGlob()
 

src/core/transformer.ts

@@ -26,6 +26,7 @@ export default createUnplugin<Options>((options = {}) => {
       try {
         const result = await ctx.transform(code, id)
         ctx.generateDeclaration()
+        ctx.generateIdeHelper()
         return result
       }
       catch (e) {
@@ -44,6 +45,7 @@ export default createUnplugin<Options>((options = {}) => {
         if (options.dts) {
           ctx.searchGlob()
           ctx.generateDeclaration()
+          ctx.generateIdeHelper()
         }
 
         if (config.build.watch && config.command === 'build')

src/core/unplugin.ts

@@ -138,6 +138,15 @@ export interface Options {
    * @default undefined
    */
   directives?: boolean
+
+  /**
+   * Generate components.js helper for IntelliJ IDEs.
+   *
+   * Accept boolean or a path related to project root.
+   *
+   * @default false
+   */
+  generateIdeHelper?: boolean | string
 }
 
 export type ResolvedOptions = Omit<
@@ -151,6 +160,7 @@ Required<Options>,
   resolvedDirs: string[]
   globs: string[]
   dts: string | false
+  generateIdeHelper: string | false
   root: string
 }