@unocss/autocomplete 66.4.1 → 66.5.0

package/dist/index.d.mts

@@ -1,9 +1,19 @@
 import { SuggestResult, AutoCompleteFunction, UnoGenerator } from '@unocss/core';
 import { LRUCache } from 'lru-cache';
 
+declare class AutocompleteParseError extends Error {
+    readonly template?: string | undefined;
+    constructor(message: string, template?: string | undefined);
+    toString(): string;
+}
+declare const shorthands: Record<string, string>;
+declare const ignoredThemeKeys: string[];
+declare function parseAutocomplete(template: string, theme?: any, extraShorthands?: Record<string, string>): ParsedAutocompleteTemplate;
+
 type AutoCompleteMatchType = 'prefix' | 'fuzzy';
 interface AutocompleteOptions {
     matchType?: AutoCompleteMatchType;
+    throwErrors?: boolean;
 }
 type AutocompleteTemplatePart = AutocompleteTemplateStatic | AutocompleteTemplateGroup | AutocompleteTemplateTheme;
 interface AutocompleteTemplateStatic {
@@ -21,21 +31,19 @@ interface AutocompleteTemplateTheme {
 interface ParsedAutocompleteTemplate {
     parts: AutocompleteTemplatePart[];
     suggest: (input: string, matchType?: AutoCompleteMatchType) => string[] | undefined;
+    errors: AutocompleteParseError[];
 }
 interface UnocssAutocomplete {
     suggest: (input: string, allowsEmptyInput?: boolean) => Promise<string[]>;
     suggestInFile: (content: string, cursor: number) => Promise<SuggestResult | undefined>;
     templates: (string | AutoCompleteFunction)[];
     cache: LRUCache<string, string[]>;
-    reset: () => Promise<void>;
+    errorCache: Map<string, AutocompleteParseError[]>;
+    reset: () => void;
     enumerate: () => Promise<Set<string>>;
 }
 
-declare function createAutocomplete(_uno: UnoGenerator | Promise<UnoGenerator>, options?: AutocompleteOptions): UnocssAutocomplete;
-
-declare const shorthands: Record<string, string>;
-declare const ignoredThemeKeys: string[];
-declare function parseAutocomplete(template: string, theme?: any, extraShorthands?: Record<string, string>): ParsedAutocompleteTemplate;
+declare function createAutocomplete(uno: UnoGenerator, options?: AutocompleteOptions): UnocssAutocomplete;
 
 declare function searchUsageBoundary(line: string, index: number, attributify?: boolean): {
     content: string;
@@ -45,5 +53,5 @@ declare function searchUsageBoundary(line: string, index: number, attributify?:
 declare function searchAttrKey(content: string, cursor: number): string | undefined;
 declare function cartesian<T>(arr: T[][]): T[][];
 
-export { cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };
+export { AutocompleteParseError, cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };
 export type { AutoCompleteMatchType, AutocompleteOptions, AutocompleteTemplateGroup, AutocompleteTemplatePart, AutocompleteTemplateStatic, AutocompleteTemplateTheme, ParsedAutocompleteTemplate, UnocssAutocomplete };

package/dist/index.d.ts

@@ -1,9 +1,19 @@
 import { SuggestResult, AutoCompleteFunction, UnoGenerator } from '@unocss/core';
 import { LRUCache } from 'lru-cache';
 
+declare class AutocompleteParseError extends Error {
+    readonly template?: string | undefined;
+    constructor(message: string, template?: string | undefined);
+    toString(): string;
+}
+declare const shorthands: Record<string, string>;
+declare const ignoredThemeKeys: string[];
+declare function parseAutocomplete(template: string, theme?: any, extraShorthands?: Record<string, string>): ParsedAutocompleteTemplate;
+
 type AutoCompleteMatchType = 'prefix' | 'fuzzy';
 interface AutocompleteOptions {
     matchType?: AutoCompleteMatchType;
+    throwErrors?: boolean;
 }
 type AutocompleteTemplatePart = AutocompleteTemplateStatic | AutocompleteTemplateGroup | AutocompleteTemplateTheme;
 interface AutocompleteTemplateStatic {
@@ -21,21 +31,19 @@ interface AutocompleteTemplateTheme {
 interface ParsedAutocompleteTemplate {
     parts: AutocompleteTemplatePart[];
     suggest: (input: string, matchType?: AutoCompleteMatchType) => string[] | undefined;
+    errors: AutocompleteParseError[];
 }
 interface UnocssAutocomplete {
     suggest: (input: string, allowsEmptyInput?: boolean) => Promise<string[]>;
     suggestInFile: (content: string, cursor: number) => Promise<SuggestResult | undefined>;
     templates: (string | AutoCompleteFunction)[];
     cache: LRUCache<string, string[]>;
-    reset: () => Promise<void>;
+    errorCache: Map<string, AutocompleteParseError[]>;
+    reset: () => void;
     enumerate: () => Promise<Set<string>>;
 }
 
-declare function createAutocomplete(_uno: UnoGenerator | Promise<UnoGenerator>, options?: AutocompleteOptions): UnocssAutocomplete;
-
-declare const shorthands: Record<string, string>;
-declare const ignoredThemeKeys: string[];
-declare function parseAutocomplete(template: string, theme?: any, extraShorthands?: Record<string, string>): ParsedAutocompleteTemplate;
+declare function createAutocomplete(uno: UnoGenerator, options?: AutocompleteOptions): UnocssAutocomplete;
 
 declare function searchUsageBoundary(line: string, index: number, attributify?: boolean): {
     content: string;
@@ -45,5 +53,5 @@ declare function searchUsageBoundary(line: string, index: number, attributify?:
 declare function searchAttrKey(content: string, cursor: number): string | undefined;
 declare function cartesian<T>(arr: T[][]): T[][];
 
-export { cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };
+export { AutocompleteParseError, cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };
 export type { AutoCompleteMatchType, AutocompleteOptions, AutocompleteTemplateGroup, AutocompleteTemplatePart, AutocompleteTemplateStatic, AutocompleteTemplateTheme, ParsedAutocompleteTemplate, UnocssAutocomplete };

package/dist/index.mjs

@@ -2,6 +2,8 @@ import { uniq, escapeRegExp, toArray } from '@unocss/core';
 import { Fzf, byStartAsc, byLengthAsc } from 'fzf';
 import { LRUCache } from 'lru-cache';
 
+const name = "@unocss/autocomplete";
+
 function searchUsageBoundary(line, index, attributify = true) {
   let start = index;
   let end = index;
@@ -74,6 +76,17 @@ function cartesian(arr) {
   );
 }
 
+class AutocompleteParseError extends Error {
+  constructor(message, template) {
+    super(message);
+    this.template = template;
+    this.name = name;
+    this.template = template;
+  }
+  toString() {
+    return `\u26A0\uFE0F [${this.name}]: ${this.message}. ${this.template ? `Template: ${this.template}.` : ""}`;
+  }
+}
 const shorthands = {
   directions: "(x|y|t|b|l|r|s|e)",
   num: `(${[0, 1, 2, 3, 4, 5, 6, 8, 10, 12, 24, 36].join("|")})`,
@@ -95,20 +108,27 @@ function handleRegexMatch(str, regex, onMatched, onNotMatched) {
 }
 function parseAutocomplete(template, theme = {}, extraShorthands = {}) {
   const parts = [];
+  const errors = [];
   const newShorthands = {
     ...shorthands,
     ...extraShorthands
   };
-  template = template.replace(/<(\w+)>/g, (_, key) => {
-    if (!newShorthands[key])
-      throw new Error(`Unknown template shorthand: ${key}`);
+  template = template.replace(/<(\w+)>/g, (match, key, _, raw) => {
+    if (!newShorthands[key]) {
+      errors.push(new AutocompleteParseError(`Unknown template shorthand: <${key}>`, raw));
+      return match;
+    }
     return newShorthands[key];
   });
   handleGroups(template);
+  if (errors.length) {
+    parts.length = 0;
+  }
   const fzf = new Fzf(getAllCombination(parts));
   return {
     parts,
-    suggest
+    suggest,
+    errors
   };
   function handleNonGroup(input) {
     handleRegexMatch(
@@ -119,8 +139,10 @@ function parseAutocomplete(template, theme = {}, extraShorthands = {}) {
           type: "theme",
           objects: m[1].split("|").map((i) => {
             return i.split(".").reduce((v, k) => {
-              if (!k || !v[k])
-                throw new Error(`Invalid theme key ${k}`);
+              if (!k || !v[k]) {
+                errors.push(new AutocompleteParseError(`Invalid theme key: ${k}`, m.input));
+                return {};
+              }
               return v[k];
             }, theme);
           })
@@ -248,19 +270,23 @@ function getAllCombination(parts) {
   return list;
 }
 
-function createAutocomplete(_uno, options = {}) {
+function createAutocomplete(uno, options = {}) {
   const templateCache = /* @__PURE__ */ new Map();
   const cache = new LRUCache({ max: 5e3 });
+  const errorCache = /* @__PURE__ */ new Map();
   let staticUtils = [];
   const templates = [];
-  const matchType = options.matchType ?? "prefix";
-  let uno;
-  const ready = reset();
+  const {
+    matchType = "prefix",
+    throwErrors = true
+  } = options;
+  reset();
   return {
     suggest,
     suggestInFile,
     templates,
     cache,
+    errorCache,
     reset,
     /**
      * Enumerate possible suggestions from 'aa' - 'zz'
@@ -283,13 +309,7 @@ function createAutocomplete(_uno, options = {}) {
     );
     return matched;
   }
-  function getParsed(template) {
-    if (!templateCache.has(template))
-      templateCache.set(template, parseAutocomplete(template, uno.config.theme, uno.config.autocomplete.shorthands));
-    return templateCache.get(template).suggest;
-  }
   async function suggest(input, allowsEmptyInput = false) {
-    await ready;
     if (!allowsEmptyInput && input.length < 1)
       return [];
     if (cache.has(input))
@@ -298,7 +318,7 @@ function createAutocomplete(_uno, options = {}) {
     const attributifyPrefix = attributify?.options?.prefix;
     const _input = attributifyPrefix ? input.startsWith(attributifyPrefix) ? input.slice(attributifyPrefix.length) : input.replace(`:${attributifyPrefix}`, ":") : input;
     const matched = await uno.matchVariants(_input);
-    let result = (await Promise.all(matched.map(async ([, processed, , variants]) => {
+    let result = (await Promise.all(matched.map(async ([, processed]) => {
       let idx = processed ? input.search(escapeRegExp(processed)) : input.length;
       if (idx === -1)
         idx = 0;
@@ -309,8 +329,7 @@ function createAutocomplete(_uno, options = {}) {
           suggestSelf(processed),
           suggestStatic(processed),
           suggestUnoCache(processed),
-          ...suggestFromPreset(processed),
-          ...suggestVariant(processed, variants)
+          suggestFromTemplates(processed)
         ]),
         variantPrefix,
         variantSuffix
@@ -327,7 +346,6 @@ function createAutocomplete(_uno, options = {}) {
     return result;
   }
   async function suggestInFile(content, cursor) {
-    await ready;
     const isInsideAttrValue = searchAttrKey(content, cursor) !== void 0;
     const byExtractor = await searchUsageByExtractor(content, cursor);
     if (byExtractor) {
@@ -378,18 +396,17 @@ function createAutocomplete(_uno, options = {}) {
     const keys = Array.from(uno.cache.entries());
     return keys.filter((i) => i[1] && i[0].startsWith(input)).map((i) => i[0]);
   }
-  function suggestFromPreset(input) {
-    return templates.map((fn) => typeof fn === "function" ? fn(input) : getParsed(fn)(input, matchType)) || [];
-  }
-  function suggestVariant(input, used) {
-    return uno.config.variants.filter((v) => v.autocomplete && (v.multiPass || !used.has(v))).flatMap((v) => toArray(v.autocomplete || [])).map((fn) => typeof fn === "function" ? fn(input) : getParsed(fn)(input, matchType));
+  async function suggestFromTemplates(input) {
+    const ps = await Promise.allSettled([
+      Array.from(templateCache.values()).flatMap(({ suggest: suggest2 }) => suggest2(input, matchType) ?? []),
+      ...templates.filter((fn) => typeof fn === "function").map((fn) => fn(input))
+    ]);
+    return ps.flatMap((i) => i.status === "fulfilled" ? i.value : []);
   }
-  async function reset() {
+  function reset() {
     templateCache.clear();
     cache.clear();
-    if (!uno) {
-      uno = await Promise.resolve(_uno);
-    }
+    errorCache.clear();
     staticUtils = [
       ...Object.keys(uno.config.rulesStaticMap),
       ...uno.config.shortcuts.filter((i) => typeof i[0] === "string").map((i) => i[0])
@@ -398,8 +415,25 @@ function createAutocomplete(_uno, options = {}) {
     templates.push(
       ...uno.config.autocomplete.templates || [],
       ...uno.config.rulesDynamic.flatMap((i) => toArray(i?.[2]?.autocomplete || [])),
-      ...uno.config.shortcuts.flatMap((i) => toArray(i?.[2]?.autocomplete || []))
+      ...uno.config.shortcuts.flatMap((i) => toArray(i?.[2]?.autocomplete || [])),
+      ...uno.config.variants.flatMap((v) => toArray(v.autocomplete || []))
     );
+    for (const template of templates) {
+      if (typeof template !== "function") {
+        if (templateCache.has(template) || errorCache.has(template)) {
+          continue;
+        }
+        const parsed = parseAutocomplete(template, uno.config.theme, uno.config.autocomplete.shorthands);
+        if (parsed.errors.length) {
+          errorCache.set(template, parsed.errors);
+        }
+        templateCache.set(template, parsed);
+      }
+    }
+    if (errorCache.size && throwErrors) {
+      const message = Array.from(errorCache.values()).flat().map((error) => error.toString()).join("\n");
+      throw new Error(message);
+    }
   }
   function processSuggestions(suggestions, prefix = "", suffix = "") {
     return uniq(suggestions.flat()).filter((i) => !!(i && !i.endsWith("-") && !uno.isBlocked(i))).sort((a, b) => {
@@ -416,4 +450,4 @@ function createAutocomplete(_uno, options = {}) {
   }
 }
 
-export { cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };
+export { AutocompleteParseError, cartesian, createAutocomplete, ignoredThemeKeys, parseAutocomplete, searchAttrKey, searchUsageBoundary, shorthands };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unocss/autocomplete",
   "type": "module",
-  "version": "66.4.1",
+  "version": "66.5.0",
   "description": "Autocomplete utils for UnoCSS",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "lru-cache": "^11.1.0"
   },
   "devDependencies": {
-    "@unocss/core": "66.4.1"
+    "@unocss/core": "66.5.0"
   },
   "scripts": {
     "build": "unbuild",