feat: allow to scan for custom iconify collections (#318)

Co-authored-by: Johannes Balog <johannes.balog@styria.com>
Co-authored-by: Anthony Fu <github@antfu.me>

Author: 3 people

scripts/collections.ts

@@ -2,7 +2,6 @@ import fs from 'node:fs/promises'
 import collections from '@iconify/collections/collections.json' with { type: 'json' }
 
 const names = Object.keys(collections).sort()
-const regexPrefix = [...names].sort((a, b) => b.length - a.length).join('|')
 
 await fs.writeFile(
   './src/collection-names.ts',
@@ -12,12 +11,3 @@ await fs.writeFile(
   ].join('\n'),
   'utf-8',
 )
-
-await fs.writeFile(
-  './src/icon-regex.ts',
-  [
-    '// GENERATED BY scripts/collections.ts',
-    `export const iconMatchRegex = /\\b(?:i-)?(${regexPrefix})[:-]([a-z0-9-]+)\\b/g`,
-  ].join('\n'),
-  'utf-8',
-)

src/icon-regex.ts

@@ -1,24 +1,50 @@
 import fs from 'node:fs/promises'
 import type { Nuxt } from 'nuxt/schema'
 import { glob } from 'tinyglobby'
-import { iconMatchRegex } from './icon-regex'
 import type { ClientBundleScanOptions } from './types'
+import { collectionNames } from './collection-names'
 
-export function extraIconUsages(code: string, set: Set<string>, ignoreCollections: string[]) {
-  for (const match of code.matchAll(iconMatchRegex)) {
-    if (match && !ignoreCollections.includes(match[1])) {
+export function extraIconUsages(
+  code: string,
+  set: Set<string>,
+  matchRegex: RegExp,
+) {
+  for (const match of code.matchAll(matchRegex)) {
+    if (match) {
       set.add(`${match[1]}:${match[2]}`)
     }
   }
 }
 
-export async function scanSourceFiles(nuxt: Nuxt, scanOptions: ClientBundleScanOptions | true, set: Set<string> = new Set()) {
+export function createMatchRegex(
+  collections: string[] | Set<string>,
+) {
+  const collectionsRegex = [...collections].sort((a, b) => b.length - a.length).join('|')
+  return new RegExp('\\b(?:i-)?(' + collectionsRegex + ')[:-]([a-z0-9-]+)\\b', 'g')
+}
+
+export async function scanSourceFiles(
+  nuxt: Nuxt,
+  scanOptions: ClientBundleScanOptions | true,
+  set: Set<string> = new Set(),
+) {
   const {
     globInclude = ['**/*.{vue,jsx,tsx,md,mdc,mdx,yml,yaml}'],
     globExclude = ['node_modules', 'dist', 'build', 'coverage', 'test', 'tests', '.*'],
     ignoreCollections = [],
+    additionalCollections = [],
   } = scanOptions === true ? {} : scanOptions
 
+  const collections = new Set([
+    ...collectionNames,
+    ...additionalCollections,
+  ])
+  for (const collection of ignoreCollections) {
+    collections.delete(collection)
+  }
+
+  const matchRegex = createMatchRegex(collections)
+
   const files = await glob(
     globInclude,
     {
@@ -32,7 +58,7 @@ export async function scanSourceFiles(nuxt: Nuxt, scanOptions: ClientBundleScanO
   await Promise.all(
     files.map(async (file) => {
       const code = await fs.readFile(file, 'utf-8').catch(() => '')
-      extraIconUsages(code, set, ignoreCollections)
+      extraIconUsages(code, set, matchRegex)
     }),
   )
 

src/scan.ts

@@ -154,6 +154,10 @@ export interface ClientBundleScanOptions {
    * Collection names to be ignored when scanning
    */
   ignoreCollections?: string[]
+  /**
+   * Additional collections that are not or not yet inclduded in the `@iconify` collection
+   */
+  additionalCollections?: string[]
 }
 
 export interface ResolvedServerBundleOptions {

src/types.ts

@@ -1,11 +1,12 @@
 /// <reference types="vite/client" />
 import { it, expect } from 'vitest'
-import { extraIconUsages } from '../src/scan'
+import { createMatchRegex, extraIconUsages } from '../src/scan'
+import { collectionNames } from '../src/collection-names'
 
 it('extract icon usages', async () => {
   const code = await import('../playground/components/ShowcaseFixture.vue?raw').then(m => m.default)
   const set = new Set<string>()
-  extraIconUsages(code, set, [])
+  extraIconUsages(code, set, createMatchRegex(collectionNames))
 
   expect(set).toMatchInlineSnapshot(`
     Set {