Add support for the @include rule

Co-authored-by: Carlos Israel Ortiz García <goodwine@google.com>
sass · Dec 12, 2024 · bc39d0c · bc39d0c
1 parent bf50fad
commit bc39d0c
Show file tree

Hide file tree

Showing 24 changed files with 3,062 additions and 33 deletions.
diff --git a/lib/src/js/parser.dart b/lib/src/js/parser.dart
@@ -20,6 +20,7 @@ import '../visitor/interface/expression.dart';
 import '../visitor/interface/statement.dart';
 import 'reflection.dart';
 import 'set.dart';
+import 'utils.dart';
 import 'visitor/expression.dart';
 import 'visitor/statement.dart';
 
@@ -32,14 +33,16 @@ class ParserExports {
       required Function toCssIdentifier,
       required Function createExpressionVisitor,
       required Function createStatementVisitor,
-      required Function setToJS});
+      required Function setToJS,
+      required Function mapToRecord});
 
   external set parse(Function function);
   external set parseIdentifier(Function function);
   external set toCssIdentifier(Function function);
   external set createStatementVisitor(Function function);
   external set createExpressionVisitor(Function function);
   external set setToJS(Function function);
+  external set mapToRecord(Function function);
 }
 
 /// An empty interpolation, used to initialize empty AST entries to modify their
@@ -61,7 +64,8 @@ ParserExports loadParserExports() {
           (JSExpressionVisitorObject inner) => JSExpressionVisitor(inner)),
       createStatementVisitor: allowInterop(
           (JSStatementVisitorObject inner) => JSStatementVisitor(inner)),
-      setToJS: allowInterop((Set<Object?> set) => JSSet([...set])));
+      setToJS: allowInterop((Set<Object?> set) => JSSet([...set])),
+      mapToRecord: allowInterop(mapToObject));
 }
 
 /// Modifies the prototypes of the Sass AST classes to provide access to JS.
@@ -88,6 +92,10 @@ void _updateAstPrototypes() {
       'accept',
       (Expression self, ExpressionVisitor<Object?> visitor) =>
           self.accept(visitor));
+  var arguments = ArgumentList([], {}, bogusSpan);
+  var include = IncludeRule('a', arguments, bogusSpan);
+  getJSClass(include)
+      .defineGetter('arguments', (IncludeRule self) => self.arguments);
 
   _addSupportsConditionToInterpolation();
 

diff --git a/lib/src/js/utils.dart b/lib/src/js/utils.dart
@@ -11,6 +11,7 @@ import 'package:js/js_util.dart';
 
 import '../syntax.dart';
 import '../utils.dart';
+import '../util/map.dart';
 import '../value.dart';
 import 'array.dart';
 import 'function.dart';
@@ -223,6 +224,18 @@ Map<String, Object?> objectToMap(Object object) {
   return map;
 }
 
+@JS("Object")
+external JSClass get _jsObjectClass;
+
+/// Converts a JavaScript record into a map from property names to their values.
+Object mapToObject(Map<String, Object?> map) {
+  var result = callConstructor<Object>(_jsObjectClass, const []);
+  for (var (key, value) in map.pairs) {
+    setProperty(result, key, value);
+  }
+  return result;
+}
+
 /// Converts a JavaScript separator string into a [ListSeparator].
 ListSeparator jsToDartSeparator(String? separator) => switch (separator) {
       ' ' => ListSeparator.space,

diff --git a/pkg/sass-parser/CHANGELOG.md b/pkg/sass-parser/CHANGELOG.md
@@ -1,5 +1,7 @@
 ## 0.4.8
 
+Add support for parsing the `@include` rule.
+
 Add support for parsing the `@mixin` rule.
 
 Add support for parsing the `@return` rule.

diff --git a/pkg/sass-parser/lib/index.ts b/pkg/sass-parser/lib/index.ts
@@ -8,6 +8,20 @@ import {Root} from './src/statement/root';
 import * as sassInternal from './src/sass-internal';
 import {Stringifier} from './src/stringifier';
 
+export {
+  Argument,
+  ArgumentExpressionProps,
+  ArgumentObjectProps,
+  ArgumentProps,
+  ArgumentRaws,
+} from './src/argument';
+export {
+  ArgumentList,
+  ArgumentListObjectProps,
+  ArgumentListProps,
+  ArgumentListRaws,
+  NewArguments,
+} from './src/argument-list';
 export {
   Configuration,
   ConfigurationProps,
@@ -50,6 +64,11 @@ export {
   NumberExpressionProps,
   NumberExpressionRaws,
 } from './src/expression/number';
+export {
+  IncludeRule,
+  IncludeRuleProps,
+  IncludeRuleRaws,
+} from './src/statement/include-rule';
 export {
   Interpolation,
   InterpolationProps,

diff --git a/pkg/sass-parser/lib/src/__snapshots__/argument-list.test.ts.snap b/pkg/sass-parser/lib/src/__snapshots__/argument-list.test.ts.snap
@@ -0,0 +1,20 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`an argument list toJSON 1`] = `
+{
+  "inputs": [
+    {
+      "css": "@include x(foo, bar...)",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "nodes": [
+    <foo>,
+    <bar...>,
+  ],
+  "raws": {},
+  "sassType": "argument-list",
+  "source": <1:11-1:24 in 0>,
+}
+`;
diff --git a/pkg/sass-parser/lib/src/__snapshots__/argument.test.ts.snap b/pkg/sass-parser/lib/src/__snapshots__/argument.test.ts.snap
@@ -0,0 +1,50 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`a argument toJSON with a name 1`] = `
+{
+  "inputs": [
+    {
+      "css": "@include x($baz: qux)",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "name": "baz",
+  "raws": {},
+  "rest": false,
+  "sassType": "argument",
+  "value": <qux>,
+}
+`;
+
+exports[`a argument toJSON with no name 1`] = `
+{
+  "inputs": [
+    {
+      "css": "@include x(qux)",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "raws": {},
+  "rest": false,
+  "sassType": "argument",
+  "value": <qux>,
+}
+`;
+
+exports[`a argument toJSON with rest 1`] = `
+{
+  "inputs": [
+    {
+      "css": "@include x(qux...)",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "raws": {},
+  "rest": true,
+  "sassType": "argument",
+  "value": <qux>,
+}
+`;