@terrazzo/plugin-sass 2.0.0-alpha.2 → 2.0.0-alpha.5

package/CHANGELOG.md

@@ -1,16 +1,5 @@
 # @terrazzo/plugin-sass
 
-## 2.0.0-alpha.2
-
-### Patch Changes
-
-- [#568](https://github.com/terrazzoapp/terrazzo/pull/568) [`67c75be`](https://github.com/terrazzoapp/terrazzo/commit/67c75be78978cece52b61cf258ccc3a875e6af48) Thanks [@drwpow](https://github.com/drwpow)! - Fix border tokens not cascading correctly across modes
-
-- Updated dependencies [[`67c75be`](https://github.com/terrazzoapp/terrazzo/commit/67c75be78978cece52b61cf258ccc3a875e6af48)]:
-  - @terrazzo/plugin-css@2.0.0-alpha.2
-  - @terrazzo/cli@2.0.0-alpha.2
-  - @terrazzo/token-tools@2.0.0-alpha.2
-
 ## 2.0.0
 
 ### Minor Changes
@@ -21,12 +10,16 @@
 
 - [#530](https://github.com/terrazzoapp/terrazzo/pull/530) [`370ed7b`](https://github.com/terrazzoapp/terrazzo/commit/370ed7b0f578a64824124145d7f4936536b37bb3) Thanks [@drwpow](https://github.com/drwpow)! - ⚠️ [Plugin API] Minor breaking change: token.originalValue may be undefined for tokens created with $ref. This shouldn’t affect any tokens or plugins not using $refs. But going forward this value will be missing if the token was created dynamically via $ref.
 
+- [#589](https://github.com/terrazzoapp/terrazzo/pull/589) [`8f32d44`](https://github.com/terrazzoapp/terrazzo/commit/8f32d44792bba62194e674c9b60cfdeb366c96c7) Thanks [@michaelurban](https://github.com/michaelurban)! - feat: add typography shorthand, improve Sass plugin
+
 ### Patch Changes
 
 - [#530](https://github.com/terrazzoapp/terrazzo/pull/530) [`370ed7b`](https://github.com/terrazzoapp/terrazzo/commit/370ed7b0f578a64824124145d7f4936536b37bb3) Thanks [@drwpow](https://github.com/drwpow)! - Validation moved to lint rules, which means token validation can be individually configured, and optionally extended.
 
 - [#553](https://github.com/terrazzoapp/terrazzo/pull/553) [`e63a627`](https://github.com/terrazzoapp/terrazzo/commit/e63a6277f61282fb608744a8348689b16f977076) Thanks [@Sidnioulz](https://github.com/Sidnioulz)! - Add support for the Token Listing format
 
+- [#568](https://github.com/terrazzoapp/terrazzo/pull/568) [`67c75be`](https://github.com/terrazzoapp/terrazzo/commit/67c75be78978cece52b61cf258ccc3a875e6af48) Thanks [@drwpow](https://github.com/drwpow)! - Fix border tokens not cascading correctly across modes
+
 ## 0.10.4
 
 ### Patch Changes

package/README.md

@@ -4,13 +4,13 @@ Convert DTCG tokens into Sass for use in any web application or native app with
 
 ## Setup
 
-Requires [Node.js 20 or later](https://nodejs.org) and [the CLI installed](https://terrazzo.app/docs/cli). With both installed, run:
+Requires [Node.js](https://nodejs.org) and [the CLI installed](https://terrazzo.app/docs). With both installed, run:
 
 ```sh
 npm i -D @terrazzo/plugin-css @terrazzo/plugin-sass
 ```
 
-Add a `terrazzo.config.js` to the root of your project:
+Add a `terrazzo.config.ts` to the root of your project:
 
 ```ts
 import { defineConfig } from "@terrazzo/cli";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { Plugin } from "@terrazzo/parser";
 import { CSSPluginOptions } from "@terrazzo/plugin-css";
+import { BuildHookOptions, Plugin } from "@terrazzo/parser";
 
 //#region src/lib.d.ts
 declare const FORMAT_ID = "sass";
@@ -12,9 +12,76 @@ interface SassPluginOptions {
 declare const FILE_HEADER = "////\n/// Autogenerated by \u26CB Terrazzo. DO NOT EDIT!\n////\n\n@use \"sass:list\";\n@use \"sass:map\";\n@use \"sass:meta\";";
 declare const MIXIN_TOKEN = "@function token($tokenName) {\n  @if map.has-key($__token-values, $tokenName) == false {\n    @error 'No token named \"#{$tokenName}\"';\n  }\n  $_token: map.get($__token-values, $tokenName);\n  @if meta.type-of($_token) == map and map.has-key($_token, \"__tz-error\") {\n    @error map.get($_token, \"__tz-error\");\n  }\n\n  @return $_token;\n}";
 declare const MIXIN_TYPOGRAPHY = "@mixin typography($tokenName, $modeName: \".\") {\n  @if map.has-key($__token-typography-mixins, $tokenName) == false {\n    @error 'No typography mixin named \"#{$tokenName}\"';\n  }\n  $_mixin: map.get($__token-typography-mixins, $tokenName);\n  $_properties: map.get($_mixin, \".\");\n  @if map.has-key($_mixin) {\n    $_properties: map.get($_mixin);\n  }\n  @each $_property, $_value in $_properties {\n    #{$_property}: #{$_value};\n  }\n}";
+declare function getIndent(indentationLevel: number): string;
+//#endregion
+//#region src/build.d.ts
+interface BuildParams {
+  getTransforms: BuildHookOptions['getTransforms'];
+  options?: SassPluginOptions;
+}
+//#endregion
+//#region src/node.d.ts
+type SassMapKey = string | number;
+type SassMapValue = string | SassToken;
+type SassMapValues = Record<SassMapKey, SassMapValue> | Iterable<[SassMapKey, SassMapValue]>;
+declare abstract class SassToken {
+  readonly indentationLevel: number;
+  constructor(indentationLevel?: number);
+  abstract format(): string;
+  toString(): string;
+  createMap(values?: SassMapValues): SassMap;
+  createVariableDefinition(name: string, value: SassToken): VariableDefinitionSassToken;
+}
+declare abstract class ValueSassToken extends SassToken {
+  toString(): string;
+}
+declare class StringSassToken extends SassToken {
+  readonly value: string;
+  constructor(value: string, indentationLevel?: number);
+  format(): string;
+}
+declare class CssVarReferenceSassToken extends StringSassToken {
+  format(): string;
+}
+declare class BlankLineSassToken extends StringSassToken {
+  constructor();
+}
+declare class RootSassToken extends SassToken {
+  private readonly SEPARATOR;
+  private sassTokens;
+  constructor();
+  append(sassToken: SassToken): void;
+  appendString(value: string): void;
+  appendVariableDefinition(name: string, sassToken: SassToken): void;
+  appendBlankLine(): void;
+  appendUse(value: string, as_?: string): void;
+  format(): string;
+}
+declare class SassMap extends ValueSassToken {
+  private readonly MAP_OPEN;
+  private readonly MAP_CLOSE;
+  private readonly MAP_VALUE_SEPARATOR;
+  private readonly SEPARATOR;
+  private readonly values;
+  constructor(indentationLevel: number, values?: SassMapValues);
+  set(key: SassMapKey, value: SassMapValue): void;
+  extend(values: SassMapValues): void;
+  setMap(key: SassMapKey, values: SassMapValues): SassMap;
+  format(): string;
+  private sassMapValuesToIter;
+}
+declare class UseSassToken extends StringSassToken {
+  constructor(value: string, as_?: string);
+}
+declare class VariableDefinitionSassToken extends SassToken {
+  readonly name: string;
+  readonly value: SassToken;
+  constructor(indentationLevel: number, name: string, value: SassToken);
+  format(): string;
+}
 //#endregion
 //#region src/index.d.ts
 declare function pluginSass(options?: SassPluginOptions): Plugin;
 //#endregion
-export { FILE_HEADER, FORMAT_ID, MIXIN_TOKEN, MIXIN_TYPOGRAPHY, SassPluginOptions, pluginSass as default };
+export { BlankLineSassToken, BuildParams, CssVarReferenceSassToken, FILE_HEADER, FORMAT_ID, MIXIN_TOKEN, MIXIN_TYPOGRAPHY, RootSassToken, SassMap, SassMapKey, SassMapValue, SassMapValues, SassPluginOptions, SassToken, StringSassToken, UseSassToken, ValueSassToken, VariableDefinitionSassToken, pluginSass as default, getIndent };
 //# 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/index.ts"],"sourcesContent":[],"mappings":";;;;cAEa,SAAA;UAEI,iBAAA;;EAFJ,QAAA,CAAA,EAIA,gBAJS,CAAA,UAAA,CAAA;EAEL;EAAiB,OAAA,CAAA,EAItB,gBAJsB,CAAA,SAAA,CAAA;;AAItB,cAGC,WAAA,GAHD,gIAAA;AAAgB,cAWf,WAAA,GAXe,4VAAA;AAGf,cAoBA,gBAAA,GApBW,+bAAA;;;iBCJA,UAAA,WAAqB,oBAAoB"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/lib.ts","../src/build.ts","../src/node.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;cAEa,SAAA;UAEI,iBAAA;;EAFJ,QAAA,CAAA,EAIA,gBAJS,CAAA,UAAA,CAAA;EAEL;EAOJ,OAAA,CAAA,EAHD,gBAGY,CAAA,SAAA,CAAA;AAQxB;AAYa,cApBA,WAAA,GAoBgB,gIAAA;AAgBb,cA5BH,WAAA,GA4BY,4VAAA;cAhBZ,gBAAA;iBAgBG,SAAA;;;UC1CC,WAAA;iBACA;EDJJ,OAAA,CAAA,ECKD,iBDLU;AAEtB;;;KEDY,UAAA;KACA,YAAA,YAAwB;KACxB,aAAA,GAAgB,OAAO,YAAY,gBAAgB,UAAU,YAAY;uBAE/D,SAAA;EFLT,SAAA,gBAAS,EAAA,MAAA;EAEL,WAAA,CAAA,gBAEJ,CAFqB,EAAA,MAErB;EAKA,SAAA,MAAW,CAAA,CAAA,EAAA,MAAA;EAQX,QAAA,CAAA,CAAA,EAAA,MAAW;EAYX,SAAA,CAAA,MAAgB,CAAhB,EEfe,aFeC,CAAA,EEfe,OFef;EAgBb,wBAAS,CAAA,IAAA,EAAA,MAAA,EAAA,KAAA,EE3B8B,SF2B9B,CAAA,EE3B0C,2BF2B1C;;uBEtBH,cAAA,SAAuB,SAAA;;ADpB7C;cC0Ba,eAAA,SAAwB,SAAA;;;EA5BzB,MAAA,CAAA,CAAA,EAAA,MAAU;AACtB;AACY,cAuCC,wBAAA,SAAiC,eAAA,CAvCrB;EAAU,MAAA,CAAA,CAAA,EAAA,MAAA;;AAAP,cA6Cf,kBAAA,SAA2B,eAAA,CA7CZ;EAA6C,WAAA,CAAA;;AAAV,cAmDlD,aAAA,SAAsB,SAAA,CAnD4B;EAAQ,iBAAA,SAAA;EAEjD,QAAA,UAAS;EASH,WAAA,CAAA;EAAgB,MAAA,CAAA,SAAA,EAkDjB,SAlDiB,CAAA,EAAA,IAAA;EAIW,YAAA,CAAA,KAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAAY,wBAAA,CAAA,IAAA,EAAA,MAAA,EAAA,SAAA,EAsDR,SAtDQ,CAAA,EAAA,IAAA;EAA2B,eAAA,CAAA,CAAA,EAAA,IAAA;EAKxE,SAAA,CAAA,KAAA,EAAe,MAAA,EAAA,GAAQ,CAAA,EAAA,MAAA,CAAS,EAAA,IAAA;EAMzC,MAAA,CAAA,CAAA,EAAA,MAAA;AAab;AAMa,cAyCA,OAAA,SAAgB,cAAA,CAzC0B;EAM1C,iBAAc,QAAA;EAUA,iBAAA,SAAA;EAQgC,iBAAA,mBAAA;EAlBxB,iBAAA,SAAA;EAAS,iBAAA,MAAA;EAmC/B,WAAQ,CAAA,gBAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAS4B,aAT5B;EAS4B,GAAA,CAAA,GAAA,EAK/B,UAL+B,EAAA,KAAA,EAKZ,YALY,CAAA,EAAA,IAAA;EAK/B,MAAA,CAAA,MAAA,EAIM,aAJN,CAAA,EAAA,IAAA;EAAmB,MAAA,CAAA,GAAA,EAUhB,UAVgB,EAAA,MAAA,EAUI,aAVJ,CAAA,EAUiB,OAVjB;EAIb,MAAA,CAAA,CAAA,EAAA,MAAA;EAMH,QAAA,mBAAA;;AAAiC,cAuBzC,YAAA,SAAqB,eAAA,CAvBoB;EAxBzB,WAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,CAAA,EAAA,MAAA;;AA+ChB,cAQA,2BAAA,SAAoC,SAAA,CARA;EAQpC,SAAA,IAAA,EAAA,MAAA;EAIc,SAAA,KAAA,EAAA,SAAA;EAAA,WAAA,CAAA,gBAAA,EAAA,MAAA,EAAA,IAAA,EAAA,MAAA,EAAA,KAAA,EAAA,SAAA;EAJsB,MAAA,CAAA,CAAA,EAAA,MAAA;;;;AF9IhC,iBGKO,UAAA,CHLU,OAItB,CAFC,EGGgC,iBHDjC,CAAA,EGCqD,MHDrC"}