@unocss/core 0.31.16 → 0.32.1

package/dist/index.cjs

@@ -155,6 +155,8 @@ function isRawUtil(util) {
 function notNull(value) {
   return value != null;
 }
+function noop() {
+}
 
 class TwoKeyMap {
   constructor() {
@@ -407,7 +409,7 @@ function resolveConfig(userConfig = {}, defaults = {}) {
   const rulesSize = rules.length;
   rules.forEach((rule, i) => {
     if (isStaticRule(rule)) {
-      rulesStaticMap[rule[0]] = [i, rule[1], rule[2]];
+      rulesStaticMap[rule[0]] = [i, rule[1], rule[2], rule];
       delete rules[i];
     }
   });
@@ -445,7 +447,7 @@ function resolveConfig(userConfig = {}, defaults = {}) {
   };
 }
 
-const version = "0.31.16";
+const version = "0.32.1";
 
 class UnoGenerator {
   constructor(userConfig = {}, defaults = {}) {
@@ -515,6 +517,8 @@ class UnoGenerator {
       return;
     }
     const context = this.makeContext(raw, [alias || applied[0], applied[1], applied[2], applied[3]]);
+    if (this.config.details)
+      context.variants = [...applied[3]];
     const expanded = this.expandShortcut(context.currentSelector, context);
     if (expanded) {
       const utils = await this.stringifyShortcuts(context.variantMatch, context, expanded[0], expanded[1]);
@@ -523,7 +527,7 @@ class UnoGenerator {
         return utils;
       }
     } else {
-      const utils = (await this.parseUtil(context.variantMatch, context))?.map((i) => this.stringifyUtil(i)).filter(notNull);
+      const utils = (await this.parseUtil(context.variantMatch, context))?.map((i) => this.stringifyUtil(i, context)).filter(notNull);
       if (utils?.length) {
         this._cache.set(cacheKey, utils);
         return utils;
@@ -680,10 +684,16 @@ class UnoGenerator {
   }
   async parseUtil(input, context, internal = false) {
     const [raw, processed, variantHandlers] = typeof input === "string" ? this.matchVariants(input) : input;
+    const recordRule = this.config.details ? (r) => {
+      context.rules = context.rules ?? [];
+      context.rules.push(r);
+    } : noop;
     const staticMatch = this.config.rulesStaticMap[processed];
     if (staticMatch) {
-      if (staticMatch[1] && (internal || !staticMatch[2]?.internal))
+      if (staticMatch[1] && (internal || !staticMatch[2]?.internal)) {
+        recordRule(staticMatch[3]);
         return [[staticMatch[0], raw, normalizeCSSEntries(staticMatch[1]), staticMatch[2], variantHandlers]];
+      }
     }
     context.variantHandlers = variantHandlers;
     const { rulesDynamic, rulesSize } = this.config;
@@ -700,6 +710,7 @@ class UnoGenerator {
       const result = await handler(match, context);
       if (!result)
         continue;
+      recordRule(rule);
       if (typeof result === "string")
         return [[i, result, meta]];
       const entries = normalizeCSSValues(result).filter((i2) => i2.length);
@@ -707,11 +718,11 @@ class UnoGenerator {
         return entries.map((e2) => [i, raw, e2, meta, variantHandlers]);
     }
   }
-  stringifyUtil(parsed) {
+  stringifyUtil(parsed, context) {
     if (!parsed)
       return;
     if (isRawUtil(parsed))
-      return [parsed[0], void 0, parsed[1], void 0, parsed[2]];
+      return [parsed[0], void 0, parsed[1], void 0, parsed[2], this.config.details ? context : void 0];
     const { selector, entries, parent, layer: variantLayer, sort: variantSort } = this.applyVariants(parsed);
     const body = entriesToCss(entries);
     if (!body)
@@ -722,11 +733,15 @@ class UnoGenerator {
       layer: variantLayer ?? metaLayer,
       sort: variantSort ?? metaSort
     };
-    return [parsed[0], selector, body, parent, ruleMeta];
+    return [parsed[0], selector, body, parent, ruleMeta, this.config.details ? context : void 0];
   }
   expandShortcut(processed, context, depth = 3) {
     if (depth === 0)
       return;
+    const recordShortcut = this.config.details ? (s) => {
+      context.shortcuts = context.shortcuts ?? [];
+      context.shortcuts.push(s);
+    } : noop;
     let meta;
     let result;
     for (const s of this.config.shortcuts) {
@@ -734,6 +749,7 @@ class UnoGenerator {
         if (s[0] === processed) {
           meta = meta || s[2];
           result = s[1];
+          recordShortcut(s);
           break;
         }
       } else {
@@ -742,6 +758,7 @@ class UnoGenerator {
           result = s[1](match, context);
         if (result) {
           meta = meta || s[2];
+          recordShortcut(s);
           break;
         }
       }
@@ -767,7 +784,7 @@ class UnoGenerator {
     const rawStringfieldUtil = [];
     for (const item of parsed) {
       if (isRawUtil(item)) {
-        rawStringfieldUtil.push([item[0], void 0, item[1], void 0, item[2]]);
+        rawStringfieldUtil.push([item[0], void 0, item[1], void 0, item[2], context]);
         continue;
       }
       const { selector, entries, parent: parent2, sort } = this.applyVariants(item, [...item[4], ...parentVariants], raw);
@@ -781,7 +798,7 @@ class UnoGenerator {
         return (flatten ? [entriesList.flat(1)] : entriesList).map((entries) => {
           const body = entriesToCss(entries);
           if (body)
-            return [index, selector, body, mediaQuery, { ...meta, noMerge, sort: maxSort }];
+            return [index, selector, body, mediaQuery, { ...meta, noMerge, sort: maxSort }, context];
           return void 0;
         });
       };
@@ -844,6 +861,7 @@ exports.isValidSelector = isValidSelector;
 exports.matchingPair = matchingPair;
 exports.mergeDeep = mergeDeep;
 exports.mergeSet = mergeSet;
+exports.noop = noop;
 exports.normalizeCSSEntries = normalizeCSSEntries;
 exports.normalizeCSSValues = normalizeCSSValues;
 exports.normalizeVariant = normalizeVariant;

package/dist/index.d.ts

@@ -19,7 +19,7 @@ declare class UnoGenerator {
     applyVariants(parsed: ParsedUtil, variantHandlers?: VariantHandler[], raw?: string): UtilObject;
     constructCustomCSS(context: Readonly<RuleContext>, body: CSSObject | CSSEntries, overrideSelector?: string): string;
     parseUtil(input: string | VariantMatchedResult, context: RuleContext, internal?: boolean): Promise<ParsedUtil[] | RawUtil[] | undefined>;
-    stringifyUtil(parsed?: ParsedUtil | RawUtil): StringifiedUtil | undefined;
+    stringifyUtil(parsed?: ParsedUtil | RawUtil, context?: RuleContext): StringifiedUtil | undefined;
     expandShortcut(processed: string, context: RuleContext, depth?: number): [string[], RuleMeta | undefined] | undefined;
     stringifyShortcuts(parent: VariantMatchedResult, context: RuleContext, expanded: string[], meta?: RuleMeta): Promise<StringifiedUtil[] | undefined>;
     isBlocked(raw: string): boolean;
@@ -58,6 +58,7 @@ declare function isValidSelector(selector?: string): selector is string;
 declare function normalizeVariant(variant: Variant): VariantObject;
 declare function isRawUtil(util: ParsedUtil | RawUtil | StringifiedUtil): util is RawUtil;
 declare function notNull<T>(value: T | null | undefined): value is T;
+declare function noop(): void;
 
 declare class TwoKeyMap<K1, K2, V> {
     _map: Map<K1, Map<K2, V>>;
@@ -187,6 +188,18 @@ interface RuleContext<Theme extends {} = {}> {
      * Variants and selector escaping will be handled automatically.
      */
     constructCSS: (body: CSSEntries | CSSObject, overrideSelector?: string) => string;
+    /**
+     * Available only when `details` option is enabled.
+     */
+    rules?: Rule[];
+    /**
+     * Available only when `details` option is enabled.
+     */
+    shortcuts?: Shortcut[];
+    /**
+     * Available only when `details` option is enabled.
+     */
+    variants?: Variant[];
 }
 interface VariantContext<Theme extends {} = {}> {
     /**
@@ -386,6 +399,16 @@ interface ConfigBase<Theme extends {} = {}> {
          */
         extractors?: Arrayable<AutoCompleteExtractor>;
     };
+    /**
+     * Expose internal details for debugging / inspecting
+     *
+     * Added `rules`, `shortcuts`, `variants` to the context and expose the context object in `StringifiedUtil`
+     *
+     * You don't usually need to set this.
+     *
+     * @default false
+     */
+    details?: boolean;
 }
 declare type AutoCompleteTemplate = string;
 declare type AutoCompleteFunction = (input: string) => Awaitable<string[]>;
@@ -564,7 +587,7 @@ interface ResolvedConfig extends Omit<RequiredByKey<UserConfig, 'mergeSelectors'
     postprocess: Postprocessor[];
     rulesSize: number;
     rulesDynamic: (DynamicRule | undefined)[];
-    rulesStaticMap: Record<string, [number, CSSObject | CSSEntries, RuleMeta | undefined] | undefined>;
+    rulesStaticMap: Record<string, [number, CSSObject | CSSEntries, RuleMeta | undefined, Rule] | undefined>;
     autocomplete: {
         templates: (AutoCompleteFunction | AutoCompleteTemplate)[];
         extractors: AutoCompleteExtractor[];
@@ -600,7 +623,8 @@ declare type StringifiedUtil = readonly [
     selector: string | undefined,
     body: string,
     parent: string | undefined,
-    meta: RuleMeta | undefined
+    meta: RuleMeta | undefined,
+    context: RuleContext | undefined
 ];
 interface UtilObject {
     selector: string;
@@ -639,4 +663,4 @@ declare const extractorSplit: Extractor;
 
 declare const extractorSvelte: Extractor;
 
-export { ArgumentType, Arrayable, AutoCompleteExtractor, AutoCompleteExtractorContext, AutoCompleteExtractorResult, AutoCompleteFunction, AutoCompleteTemplate, Awaitable, BetterMap, BlocklistRule, CONTROL_SHORTCUT_NO_MERGE, CSSColorValue, CSSEntries, CSSObject, CSSValues, ConfigBase, DeepPartial, DetailString, DynamicMatcher, DynamicRule, DynamicShortcut, DynamicShortcutMatcher, ExtractStringOptions, Extractor, ExtractorContext, FilterPattern, FlatObjectTuple, GenerateOptions, GenerateResult, GeneratorOptions, ParsedColorValue, ParsedUtil, PartialByKeys, PluginOptions, Postprocessor, Preflight, PreflightContext, Preprocessor, Preset, PresetOptions, RGBAColorValue, Range, RawUtil, Replacement, RequiredByKey, ResolvedConfig, RestArgs, Rule, RuleContext, RuleMeta, Shift, Shortcut, SourceCodeTransformer, SourceMap, StaticRule, StaticShortcut, StaticShortcutMap, StringifiedUtil, SuggestResult, ThemeExtender, TransformResult, TwoKeyMap, UnoGenerator, UnocssPluginContext, UserConfig, UserConfigDefaults, UserOnlyOptions, UserShortcuts, UtilObject, ValueHandler, ValueHandlerCallback, Variant, VariantContext, VariantFunction, VariantHandler, VariantMatchedResult, VariantObject, attributifyRE, clearIdenticalEntries, clone, createGenerator, createValueHandler, e, entriesToCss, escapeRegExp, escapeSelector, expandVariantGroup, extractQuoted, extractorSplit, extractorSvelte, hasScopePlaceholder, isAttributifySelector, isObject, isRawUtil, isStaticRule, isStaticShortcut, isValidSelector, matchingPair, mergeDeep, mergeSet, normalizeCSSEntries, normalizeCSSValues, normalizeVariant, notNull, regexClassGroup, regexScopePlaceholder, toArray, toEscapedSelector, uniq, validateFilterRE, warnOnce, withLayer };
+export { ArgumentType, Arrayable, AutoCompleteExtractor, AutoCompleteExtractorContext, AutoCompleteExtractorResult, AutoCompleteFunction, AutoCompleteTemplate, Awaitable, BetterMap, BlocklistRule, CONTROL_SHORTCUT_NO_MERGE, CSSColorValue, CSSEntries, CSSObject, CSSValues, ConfigBase, DeepPartial, DetailString, DynamicMatcher, DynamicRule, DynamicShortcut, DynamicShortcutMatcher, ExtractStringOptions, Extractor, ExtractorContext, FilterPattern, FlatObjectTuple, GenerateOptions, GenerateResult, GeneratorOptions, ParsedColorValue, ParsedUtil, PartialByKeys, PluginOptions, Postprocessor, Preflight, PreflightContext, Preprocessor, Preset, PresetOptions, RGBAColorValue, Range, RawUtil, Replacement, RequiredByKey, ResolvedConfig, RestArgs, Rule, RuleContext, RuleMeta, Shift, Shortcut, SourceCodeTransformer, SourceMap, StaticRule, StaticShortcut, StaticShortcutMap, StringifiedUtil, SuggestResult, ThemeExtender, TransformResult, TwoKeyMap, UnoGenerator, UnocssPluginContext, UserConfig, UserConfigDefaults, UserOnlyOptions, UserShortcuts, UtilObject, ValueHandler, ValueHandlerCallback, Variant, VariantContext, VariantFunction, VariantHandler, VariantMatchedResult, VariantObject, attributifyRE, clearIdenticalEntries, clone, createGenerator, createValueHandler, e, entriesToCss, escapeRegExp, escapeSelector, expandVariantGroup, extractQuoted, extractorSplit, extractorSvelte, hasScopePlaceholder, isAttributifySelector, isObject, isRawUtil, isStaticRule, isStaticShortcut, isValidSelector, matchingPair, mergeDeep, mergeSet, noop, normalizeCSSEntries, normalizeCSSValues, normalizeVariant, notNull, regexClassGroup, regexScopePlaceholder, toArray, toEscapedSelector, uniq, validateFilterRE, warnOnce, withLayer };

package/dist/index.mjs

@@ -151,6 +151,8 @@ function isRawUtil(util) {
 function notNull(value) {
   return value != null;
 }
+function noop() {
+}
 
 class TwoKeyMap {
   constructor() {
@@ -403,7 +405,7 @@ function resolveConfig(userConfig = {}, defaults = {}) {
   const rulesSize = rules.length;
   rules.forEach((rule, i) => {
     if (isStaticRule(rule)) {
-      rulesStaticMap[rule[0]] = [i, rule[1], rule[2]];
+      rulesStaticMap[rule[0]] = [i, rule[1], rule[2], rule];
       delete rules[i];
     }
   });
@@ -441,7 +443,7 @@ function resolveConfig(userConfig = {}, defaults = {}) {
   };
 }
 
-const version = "0.31.16";
+const version = "0.32.1";
 
 class UnoGenerator {
   constructor(userConfig = {}, defaults = {}) {
@@ -511,6 +513,8 @@ class UnoGenerator {
       return;
     }
     const context = this.makeContext(raw, [alias || applied[0], applied[1], applied[2], applied[3]]);
+    if (this.config.details)
+      context.variants = [...applied[3]];
     const expanded = this.expandShortcut(context.currentSelector, context);
     if (expanded) {
       const utils = await this.stringifyShortcuts(context.variantMatch, context, expanded[0], expanded[1]);
@@ -519,7 +523,7 @@ class UnoGenerator {
         return utils;
       }
     } else {
-      const utils = (await this.parseUtil(context.variantMatch, context))?.map((i) => this.stringifyUtil(i)).filter(notNull);
+      const utils = (await this.parseUtil(context.variantMatch, context))?.map((i) => this.stringifyUtil(i, context)).filter(notNull);
       if (utils?.length) {
         this._cache.set(cacheKey, utils);
         return utils;
@@ -676,10 +680,16 @@ class UnoGenerator {
   }
   async parseUtil(input, context, internal = false) {
     const [raw, processed, variantHandlers] = typeof input === "string" ? this.matchVariants(input) : input;
+    const recordRule = this.config.details ? (r) => {
+      context.rules = context.rules ?? [];
+      context.rules.push(r);
+    } : noop;
     const staticMatch = this.config.rulesStaticMap[processed];
     if (staticMatch) {
-      if (staticMatch[1] && (internal || !staticMatch[2]?.internal))
+      if (staticMatch[1] && (internal || !staticMatch[2]?.internal)) {
+        recordRule(staticMatch[3]);
         return [[staticMatch[0], raw, normalizeCSSEntries(staticMatch[1]), staticMatch[2], variantHandlers]];
+      }
     }
     context.variantHandlers = variantHandlers;
     const { rulesDynamic, rulesSize } = this.config;
@@ -696,6 +706,7 @@ class UnoGenerator {
       const result = await handler(match, context);
       if (!result)
         continue;
+      recordRule(rule);
       if (typeof result === "string")
         return [[i, result, meta]];
       const entries = normalizeCSSValues(result).filter((i2) => i2.length);
@@ -703,11 +714,11 @@ class UnoGenerator {
         return entries.map((e2) => [i, raw, e2, meta, variantHandlers]);
     }
   }
-  stringifyUtil(parsed) {
+  stringifyUtil(parsed, context) {
     if (!parsed)
       return;
     if (isRawUtil(parsed))
-      return [parsed[0], void 0, parsed[1], void 0, parsed[2]];
+      return [parsed[0], void 0, parsed[1], void 0, parsed[2], this.config.details ? context : void 0];
     const { selector, entries, parent, layer: variantLayer, sort: variantSort } = this.applyVariants(parsed);
     const body = entriesToCss(entries);
     if (!body)
@@ -718,11 +729,15 @@ class UnoGenerator {
       layer: variantLayer ?? metaLayer,
       sort: variantSort ?? metaSort
     };
-    return [parsed[0], selector, body, parent, ruleMeta];
+    return [parsed[0], selector, body, parent, ruleMeta, this.config.details ? context : void 0];
   }
   expandShortcut(processed, context, depth = 3) {
     if (depth === 0)
       return;
+    const recordShortcut = this.config.details ? (s) => {
+      context.shortcuts = context.shortcuts ?? [];
+      context.shortcuts.push(s);
+    } : noop;
     let meta;
     let result;
     for (const s of this.config.shortcuts) {
@@ -730,6 +745,7 @@ class UnoGenerator {
         if (s[0] === processed) {
           meta = meta || s[2];
           result = s[1];
+          recordShortcut(s);
           break;
         }
       } else {
@@ -738,6 +754,7 @@ class UnoGenerator {
           result = s[1](match, context);
         if (result) {
           meta = meta || s[2];
+          recordShortcut(s);
           break;
         }
       }
@@ -763,7 +780,7 @@ class UnoGenerator {
     const rawStringfieldUtil = [];
     for (const item of parsed) {
       if (isRawUtil(item)) {
-        rawStringfieldUtil.push([item[0], void 0, item[1], void 0, item[2]]);
+        rawStringfieldUtil.push([item[0], void 0, item[1], void 0, item[2], context]);
         continue;
       }
       const { selector, entries, parent: parent2, sort } = this.applyVariants(item, [...item[4], ...parentVariants], raw);
@@ -777,7 +794,7 @@ class UnoGenerator {
         return (flatten ? [entriesList.flat(1)] : entriesList).map((entries) => {
           const body = entriesToCss(entries);
           if (body)
-            return [index, selector, body, mediaQuery, { ...meta, noMerge, sort: maxSort }];
+            return [index, selector, body, mediaQuery, { ...meta, noMerge, sort: maxSort }, context];
           return void 0;
         });
       };
@@ -813,4 +830,4 @@ function toEscapedSelector(raw) {
   return `.${e(raw)}`;
 }
 
-export { BetterMap, CONTROL_SHORTCUT_NO_MERGE, TwoKeyMap, UnoGenerator, attributifyRE, clearIdenticalEntries, clone, createGenerator, createValueHandler, e, entriesToCss, escapeRegExp, escapeSelector, expandVariantGroup, extractQuoted, extractorSplit, extractorSvelte, hasScopePlaceholder, isAttributifySelector, isObject, isRawUtil, isStaticRule, isStaticShortcut, isValidSelector, matchingPair, mergeDeep, mergeSet, normalizeCSSEntries, normalizeCSSValues, normalizeVariant, notNull, regexClassGroup, regexScopePlaceholder, toArray, toEscapedSelector, uniq, validateFilterRE, warnOnce, withLayer };
+export { BetterMap, CONTROL_SHORTCUT_NO_MERGE, TwoKeyMap, UnoGenerator, attributifyRE, clearIdenticalEntries, clone, createGenerator, createValueHandler, e, entriesToCss, escapeRegExp, escapeSelector, expandVariantGroup, extractQuoted, extractorSplit, extractorSvelte, hasScopePlaceholder, isAttributifySelector, isObject, isRawUtil, isStaticRule, isStaticShortcut, isValidSelector, matchingPair, mergeDeep, mergeSet, noop, normalizeCSSEntries, normalizeCSSValues, normalizeVariant, notNull, regexClassGroup, regexScopePlaceholder, toArray, toEscapedSelector, uniq, validateFilterRE, warnOnce, withLayer };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unocss/core",
-  "version": "0.31.16",
+  "version": "0.32.1",
   "description": "The instant on-demand Atomic CSS engine.",
   "keywords": [
     "unocss",