@terrazzo/plugin-css 2.3.0 → 2.5.0

package/dist/index.d.ts

@@ -1,173 +1,8 @@
-import { TransformCSSValueOptions } from "@terrazzo/token-tools/css";
-import { CachedWildcardMatcher } from "@terrazzo/token-tools";
-import { BuildHookOptions, Config, Logger, Plugin, TokenNormalized, TokenTransformed, TransformHookOptions } from "@terrazzo/parser";
-
-//#region src/lib.d.ts
-type UtilityCSSGroup = 'bg' | 'border' | 'font' | 'layout' | 'shadow' | 'text';
-type UtilityCSSPrefix = 'bg' | 'border' | 'font' | 'gap' | 'm' | 'p' | 'shadow' | 'text';
-declare const PLUGIN_NAME = "@terrazzo/plugin-css";
-declare const FORMAT_ID = "css";
-declare const FILE_PREFIX = "/* -------------------------------------------\n *  Autogenerated by \u26CB Terrazzo. DO NOT EDIT!\n * ------------------------------------------- */";
-interface CSSPluginOptions {
-  /**
-   * Where to output CSS
-   * @default "index.css"
-   */
-  filename?: string;
-  /** Glob patterns to filter tokens in output */
-  include?: string[];
-  /** Glob patterns to exclude tokens from output */
-  exclude?: string[];
-  /**
-   * Set the base selector, like ":root" or ":host".
-   * @deprecated use permutations instead.
-   * @default ":root"
-   */
-  baseSelector?: string;
-  /**
-   * Set the color-scheme CSS property for `baseSelector`.
-   * @deprecated use permutations instead.
-   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/Reference/Properties/color-scheme
-   * @example "light dark"
-   */
-  baseScheme?: string;
-  /**
-   * Build resolver contexts into media queries
-   */
-  permutations?: Permutation[];
-  /**
-   * Define mode selectors as media queries or CSS classes
-   * @deprecated Migrate to permutations
-   */
-  modeSelectors?: ModeSelector[];
-  /** Control the final CSS variable name */
-  variableName?: (token: TokenNormalized) => string;
-  /** Override certain token values */
-  transform?: (token: TokenNormalized, options: TransformCSSValueOptions) => TokenTransformed['value'] | undefined | null;
-  /** Generate utility CSS from groups */
-  utility?: Partial<Record<UtilityCSSGroup, string[]>>;
-  /**
-   * Output colors as hex-6/hex-8 instead of color() function
-   * @default false
-   */
-  legacyHex?: boolean;
-  /**
-   * Skip generating any `.css` files (useful if you are consuming values in your own plugin and don’t need any `.css` files written to disk).
-   * @default false
-   */
-  skipBuild?: boolean;
-  /**
-   * Generate CSS @property definitions for type-safe CSS Custom Properties.
-   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/@property
-   * @default false
-   */
-  propertyDefinitions?: boolean;
-  /**
-   * Do not generate CSS shorthand declarations for typography tokens.
-   *
-   * Note that individual, per-subvalue declarations will still be generated for these tokens.
-   * @default false
-   */
-  omitTypographyShorthand?: boolean;
-  /**
-   * Control how sub value names are appended to the CSS variable name.
-   *
-   * By default, sub value names are appended as is with a hyphen. E.g. given CSS variable name `--my-token` and
-   * sub value name `font-size`, the resulting variable name would be `--my-token-font-size`.
-   */
-  subValueVariableName?: (variableName: string, subValueName: string, token: TokenTransformed) => string;
-}
-interface Permutation<T extends Record<string, string> = Record<string, string>> {
-  /** Generate the final CSS string, wrapping content in the selector(s) of your choice. */
-  prepare(contents: string): string;
-  /** Input for this permutation. */
-  input: T;
-  /** Provide token(s) to include (Note: not including tokens that are used as aliases for other tokens could cause visual bugs in generated CSS) */
-  include?: string[];
-  /** Provide token(s) to exclude (Note: excluding tokens that are used as aliases for other tokens could cause visual bugs in generated CSS) */
-  exclude?: string[];
-  /**
-   * Custom transform for this permutation
-   */
-  transform?: (token: TokenNormalized, options: TransformCSSValueOptions) => TokenTransformed['value'] | undefined | null;
-}
-interface ModeSelector {
-  /** The name of the mode to match */
-  mode: string;
-  /** Provide token IDs to match. Globs are allowed (e.g: `["color.*", "shadow.dark"]`) */
-  tokens?: string[];
-  /** Provide CSS selectors to generate. (e.g.: `["@media (prefers-color-scheme: dark)", "[data-color-theme='dark']"]` ) */
-  selectors: string[];
-  /** Set the color-scheme CSS property for this mode (e.g.: "light", "dark", "light dark") */
-  scheme?: string;
-}
-interface CSSDeclaration {
-  type: 'Declaration';
-  property: string;
-  value: string;
-  comment?: string;
-}
-interface CSSRule {
-  type: 'Rule';
-  prelude: string[];
-  children: (CSSRule | CSSDeclaration)[];
-}
-/**
- * Convert CSSRules into a formatted, indented CSS string.
- * The reason we’re using this homemade version instead of something like css-tree is:
- *
- * 1. css-tree doesn’t support comments :(
- * 2. we are only generating PARTIALS, not full CSS (the user controls the
- *    wrapper). So with a proper AST, we’d be hacking it a little anyway because
- *    we never really have a true, valid, finalized document.
- * 3. we want @terrazzo/plugin-css to run in the browser AND be lean (i.e. don’t
- *    load Prettier or 25MB of wasm).
- * 4. we only have to deal with a small subset of CSS—this doesn’t have to be robust
- *    by any means (even future additions won’t push the limits of the spec).
- */
-declare function printRules(nodes: (CSSRule | CSSDeclaration)[], {
-  indentChar,
-  indentLv,
-  alphabetize
-}?: {
-  indentChar?: string;
-  indentLv?: number;
-  alphabetize?: boolean;
-}): string;
-/** Internal printer for individual nodes */
-declare function printNode(node: CSSRule | CSSDeclaration, {
-  indentChar,
-  indentLv
-}: {
-  indentChar: string;
-  indentLv: number;
-}): string;
-//#endregion
-//#region src/build.d.ts
-interface BuildFormatOptions {
-  logger: Logger;
-  include: CSSPluginOptions['include'];
-  exclude: CSSPluginOptions['exclude'];
-  getTransforms: BuildHookOptions['getTransforms'];
-  modeSelectors: CSSPluginOptions['modeSelectors'];
-  alphabetize?: Config['alphabetize'];
-  permutations: CSSPluginOptions['permutations'];
-  utility: CSSPluginOptions['utility'];
-  baseSelector: string;
-  baseScheme: CSSPluginOptions['baseScheme'];
-  propertyDefinitions: boolean;
-  omitTypographyShorthand: CSSPluginOptions['omitTypographyShorthand'];
-  subValueVariableName: CSSPluginOptions['subValueVariableName'];
-}
-//#endregion
-//#region src/transform.d.ts
-interface TransformOptions {
-  transform: TransformHookOptions;
-  options: CSSPluginOptions;
-}
-//#endregion
-//#region src/index.d.ts
-declare function cssPlugin(options?: CSSPluginOptions): Plugin;
-//#endregion
-export { BuildFormatOptions, type CSSDeclaration, type CSSPluginOptions, type CSSRule, FILE_PREFIX, FORMAT_ID, type ModeSelector, PLUGIN_NAME, type Permutation, TransformOptions, type UtilityCSSGroup, type UtilityCSSPrefix, cssPlugin as default, printNode, printRules };
+import type { Plugin } from '@terrazzo/parser';
+import { type CSSPluginOptions } from './lib.js';
+export * from './build.js';
+export { type CSSDeclaration, type CSSPluginOptions, type CSSRule, FILE_PREFIX, FORMAT_ID, type ModeSelector, type Permutation, PLUGIN_NAME, printNode, printRules, type UtilityCSSGroup, type UtilityCSSPrefix, } from './lib.js';
+export * from './transform.js';
+export * from './utility-css.js';
+export default function cssPlugin(options?: CSSPluginOptions): Plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib.ts","../src/build.ts","../src/transform.ts","../src/index.ts"],"mappings":";;;;;KAKY,eAAA;AAAA,KAEA,gBAAA;AAAA,cAEC,WAAA;AAAA,cAEA,SAAA;AAAA,cAIA,WAAA;AAAA,UAII,gBAAA;EAZL;;;;EAiBV,QAAA;EAfW;EAiBX,OAAA;;EAEA,OAAA;EAnBsB;AAExB;;;;EAuBE,YAAA;EAnBW;;;;AAAW;AAIxB;EAsBE,UAAA;;;;EAIA,YAAA,GAAe,WAAA;EAUN;;;;EALT,aAAA,GAAgB,YAAA;EASN;EAPV,YAAA,IAAgB,KAAA,EAAO,eAAA;EAqCoE;EAnC3F,SAAA,IACE,KAAA,EAAO,eAAA,EACP,OAAA,EAAS,wBAAA,KACN,gBAAA;EAjCL;EAmCA,OAAA,GAAU,OAAA,CAAQ,MAAA,CAAO,eAAA;EA/BzB;;;;EAoCA,SAAA;EAdA;;;;EAmBA,SAAA;EAfA;;;;;EAqBA,mBAAA;EAhBA;;;;;;EAuBA,uBAAA;EAAA;;;;;;EAOA,oBAAA,IAAwB,YAAA,UAAsB,YAAA,UAAsB,KAAA,EAAO,gBAAA;AAAA;AAAA,UAG5D,WAAA,WAAsB,MAAA,mBAAyB,MAAA;EAApC;EAE1B,OAAA,CAAQ,QAAA;EAF6B;EAIrC,KAAA,EAAO,CAAA;EAAA;EAEP,OAAA;EAQW;EANX,OAAA;EAOqB;;;EAHrB,SAAA,IACE,KAAA,EAAO,eAAA,EACP,OAAA,EAAS,wBAAA,KACN,gBAAA;AAAA;AAAA,UAGU,YAAA;EAhBP;EAkBR,IAAA;EAhBO;EAkBP,MAAA;EAdA;EAgBA,SAAA;EAXS;EAaT,MAAA;AAAA;AAAA,UAIe,cAAA;EACf,IAAA;EACA,QAAA;EACA,KAAA;EACA,OAAA;AAAA;AAAA,UAGe,OAAA;EACf,IAAA;EACA,OAAA;EACA,QAAA,GAAW,OAAA,GAAU,cAAc;AAAA;;;AAd7B;AAIR;;;;;;;;;AAIS;iBAsBO,UAAA,CACd,KAAA,GAAQ,OAAA,GAAU,cAAA;EAEhB,UAAA;EACA,QAAA;EACA;AAAA;EACG,UAAA;EAAqB,QAAA;EAAmB,WAAA;AAAA;;iBAuB/B,SAAA,CACd,IAAA,EAAM,OAAA,GAAU,cAAA;EACd,UAAA;EAAY;AAAA;EAAc,UAAA;EAAoB,QAAA;AAAA;;;UCvJjC,kBAAA;EACf,MAAA,EAAQ,MAAA;EACR,OAAA,EAAS,gBAAA;EACT,OAAA,EAAS,gBAAA;EACT,aAAA,EAAe,gBAAA;EACf,aAAA,EAAe,gBAAA;EACf,WAAA,GAAc,MAAA;EACd,YAAA,EAAc,gBAAA;EACd,OAAA,EAAS,gBAAA;EACT,YAAA;EACA,UAAA,EAAY,gBAAA;EACZ,mBAAA;EACA,uBAAA,EAAyB,gBAAA;EACzB,oBAAA,EAAsB,gBAAA;AAAA;;;UCrCP,gBAAA;EACf,SAAA,EAAW,oBAAA;EACX,OAAA,EAAS,gBAAgB;AAAA;;;iBCiBH,SAAA,CAAU,OAAA,GAAU,gBAAA,GAAmB,MAAM"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAG/C,OAAO,EAAE,KAAK,gBAAgB,EAA4B,MAAM,UAAU,CAAC;AAG3E,cAAc,YAAY,CAAC;AAC3B,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,OAAO,EACZ,WAAW,EACX,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,WAAW,EAChB,WAAW,EACX,SAAS,EACT,UAAU,EACV,KAAK,eAAe,EACpB,KAAK,gBAAgB,GACtB,MAAM,UAAU,CAAC;AAClB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AAIjC,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,MAAM,CA+CpE"}