Merge pull request #2468 from sass/declaration

Add support for declarations
sass · Jan 8, 2025 · 9e6e3bf · 9e6e3bf
2 parents 3d3e925 + 34e0aaa
commit 9e6e3bf
Show file tree

Hide file tree

Showing 38 changed files with 1,107 additions and 151 deletions.
diff --git a/pkg/sass-parser/lib/index.ts b/pkg/sass-parser/lib/index.ts
@@ -99,6 +99,11 @@ export {
   DebugRuleProps,
   DebugRuleRaws,
 } from './src/statement/debug-rule';
+export {
+  Declaration,
+  DeclarationProps,
+  DeclarationRaws,
+} from './src/statement/declaration';
 export {EachRule, EachRuleProps, EachRuleRaws} from './src/statement/each-rule';
 export {
   ErrorRule,
@@ -142,10 +147,12 @@ export {
 } from './src/statement/sass-comment';
 export {UseRule, UseRuleProps, UseRuleRaws} from './src/statement/use-rule';
 export {
+  AnyDeclaration,
   AnyStatement,
   AtRule,
   ChildNode,
   ChildProps,
+  Comment,
   ContainerProps,
   NewNode,
   Statement,
@@ -196,7 +203,7 @@ class _Syntax implements Syntax {
   }
 
   stringify(node: postcss.AnyNode, builder: postcss.Builder): void {
-    new Stringifier(builder).stringify(node, true);
+    new Stringifier(builder).stringify(node, false);
   }
 }
 

diff --git a/pkg/sass-parser/lib/src/argument-list.ts b/pkg/sass-parser/lib/src/argument-list.ts
@@ -8,7 +8,7 @@ import {Argument, ArgumentProps} from './argument';
 import {Container} from './container';
 import {convertExpression} from './expression/convert';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import * as sassInternal from './sass-internal';
 import * as utils from './utils';
 
@@ -30,7 +30,7 @@ export type NewArguments =
  *
  * @category Expression
  */
-export interface ArgumentListObjectProps {
+export interface ArgumentListObjectProps extends NodeProps {
   nodes?: ReadonlyArray<NewArguments>;
   raws?: ArgumentListRaws;
 }

diff --git a/pkg/sass-parser/lib/src/argument.ts b/pkg/sass-parser/lib/src/argument.ts
@@ -6,7 +6,7 @@ import * as postcss from 'postcss';
 
 import {Expression, ExpressionProps} from './expression';
 import {fromProps} from './expression/from-props';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import {ArgumentList} from './argument-list';
 import * as sassInternal from './sass-internal';
 import {RawWithValue} from './raw-with-value';
@@ -58,7 +58,7 @@ export interface ArgumentRaws {
  *
  * @category Expression
  */
-export type ArgumentObjectProps = {
+export type ArgumentObjectProps = NodeProps & {
   raws?: ArgumentRaws;
   value: Expression | ExpressionProps;
 } & ({name?: string; rest?: never} | {name?: never; rest?: boolean});

diff --git a/pkg/sass-parser/lib/src/configuration.ts b/pkg/sass-parser/lib/src/configuration.ts
@@ -10,7 +10,7 @@ import {
   ConfiguredVariableProps,
 } from './configured-variable';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import type * as sassInternal from './sass-internal';
 import * as utils from './utils';
 import {ForwardRule} from './statement/forward-rule';
@@ -37,7 +37,7 @@ export interface ConfigurationRaws {
  *
  * @category Statement
  */
-export interface ConfigurationProps {
+export interface ConfigurationProps extends NodeProps {
   raws?: ConfigurationRaws;
   variables:
     | Record<string, ConfiguredVariableExpressionProps>

diff --git a/pkg/sass-parser/lib/src/configured-variable.ts b/pkg/sass-parser/lib/src/configured-variable.ts
@@ -9,7 +9,7 @@ import {convertExpression} from './expression/convert';
 import {Expression, ExpressionProps} from './expression';
 import {fromProps} from './expression/from-props';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import * as sassInternal from './sass-internal';
 import {RawWithValue} from './raw-with-value';
 import * as utils from './utils';
@@ -53,7 +53,7 @@ export interface ConfiguredVariableRaws {
  *
  * @category Statement
  */
-export interface ConfiguredVariableObjectProps {
+export interface ConfiguredVariableObjectProps extends NodeProps {
   raws?: ConfiguredVariableRaws;
   name: string;
   expression: Expression | ExpressionProps;

diff --git a/pkg/sass-parser/lib/src/expression/binary-operation.ts b/pkg/sass-parser/lib/src/expression/binary-operation.ts
@@ -5,6 +5,7 @@
 import * as postcss from 'postcss';
 
 import {LazySource} from '../lazy-source';
+import {NodeProps} from '../node';
 import type * as sassInternal from '../sass-internal';
 import * as utils from '../utils';
 import {Expression, ExpressionProps} from '.';
@@ -33,7 +34,7 @@ export type BinaryOperator =
  *
  * @category Expression
  */
-export interface BinaryOperationExpressionProps {
+export interface BinaryOperationExpressionProps extends NodeProps {
   operator: BinaryOperator;
   left: Expression | ExpressionProps;
   right: Expression | ExpressionProps;

diff --git a/pkg/sass-parser/lib/src/expression/boolean.ts b/pkg/sass-parser/lib/src/expression/boolean.ts
@@ -5,6 +5,7 @@
 import * as postcss from 'postcss';
 
 import {LazySource} from '../lazy-source';
+import {NodeProps} from '../node';
 import type * as sassInternal from '../sass-internal';
 import * as utils from '../utils';
 import {Expression} from '.';
@@ -14,7 +15,7 @@ import {Expression} from '.';
  *
  * @category Expression
  */
-export interface BooleanExpressionProps {
+export interface BooleanExpressionProps extends NodeProps {
   value: boolean;
   raws?: BooleanExpressionRaws;
 }

diff --git a/pkg/sass-parser/lib/src/expression/number.ts b/pkg/sass-parser/lib/src/expression/number.ts
@@ -5,6 +5,7 @@
 import * as postcss from 'postcss';
 
 import {LazySource} from '../lazy-source';
+import {NodeProps} from '../node';
 import type * as sassInternal from '../sass-internal';
 import * as utils from '../utils';
 import {Expression} from '.';
@@ -14,7 +15,7 @@ import {Expression} from '.';
  *
  * @category Expression
  */
-export interface NumberExpressionProps {
+export interface NumberExpressionProps extends NodeProps {
   value: number;
   unit?: string;
   raws?: NumberExpressionRaws;

diff --git a/pkg/sass-parser/lib/src/expression/string.ts b/pkg/sass-parser/lib/src/expression/string.ts
@@ -6,6 +6,7 @@ import * as postcss from 'postcss';
 
 import {Interpolation, InterpolationProps} from '../interpolation';
 import {LazySource} from '../lazy-source';
+import {NodeProps} from '../node';
 import type * as sassInternal from '../sass-internal';
 import * as utils from '../utils';
 import {Expression} from '.';
@@ -15,7 +16,7 @@ import {Expression} from '.';
  *
  * @category Expression
  */
-export interface StringExpressionProps {
+export interface StringExpressionProps extends NodeProps {
   text: Interpolation | InterpolationProps;
   quotes?: boolean;
   raws?: StringExpressionRaws;

diff --git a/pkg/sass-parser/lib/src/interpolation.ts b/pkg/sass-parser/lib/src/interpolation.ts
@@ -9,7 +9,7 @@ import {convertExpression} from './expression/convert';
 import {fromProps} from './expression/from-props';
 import {Expression, ExpressionProps} from './expression';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import {RawWithValue} from './raw-with-value';
 import type * as sassInternal from './sass-internal';
 import * as utils from './utils';
@@ -39,7 +39,7 @@ export type NewNodeForInterpolation =
  *
  * @category Expression
  */
-export interface InterpolationObjectProps {
+export interface InterpolationObjectProps extends NodeProps {
   nodes: ReadonlyArray<NewNodeForInterpolation>;
   raws?: InterpolationRaws;
 }

diff --git a/pkg/sass-parser/lib/src/parameter-list.ts b/pkg/sass-parser/lib/src/parameter-list.ts
@@ -7,7 +7,7 @@ import * as postcss from 'postcss';
 import {Container} from './container';
 import {Parameter, ParameterProps} from './parameter';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import * as sassInternal from './sass-internal';
 import * as utils from './utils';
 
@@ -29,7 +29,7 @@ export type NewParameters =
  *
  * @category Statement
  */
-export interface ParameterListObjectProps {
+export interface ParameterListObjectProps extends NodeProps {
   nodes?: ReadonlyArray<NewParameters>;
   raws?: ParameterListRaws;
 }

diff --git a/pkg/sass-parser/lib/src/parameter.ts b/pkg/sass-parser/lib/src/parameter.ts
@@ -8,7 +8,7 @@ import {convertExpression} from './expression/convert';
 import {Expression, ExpressionProps} from './expression';
 import {fromProps} from './expression/from-props';
 import {LazySource} from './lazy-source';
-import {Node} from './node';
+import {Node, NodeProps} from './node';
 import {ParameterList} from './parameter-list';
 import * as sassInternal from './sass-internal';
 import {RawWithValue} from './raw-with-value';
@@ -57,19 +57,19 @@ export interface ParameterRaws {
  *
  * @category Statement
  */
-export type ParameterObjectProps = {
+export type ParameterObjectProps = NodeProps & {
   raws?: ParameterRaws;
   name: string;
 } & (
-  | {
-      defaultValue?: Expression | ExpressionProps;
-      rest?: never;
-    }
-  | {
-      defaultValue?: never;
-      rest?: boolean;
-    }
-);
+    | {
+        defaultValue?: Expression | ExpressionProps;
+        rest?: never;
+      }
+    | {
+        defaultValue?: never;
+        rest?: boolean;
+      }
+  );
 
 /**
  * Properties used to initialize a {@link Parameter} without an explicit name.

diff --git a/pkg/sass-parser/lib/src/sass-internal.ts b/pkg/sass-parser/lib/src/sass-internal.ts
@@ -125,6 +125,11 @@ declare namespace SassInternal {
     readonly expression: Expression;
   }
 
+  class Declaration extends ParentStatement<Statement[] | null> {
+    readonly name: Interpolation;
+    readonly value?: Expression;
+  }
+
   class EachRule extends ParentStatement<Statement[]> {
     readonly variables: string[];
     readonly list: Expression;
@@ -317,6 +322,7 @@ export type AtRootRule = SassInternal.AtRootRule;
 export type AtRule = SassInternal.AtRule;
 export type ContentBlock = SassInternal.ContentBlock;
 export type DebugRule = SassInternal.DebugRule;
+export type Declaration = SassInternal.Declaration;
 export type EachRule = SassInternal.EachRule;
 export type ErrorRule = SassInternal.ErrorRule;
 export type ExtendRule = SassInternal.ExtendRule;
@@ -350,6 +356,7 @@ export interface StatementVisitorObject<T> {
   visitAtRootRule(node: AtRootRule): T;
   visitAtRule(node: AtRule): T;
   visitDebugRule(node: DebugRule): T;
+  visitDeclaration(node: Declaration): T;
   visitEachRule(node: EachRule): T;
   visitErrorRule(node: ErrorRule): T;
   visitExtendRule(node: ExtendRule): T;

diff --git a/pkg/sass-parser/lib/src/statement/__snapshots__/declaration.test.ts.snap b/pkg/sass-parser/lib/src/statement/__snapshots__/declaration.test.ts.snap
@@ -0,0 +1,60 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`a property declaration toJSON with expression and no nodes 1`] = `
+{
+  "expression": <bar>,
+  "inputs": [
+    {
+      "css": "a {foo: bar}",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "propInterpolation": <foo>,
+  "raws": {},
+  "sassType": "decl",
+  "source": <1:4-1:12 in 0>,
+  "type": "decl",
+}
+`;
+
+exports[`a property declaration toJSON with expression and nodes 1`] = `
+{
+  "expression": <bar>,
+  "inputs": [
+    {
+      "css": "a {foo: bar {baz: bang}}",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "nodes": [
+    <baz: bang>,
+  ],
+  "propInterpolation": <foo>,
+  "raws": {},
+  "sassType": "decl",
+  "source": <1:4-1:24 in 0>,
+  "type": "decl",
+}
+`;
+
+exports[`a property declaration toJSON with no expression and nodes 1`] = `
+{
+  "inputs": [
+    {
+      "css": "a {foo: {baz: bang}}",
+      "hasBOM": false,
+      "id": "<input css _____>",
+    },
+  ],
+  "nodes": [
+    <baz: bang>,
+  ],
+  "propInterpolation": <foo>,
+  "raws": {},
+  "sassType": "decl",
+  "source": <1:4-1:20 in 0>,
+  "type": "decl",
+}
+`;
diff --git a/pkg/sass-parser/lib/src/statement/__snapshots__/generic-at-rule.test.ts.snap b/pkg/sass-parser/lib/src/statement/__snapshots__/generic-at-rule.test.ts.snap
@@ -12,7 +12,7 @@ exports[`a generic @-rule toJSON with a child 1`] = `
   "name": "foo",
   "nameInterpolation": <foo>,
   "nodes": [
-    <@bar;>,
+    <@bar>,
   ],
   "params": "",
   "raws": {},

diff --git a/pkg/sass-parser/lib/src/statement/__snapshots__/include-rule.test.ts.snap b/pkg/sass-parser/lib/src/statement/__snapshots__/include-rule.test.ts.snap
@@ -13,7 +13,7 @@ exports[`a @include rule toJSON with a child 1`] = `
   ],
   "name": "include",
   "nodes": [
-    <@qux;>,
+    <@qux>,
   ],
   "params": "foo(bar)",
   "raws": {},
@@ -56,7 +56,7 @@ exports[`a @include rule toJSON with using and a child 1`] = `
   ],
   "name": "include",
   "nodes": [
-    <@qux;>,
+    <@qux>,
   ],
   "params": "foo(bar) using ($baz)",
   "raws": {},

diff --git a/pkg/sass-parser/lib/src/statement/__snapshots__/rule.test.ts.snap b/pkg/sass-parser/lib/src/statement/__snapshots__/rule.test.ts.snap
@@ -10,7 +10,7 @@ exports[`a style rule toJSON with a child 1`] = `
     },
   ],
   "nodes": [
-    <@bar;>,
+    <@bar>,
   ],
   "raws": {},
   "sassType": "rule",

diff --git a/pkg/sass-parser/lib/src/statement/at-rule-internal.d.ts b/pkg/sass-parser/lib/src/statement/at-rule-internal.d.ts
@@ -6,7 +6,7 @@ import * as postcss from 'postcss';
 
 import {Rule} from './rule';
 import {Root} from './root';
-import {AtRule, ChildNode, Comment, Declaration, NewNode} from '.';
+import {AnyDeclaration, AtRule, ChildNode, Comment, NewNode} from '.';
 
 /**
  * A fake intermediate class to convince TypeScript to use Sass types for
@@ -60,10 +60,10 @@ export class _AtRule<Props> extends postcss.AtRule {
   ): false | undefined;
   walkDecls(
     propFilter: RegExp | string,
-    callback: (decl: Declaration, index: number) => false | void,
+    callback: (decl: AnyDeclaration, index: number) => false | void,
   ): false | undefined;
   walkDecls(
-    callback: (decl: Declaration, index: number) => false | void,
+    callback: (decl: AnyDeclaration, index: number) => false | void,
   ): false | undefined;
   walkRules(
     selectorFilter: RegExp | string,