Sweetener とは何か#

Sweetener は​マクロを​定義・​使用する​ための​独自構文 .stsから​ .tsを​生成する​ための​ライブラリ・ビルドツールです．

とりあえずインストールしましょう．

1
npm install --save-dev @sweetener/cli
2
npx sweetener init

試しに，​Ruby の​ unlessを​定義してみます．ifと​逆の​動作を​します．

1
export syntax unless:stmt {
2
    rule { unless ($condition:expr) { $($body:stmt)* } } => {
3
        if (!($condition)) { $($body)* }
4
    }
5
}

このように​して​定義した​マクロは​以下のように​使うことができます．

1
import { unless } from "./macros.sts" for syntax;
2

3
export function withdraw(balance: number, amount: number): string {
4
  unless (amount <= balance) {
5
    return "insufficient funds";
6
  }
7
  return `withdrew ${String(amount)}`;
8
}

これは​単純な​ TypeScript コードに​展開され，​以下のような​コードに​なります．

展開には​以下の​コマンドを​使います．

1
npx sweetener expand src/main.sts

1
export function withdraw(balance: number, amount: number): string {
2
  if (!(amount <= balance)) {
3
    return "insufficient funds";
4
  }
5
  return `withdrew ${String(amount)}`;
6
}

型検査は​この​展開後の​コードに​対して​ tscが​行う​ため，​Sweetener が​特有の​型チェックを​行う​ことは​ありません．

また，​マクロの​ importには​ for syntaxを​つける​必要が​あり，​これは​展開後の​ TypeScript コードには​出力されません．

マクロを読む#

unlessマクロを​読み解いてみます．

1
export syntax unless:stmt {
2
    rule { unless ($condition:expr) { $($body:stmt)* } } => {
3
        if (!($condition)) { $($body)* }
4
    }
5
}

• syntax unless:stmtで，unlessと​いう​名前の​マクロを​「文(stmt) が​書ける​位置」に​定義しています．
• rule { ... }の​中が​実際に​展開される​パターンです．()内で​1個の​式を​ $conditionと​して，{}内で​0個以上の​文を​ $bodyと​して​キャプチャしています．
  • $(...)*は​繰り返し
• =>以降は，​実際に​ TypeScript と​して​展開される​コードを​書きます．​キャプチャした​条件式を​反転し，​その後の​ブロックに​文を​渡す​ことで​ unlessの​動作を​実装しています．

パイプラインマクロを実装してみる#

次に​ Elixir スタイル¹の​パイプライン演算子を​実装する​マクロを​書いてみます．

1
export operator (|>):expr {
2
    fixity infix;
3
    associativity left;
4
    precedence 35;
5

6
    rule { $value:expr |> $function:ident $(. $member:ident)* ($($argument:expr),*) } => {
7
        $function $(. $member)*($value #if(present $argument) {, $($argument), *})
8
    }
9

10
    rule { $value:expr |> $function:ident $(. $member:ident)* } => {
11
        $function $(. $member)*($value)
12
    }
13
}

1
import { (|>) } from "./operators.sts" for syntax;
2

3
const result = [1, 2, 3] |> map((n) => n * 2) |> sum;

この​コードは​ TypeScript に​展開された​とき，​このようになります．

1
const result = sum(map([1, 2, 3], (n) => n * 2));

なる​ほど，​確かに​パイプライン演算子と​して​機能するように​マクロが​展開されていますね．

TC39 で​提案されている​ Hack スタイル(x |> f(%)のように​ %で​代入される​値の​位置を​指定する​) の​パイプライン演算子も​書く​ことができます．

他の活用例#

すでに​公式の​例と​しては

• Effect-TS の​ボイラープレートを​マクロと​して​展開する
  • effect f(x: string) { ... }を​ const f = (x: string) => Effect.gen(function* () { ... })に​する
  • const x = yield* f()を​ x <- f()に​する
  • error NotFound { id: string }を​ Data.TaggedErrorに​する
  • service Databaseを​ Context.Tagに​する
  • handle f() { errors }を​ Effect.catchTagに​する
• Drizzle の​テーブル定義 DSL

などが​あり，​Effect-TS, Drizzle ユーザー²と​しては​かなり​魅力的に​見えました．

Effect-TS は​特に​ボイラープレートが​多く，​読むのが​結構つらいので，​これらの​マクロで​コードレビュー時の​読みづらさが​軽減されるのではないかと​期待していたり．

現状の制約#

なんと​いっても​まだ​ alpha 版と​いう​点です．​以下の​点に​おいては​まだ​改善の​余地が​ありそうです．

おわりに#

ガッツリ実戦投入できる​パターンは​そこまで​多くないとは​思いますが，​ボイラープレートを​排除する​ための​手段と​して​知っておくと​良さそうだなーと​いう​感じです．

マクロ・メタプログラミングに​代表される​構文の​ hack は​どこまで​やっていいのかチームや​状況に​よって​大きく​変わると​思います．個人開発なら​これですべてを​破壊するのも​悪くないですね

邪悪な​マクロを​組まない​限り，​構文と​しては​シンプルに​なるでしょうから，​少なくとも​人間の​認知負荷に​対しては​良い​効果を​もたらしてくれると​期待しています．

AI エージェントに​対しては​トークン効率などの​面で​ベンチマークを​取る​必要が​ありそうですが．​実際どこまで​ついてきてくれるかは​気に​なる​ところです．

TypeScript で​今まで​出来なかった​ことや，​記述量が​多くなってしまっていた​部分を​解決するので，​他の​言語から​ TypeScript, Effect-TS などに​移ってきたい​場合に​使える…のか？​わからん．​誰か​実証してください．

この​記事で​上げた​もの​以外にも​便利な​マクロの​使い道を​思いついたら​ Zenn の​ Scrap, 便利な​ Sweetener マクロ n 選に​随時追記していくので，​気に​なったら​見てみてください．