@rotki/ui-library 2.24.0 → 2.25.1

package/dist/vite-plugin/scanner.js.map

@@ -1 +1 @@
-{"version":3,"file":"scanner.js","names":[],"sources":["../../src/vite-plugin/scanner.ts"],"sourcesContent":["import type { ScanResult } from './types';\n\n/**\n * Regex patterns to detect icon usage in source files\n */\nconst ICON_PATTERNS: RegExp[] = [\n  // Static name attribute: <RuiIcon name=\"lu-star\" /> or name='lu-star'\n  /\\bname=[\"'](lu-[\\da-z-]+)[\"']/gi,\n\n  // Dynamic bound name with string literal: :name=\"'lu-star'\" or :name=\"`lu-star`\"\n  /:name=[\"']['`](lu-[\\da-z-]+)['`]?[\"']/gi,\n\n  // String literals that look like icon names: 'lu-star' or \"lu-star\"\n  /[\"'`](lu-[\\da-z-]+)[\"'`]/gi,\n];\n\n/**\n * Extracts all potential icon names from source code\n */\nexport function extractIconsFromSource(source: string): Set<string> {\n  const icons = new Set<string>();\n\n  for (const pattern of ICON_PATTERNS) {\n    // Reset lastIndex for global regex\n    pattern.lastIndex = 0;\n\n    let match: RegExpExecArray | null = pattern.exec(source);\n    while (match !== null) {\n      const iconName = match[1];\n      if (iconName) {\n        icons.add(iconName);\n      }\n      match = pattern.exec(source);\n    }\n  }\n\n  return icons;\n}\n\n/**\n * Validates detected icons against known valid icons\n */\nexport function validateIcons(\n  detectedIcons: Set<string>,\n  validIcons: Set<string>,\n  filePath: string,\n  result: ScanResult,\n  ignore?: Set<string>,\n): void {\n  for (const icon of detectedIcons) {\n    if (ignore?.has(icon)) {\n      // App-provided custom icon: registered by the consumer, not shipped by\n      // the library — neither imported nor reported invalid.\n      continue;\n    }\n    if (validIcons.has(icon)) {\n      result.icons.add(icon);\n    }\n    else {\n      // Track invalid icons\n      const files = result.invalidIcons.get(icon) || [];\n      files.push(filePath);\n      result.invalidIcons.set(icon, files);\n    }\n  }\n}\n\n/**\n * Converts icon name to export constant name\n * e.g., 'lu-arrow-down' -> 'LuArrowDown'\n */\nexport function iconNameToExportName(iconName: string): string {\n  return iconName\n    .split('-')\n    .map(part => part.charAt(0).toUpperCase() + part.slice(1))\n    .join('');\n}\n\n/**\n * Generates the virtual module content with detected icons\n */\nexport function generateVirtualModule(icons: Set<string>): string {\n  if (icons.size === 0) {\n    return `// No icons detected\nexport default [];\n`;\n  }\n\n  const sortedIcons = [...icons].sort();\n  const exports = sortedIcons.map(iconNameToExportName);\n\n  const importStatement = `import {\\n  ${exports.join(',\\n  ')},\\n} from '@rotki/ui-library';\\n`;\n  const exportStatement = `\\nexport default [\\n  ${exports.join(',\\n  ')},\\n];\\n`;\n\n  return importStatement + exportStatement;\n}\n"],"mappings":";;;;AAKA,IAAM,gBAA0B;CAE9B;CAGA;CAGA;AACF;;;;AAKA,SAAgB,uBAAuB,QAA6B;CAClE,MAAM,wBAAQ,IAAI,IAAY;CAE9B,KAAK,MAAM,WAAW,eAAe;EAEnC,QAAQ,YAAY;EAEpB,IAAI,QAAgC,QAAQ,KAAK,MAAM;EACvD,OAAO,UAAU,MAAM;GACrB,MAAM,WAAW,MAAM;GACvB,IAAI,UACF,MAAM,IAAI,QAAQ;GAEpB,QAAQ,QAAQ,KAAK,MAAM;EAC7B;CACF;CAEA,OAAO;AACT;;;;AAKA,SAAgB,cACd,eACA,YACA,UACA,QACA,QACM;CACN,KAAK,MAAM,QAAQ,eAAe;EAChC,IAAI,QAAQ,IAAI,IAAI,GAGlB;EAEF,IAAI,WAAW,IAAI,IAAI,GACrB,OAAO,MAAM,IAAI,IAAI;OAElB;GAEH,MAAM,QAAQ,OAAO,aAAa,IAAI,IAAI,KAAK,CAAC;GAChD,MAAM,KAAK,QAAQ;GACnB,OAAO,aAAa,IAAI,MAAM,KAAK;EACrC;CACF;AACF;;;;;AAMA,SAAgB,qBAAqB,UAA0B;CAC7D,OAAO,SACJ,MAAM,GAAG,CAAC,CACV,KAAI,SAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CACzD,KAAK,EAAE;AACZ;;;;AAKA,SAAgB,sBAAsB,OAA4B;CAChE,IAAI,MAAM,SAAS,GACjB,OAAO;;;CAMT,MAAM,UADc,CAAC,GAAG,KAAK,CAAC,CAAC,KACf,CAAA,CAAY,IAAI,oBAAoB;CAKpD,OAAO,eAHgC,QAAQ,KAAK,OAAO,EAAE,wDACZ,QAAQ,KAAK,OAAO,EAAE;AAGzE"}
+{"version":3,"file":"scanner.js","names":[],"sources":["../../src/vite-plugin/scanner.ts"],"sourcesContent":["import type { ScanResult } from './types';\n\n/**\n * Regex patterns to detect icon usage in source files\n */\nconst ICON_PATTERNS: RegExp[] = [\n  // Static name attribute: <RuiIcon name=\"lu-star\" /> or name='lu-star'\n  /\\bname=[\"'](lu-[\\da-z-]+)[\"']/gi,\n\n  // Dynamic bound name with string literal: :name=\"'lu-star'\" or :name=\"`lu-star`\"\n  /:name=[\"']['`](lu-[\\da-z-]+)['`]?[\"']/gi,\n\n  // String literals that look like icon names: 'lu-star' or \"lu-star\"\n  /[\"'`](lu-[\\da-z-]+)[\"'`]/gi,\n];\n\n/**\n * Extracts all potential icon names from source code\n */\nexport function extractIconsFromSource(source: string): Set<string> {\n  const icons = new Set<string>();\n\n  for (const pattern of ICON_PATTERNS) {\n    // Reset lastIndex for global regex\n    pattern.lastIndex = 0;\n\n    let match: RegExpExecArray | null = pattern.exec(source);\n    while (match !== null) {\n      const iconName = match[1];\n      if (iconName) {\n        icons.add(iconName);\n      }\n      match = pattern.exec(source);\n    }\n  }\n\n  return icons;\n}\n\n/**\n * Validates detected icons against known valid icons\n */\nexport function validateIcons(\n  detectedIcons: Set<string>,\n  validIcons: Set<string>,\n  filePath: string,\n  result: ScanResult,\n  ignore?: Set<string>,\n): void {\n  for (const icon of detectedIcons) {\n    if (ignore?.has(icon)) {\n      // The consumer registers this one themselves, so it is neither imported nor reported invalid\n      continue;\n    }\n    if (validIcons.has(icon)) {\n      result.icons.add(icon);\n    }\n    else {\n      // Track invalid icons\n      const files = result.invalidIcons.get(icon) || [];\n      files.push(filePath);\n      result.invalidIcons.set(icon, files);\n    }\n  }\n}\n\n/**\n * Names the generated constant an icon is exported as, which is its kebab-case\n * name in pascal case: `lu-arrow-down` is exported as `LuArrowDown`.\n *\n * @param iconName - kebab-case name, as it is written in a template\n * @returns the constant the generated module exports it under\n */\nexport function iconNameToExportName(iconName: string): string {\n  return iconName\n    .split('-')\n    .map(part => part.charAt(0).toUpperCase() + part.slice(1))\n    .join('');\n}\n\n/**\n * Generates the virtual module content with detected icons\n */\nexport function generateVirtualModule(icons: Set<string>): string {\n  if (icons.size === 0) {\n    return `// No icons detected\nexport default [];\n`;\n  }\n\n  const sortedIcons = [...icons].sort();\n  const exports = sortedIcons.map(iconNameToExportName);\n\n  const importStatement = `import {\\n  ${exports.join(',\\n  ')},\\n} from '@rotki/ui-library';\\n`;\n  const exportStatement = `\\nexport default [\\n  ${exports.join(',\\n  ')},\\n];\\n`;\n\n  return importStatement + exportStatement;\n}\n"],"mappings":";;;;AAKA,IAAM,gBAA0B;CAE9B;CAGA;CAGA;AACF;;;;AAKA,SAAgB,uBAAuB,QAA6B;CAClE,MAAM,wBAAQ,IAAI,IAAY;CAE9B,KAAK,MAAM,WAAW,eAAe;EAEnC,QAAQ,YAAY;EAEpB,IAAI,QAAgC,QAAQ,KAAK,MAAM;EACvD,OAAO,UAAU,MAAM;GACrB,MAAM,WAAW,MAAM;GACvB,IAAI,UACF,MAAM,IAAI,QAAQ;GAEpB,QAAQ,QAAQ,KAAK,MAAM;EAC7B;CACF;CAEA,OAAO;AACT;;;;AAKA,SAAgB,cACd,eACA,YACA,UACA,QACA,QACM;CACN,KAAK,MAAM,QAAQ,eAAe;EAChC,IAAI,QAAQ,IAAI,IAAI,GAElB;EAEF,IAAI,WAAW,IAAI,IAAI,GACrB,OAAO,MAAM,IAAI,IAAI;OAElB;GAEH,MAAM,QAAQ,OAAO,aAAa,IAAI,IAAI,KAAK,CAAC;GAChD,MAAM,KAAK,QAAQ;GACnB,OAAO,aAAa,IAAI,MAAM,KAAK;EACrC;CACF;AACF;;;;;;;;AASA,SAAgB,qBAAqB,UAA0B;CAC7D,OAAO,SACJ,MAAM,GAAG,CAAC,CACV,KAAI,SAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CACzD,KAAK,EAAE;AACZ;;;;AAKA,SAAgB,sBAAsB,OAA4B;CAChE,IAAI,MAAM,SAAS,GACjB,OAAO;;;CAMT,MAAM,UADc,CAAC,GAAG,KAAK,CAAC,CAAC,KACf,CAAA,CAAY,IAAI,oBAAoB;CAKpD,OAAO,eAHgC,QAAQ,KAAK,OAAO,EAAE,wDACZ,QAAQ,KAAK,OAAO,EAAE;AAGzE"}

package/dist/vite-plugin/types.d.ts

@@ -14,19 +14,15 @@ export interface RuiIconsPluginOptions {
      */
     customIcons?: string[];
     /**
-     * Glob patterns for files to scan
-     * @default ['** /*.vue', '** /*.ts', '** /*.tsx'] (without spaces)
+     * Glob patterns for files to scan. Defaults to every `.vue`, `.ts` and
+     * `.tsx` file.
      */
     scanPatterns?: string[];
     /**
-     * Strict mode - fail build on invalid icon names
-     * @default false
+     * Strict mode: fails the build on an invalid icon name. Defaults to false.
      */
     strict?: boolean;
-    /**
-     * Enable debug logging
-     * @default false
-     */
+    /** Logs what the scan found and registered. Defaults to false. */
     debug?: boolean;
 }
 export interface ScanResult {