css scope migration (#2339)

AndreasArvidsson · pokey · web-flow · commit 820732a3dbc4 · 2024-05-31T10:46:09.000Z
## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [/] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet --------- Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
diff --git a/data/fixtures/recorded/languages/scss/changeName2.yml b/data/fixtures/recorded/languages/scss/changeName2.yml
@@ -16,8 +16,8 @@ initialState:
       @return $result;
     }
   selections:
-    - anchor: {line: 1, character: 13}
-      active: {line: 1, character: 13}
+    - anchor: {line: 1, character: 0}
+      active: {line: 1, character: 0}
   marks: {}
 finalState:
   documentContents: |-
diff --git a/data/fixtures/scopes/css/name.iteration.block.scope b/data/fixtures/scopes/css/name.iteration.block.scope
@@ -0,0 +1,13 @@
+a { color: red; }
+---
+
+[#1 Range] =
+[#1 Domain] = 0:0-0:17
+  >-----------------<
+0| a { color: red; }
+
+
+[#2 Range] =
+[#2 Domain] = 0:3-0:16
+     >-------------<
+0| a { color: red; }
diff --git a/data/fixtures/scopes/css/name.iteration.document.scope b/data/fixtures/scopes/css/name.iteration.document.scope
@@ -0,0 +1,7 @@
+/* hello */
+---
+
+[Range] =
+[Domain] = 0:0-0:11
+  >-----------<
+0| /* hello */
diff --git a/data/fixtures/scopes/scss/functionName.iteration.document.scope b/data/fixtures/scopes/scss/functionName.iteration.document.scope
@@ -0,0 +1,7 @@
+/* hello */
+---
+
+[Range] =
+[Domain] = 0:0-0:11
+  >-----------<
+0| /* hello */
diff --git a/data/fixtures/scopes/scss/functionName.iteration.scope b/data/fixtures/scopes/scss/functionName.iteration.scope
@@ -0,0 +1,13 @@
+a { color: red; }
+---
+
+[#1 Range] =
+[#1 Domain] = 0:0-0:17
+  >-----------------<
+0| a { color: red; }
+
+
+[#2 Range] =
+[#2 Domain] = 0:3-0:16
+     >-------------<
+0| a { color: red; }
diff --git a/data/fixtures/scopes/scss/namedFunction.iteration.document.scope b/data/fixtures/scopes/scss/namedFunction.iteration.document.scope
@@ -0,0 +1,7 @@
+/* hello */
+---
+
+[Range] =
+[Domain] = 0:0-0:11
+  >-----------<
+0| /* hello */
diff --git a/data/fixtures/scopes/scss/namedFunction.iteration.scope b/data/fixtures/scopes/scss/namedFunction.iteration.scope
@@ -0,0 +1,13 @@
+a { color: red; }
+---
+
+[#1 Range] =
+[#1 Domain] = 0:0-0:17
+  >-----------------<
+0| a { color: red; }
+
+
+[#2 Range] =
+[#2 Domain] = 0:3-0:16
+     >-------------<
+0| a { color: red; }
diff --git a/packages/common/src/scopeSupportFacets/css.ts b/packages/common/src/scopeSupportFacets/css.ts
@@ -11,6 +11,8 @@ const { supported, unsupported, notApplicable } = ScopeSupportFacetLevel;
 export const cssScopeSupport: LanguageScopeSupportFacetMap = {
   "comment.block": supported,
   "string.singleLine": supported,
+  "name.iteration.block": supported,
+  "name.iteration.document": supported,
 
   "comment.line": unsupported,
 };
diff --git a/packages/common/src/scopeSupportFacets/scopeSupportFacetInfos.ts b/packages/common/src/scopeSupportFacets/scopeSupportFacetInfos.ts
@@ -124,6 +124,21 @@ export const scopeSupportFacetInfos: Record<
     description: "A named method declaration in a class",
     scopeType: "namedFunction",
   },
+  "namedFunction.method.iteration.class": {
+    description: "Iteration scope for named functions: class bodies",
+    scopeType: "namedFunction",
+    isIteration: true,
+  },
+  "namedFunction.iteration": {
+    description: "Iteration scope for named functions",
+    scopeType: "namedFunction",
+    isIteration: true,
+  },
+  "namedFunction.iteration.document": {
+    description: "Iteration scope for named functions: the entire document",
+    scopeType: "namedFunction",
+    isIteration: true,
+  },
   anonymousFunction: {
     description:
       "An anonymous function, eg a lambda function, an arrow function, etc",
@@ -133,6 +148,25 @@ export const scopeSupportFacetInfos: Record<
     description: "The name of a function",
     scopeType: "functionName",
   },
+  "functionName.method": {
+    description: "The name of a method in a class",
+    scopeType: "functionName",
+  },
+  "functionName.method.iteration.class": {
+    description: "Iteration scope for function names: class bodies",
+    scopeType: "functionName",
+    isIteration: true,
+  },
+  "functionName.iteration": {
+    description: "Iteration scope for function names",
+    scopeType: "functionName",
+    isIteration: true,
+  },
+  "functionName.iteration.document": {
+    description: "Iteration scope for function names: the entire document",
+    scopeType: "functionName",
+    isIteration: true,
+  },
 
   functionCall: {
     description: "A function call",
@@ -299,6 +333,17 @@ export const scopeSupportFacetInfos: Record<
     scopeType: "name",
     isIteration: true,
   },
+  "name.iteration.block": {
+    description:
+      "Iteration scope for names: statement blocks (body of functions/if classes/for loops/etc).",
+    scopeType: "name",
+    isIteration: true,
+  },
+  "name.iteration.document": {
+    description: "Iteration scope for names: the entire document",
+    scopeType: "name",
+    isIteration: true,
+  },
   "key.attribute": {
     description: "Key (LHS) of an attribute eg in an xml element",
     scopeType: "collectionKey",
diff --git a/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts b/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts
@@ -31,8 +31,15 @@ const scopeSupportFacets = [
   "className.iteration.block",
   "namedFunction",
   "namedFunction.method",
+  "namedFunction.method.iteration.class",
+  "namedFunction.iteration",
+  "namedFunction.iteration.document",
   "anonymousFunction",
   "functionName",
+  "functionName.method",
+  "functionName.method.iteration.class",
+  "functionName.iteration",
+  "functionName.iteration.document",
 
   "functionCall",
   "functionCall.constructor",
@@ -76,6 +83,8 @@ const scopeSupportFacets = [
   "name.resource.iteration",
   "name.argument.formal",
   "name.argument.formal.iteration",
+  "name.iteration.block",
+  "name.iteration.document",
 
   "key.attribute",
   "key.mapPair",
diff --git a/packages/common/src/scopeSupportFacets/scss.ts b/packages/common/src/scopeSupportFacets/scss.ts
@@ -11,5 +11,10 @@ const { supported, unsupported, notApplicable } = ScopeSupportFacetLevel;
 
 export const scssScopeSupport: LanguageScopeSupportFacetMap = {
   ...cssScopeSupport,
+
+  "namedFunction.iteration": supported,
+  "namedFunction.iteration.document": supported,
+  "functionName.iteration": supported,
+  "functionName.iteration.document": supported,
   "comment.line": supported,
 };
diff --git a/packages/cursorless-engine/src/languages/scss.ts b/packages/cursorless-engine/src/languages/scss.ts
@@ -108,7 +108,6 @@ function unitMatcher(
 const nodeMatchers: Partial<
   Record<SimpleScopeTypeType, NodeMatcherAlternative>
 > = {
-  ifStatement: "if_statement",
   condition: conditionMatcher("condition"),
   statement: cascadingMatcher(
     patternMatcher(...STATEMENT_TYPES),
@@ -117,10 +116,6 @@ const nodeMatchers: Partial<
       childRangeSelector([], ["attribute_name", "string_value"]),
     ),
   ),
-  functionCall: "call_expression",
-  functionCallee: "call_expression.function_name!",
-  namedFunction: ["mixin_statement", "function_statement"],
-  functionName: ["mixin_statement.name!", "function_statement.name!"],
   argumentOrParameter: cascadingMatcher(
     matcher(
       patternFinder("arguments.*!", "parameters.*!"),
@@ -132,15 +127,6 @@ const nodeMatchers: Partial<
       ),
     ),
   ),
-  name: [
-    "function_statement.name!",
-    "declaration.property_name!",
-    "declaration.variable_name!",
-    "mixin_statement.name!",
-    "attribute_selector.attribute_name!",
-    "parameter.variable_name!",
-  ],
-  selector: ["rule_set.selectors!"],
   collectionKey: trailingMatcher(["declaration.property_name!"], [":"]),
   value: cascadingMatcher(
     matcher(
@@ -160,7 +146,6 @@ const nodeMatchers: Partial<
     ),
   ),
   unit: cascadingMatcher(patternMatcher("integer_value.unit!"), unitMatcher),
-  collectionItem: "declaration",
 };
 
 export const patternMatchers = createPatternMatchers(nodeMatchers);
diff --git a/queries/css.scm b/queries/css.scm
@@ -1,3 +1,28 @@
 (string_value) @string @textFragment
 
 (comment) @comment @textFragment
+
+(declaration) @collectionItem
+
+(call_expression
+  (function_name) @functionCallee
+) @functionCall @functionCallee.domain
+
+(rule_set
+  (selectors) @selector
+) @_.domain
+
+(declaration
+  (property_name) @name
+) @_.domain
+(attribute_selector
+  (attribute_name) @name
+) @_.domain
+
+(stylesheet) @name.iteration
+(block
+  .
+  "{" @name.iteration.start.endOf
+  "}" @name.iteration.end.startOf
+  .
+)
diff --git a/queries/scss.scm b/queries/scss.scm
@@ -1,3 +1,28 @@
 ;; import css.scm
 
 (single_line_comment) @comment @textFragment
+
+(if_statement) @ifStatement
+
+(mixin_statement
+  (name) @functionName @name
+) @namedFunction @functionName.domain @name.domain
+
+(function_statement
+  (name) @functionName @name
+) @namedFunction @functionName.domain @name.domain
+
+(declaration
+  (variable_name) @name
+) @_.domain
+(parameter
+  (variable_name) @name
+) @_.domain
+
+(stylesheet) @namedFunction.iteration @functionName.iteration
+(block
+  .
+  "{" @namedFunction.iteration.start.endOf @functionName.iteration.start.endOf
+  "}" @namedFunction.iteration.end.startOf @functionName.iteration.end.startOf
+  .
+)
