Merge pull request #933 from sketch-hq/chore/update-15629876426

Update with release/2025.2 (beta)

Author: jpedroso

.github/workflows/check.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@master
         with:
-          node-version: '10.16.3'
+          node-version: 'lts/*'
       - name: Install Dependencies
         run: npm ci
       - name: Build

.nvmrc

@@ -1 +1 @@
-16.1.0
+lts/*

.vscode/tasks.json

@@ -0,0 +1,70 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build & lint",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "dependsOrder": "sequence",
+      "dependsOn": ["Lint", "Build"]
+    },
+    {
+      "label": "Build",
+      "type": "npm",
+      "script": "build",
+      "group": {
+        "kind": "build"
+      }
+    },
+    {
+      "label": "Lint",
+      "type": "npm",
+      "script": "lint",
+      "group": {
+        "kind": "build"
+      }
+    },
+    {
+      "label": "Build and run tests",
+      "dependsOrder": "sequence",
+      "dependsOn": ["Build", "Please choose target Xcode variant", "Run tests"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "Please choose target Xcode variant",
+      "type": "shell",
+      "command": "echo -e '\\033[0;34m=====================================================================\nSelect the Sketch variant to test against in the VSCode popup above ☝️\n(or just press Enter)\n=====================================================================\\033[0m'",
+      "group": {
+        "kind": "test"
+      }
+    },
+    {
+      "label": "Run tests",
+      "type": "npm",
+      "script": "test",
+      "options": {
+        "env": {
+          "TARGET_SKETCH_VARIANT_BUNDLE_ID": "${input:sketchTarget}"
+        }
+      }
+    }
+  ],
+  "inputs": [
+    {
+      "id": "sketchTarget",
+      "description": "Choose the target Sketch variant",
+      "type": "pickString",
+      "options": [
+        "com.bohemiancoding.sketch3.xcode",
+        "com.bohemiancoding.sketch3.beta",
+        "com.bohemiancoding.sketch3"
+      ],
+      "default": "com.bohemiancoding.sketch3.xcode"
+    }
+  ]
+}

Source/dom/__tests__/find.test.js

@@ -111,6 +111,39 @@ test('should find by name beginning with', (_context, document) => {
   ])
 })
 
+test('should find by full name match ignoring case', (_context, document) => {
+  // eslint-disable-next-line no-param-reassign
+  document.pages = [
+    {
+      layers: [
+        { type: 'Artboard' },
+        { type: 'Shape', name: 'test' },
+        { type: 'Shape', name: 'test2' },
+      ],
+    },
+  ]
+  expect(find('[name~="tEsT"]', document).map((x) => x.id)).toEqual([
+    document.pages[0].layers[1].id,
+  ])
+})
+
+test('should find by partial name ignoring case', (_context, document) => {
+  // eslint-disable-next-line no-param-reassign
+  document.pages = [
+    {
+      layers: [
+        { type: 'Artboard' },
+        { type: 'Shape', name: 'test' },
+        { type: 'Shape', name: 'test2' },
+      ],
+    },
+  ]
+  expect(find('[name~*="tEsT"]', document).map((x) => x.id)).toEqual([
+    document.pages[0].layers[1].id,
+    document.pages[0].layers[2].id,
+  ])
+})
+
 test('should find by frame.x greater than', (_context, document) => {
   // eslint-disable-next-line no-param-reassign
   document.pages = [
@@ -158,3 +191,62 @@ test('should find with id', (_context, document) => {
     find(`#${document.pages[0].layers[1].id}`, document).map((x) => x.id)
   ).toEqual([document.pages[0].layers[1].id])
 })
+
+test('should find within root progeny', (_context, document) => {
+  // eslint-disable-next-line no-param-reassign
+  document.pages = [
+    {
+      layers: [
+        {
+          type: 'Artboard',
+          frame: new Rectangle(400, 0, 100, 100),
+          layers: [
+            {
+              type: 'Shape',
+              name: 'test',
+              frame: new Rectangle(400, 0, 50, 50),
+            },
+          ],
+        },
+        { type: 'Shape', name: 'test' },
+      ],
+    },
+  ]
+
+  const root = document.pages[0].layers[0]
+  expect(find("[name='test']", root).map((x) => x.id)).toEqual([
+    root.layers[0].id,
+  ])
+
+  expect(
+    find("[name='test']", root, { inclusive: false }).map((x) => x.id)
+  ).toEqual([root.layers[0].id])
+})
+
+test('should find within root progeny + root itself', (_context, document) => {
+  // eslint-disable-next-line no-param-reassign
+  document.pages = [
+    {
+      layers: [
+        {
+          type: 'Artboard',
+          name: 'test',
+          frame: new Rectangle(400, 0, 100, 100),
+          layers: [
+            {
+              type: 'Shape',
+              name: 'test',
+              frame: new Rectangle(400, 0, 50, 50),
+            },
+          ],
+        },
+        { type: 'Shape', name: 'test' },
+      ],
+    },
+  ]
+
+  const root = document.pages[0].layers[0]
+  expect(
+    find("[name='test']", root, { inclusive: true }).map((x) => x.id)
+  ).toEqual([root.id, root.layers[0].id])
+})

Source/dom/find.js

@@ -70,7 +70,9 @@ const attributesMap = {
 
 const operatorMap = {
   '=': '=',
+  '~=': 'LIKE[c]',
   '*=': 'CONTAINS',
+  '~*=': 'CONTAINS[c]',
   '$=': 'ENDSWITH',
   '!=': '!=',
   '^=': 'BEGINSWITH',
@@ -89,7 +91,7 @@ const whitespace = '[\\x20\\t\\r\\n\\f]'
 // with a small twist: we accept `.` for nested property path
 const identifier = '(?:\\\\.|[\\w-]|[^\0-\\xa0]|\\.)+'
 
-const operator = `(?:[*^$!]?=|>=|>|<|<=)`
+const operator = `(?:[~]*[*^$!]?=|>=|>|<|<=)`
 
 const attributes = `\\[${whitespace}*(${identifier})(?:${whitespace}*(${operator})${whitespace}*(?:'((?:\\\\.|[^\\\\'])*)'|"((?:\\\\.|[^\\\\"])*)"|(${identifier}))|)${whitespace}*\\]`
 const booleans = 'locked|hidden|selected'
@@ -111,7 +113,7 @@ function parseValue(value) {
   return Number(value)
 }
 
-export function find(predicate, root) {
+export function find(predicate, root, options = {}) {
   if (!root) {
     // eslint-disable-next-line no-param-reassign
     root = Document.getSelectedDocument()
@@ -211,13 +213,15 @@ export function find(predicate, root) {
     predicateVars
   )
 
+  const { inclusive = false } = options || {}
+
   const children =
     root.type == Types.Document
       ? root.sketchObject.pages().reduce((prev, page) => {
           prev.addObjectsFromArray(page.childrenIncludingSelf(true))
           return prev
         }, NSMutableArray.new())
-      : root.sketchObject.childrenIncludingSelf(false)
+      : root.sketchObject.childrenIncludingSelf(inclusive)
 
   // Different filter strategies are used for backwards compatibility with plugins and
   // scripts that work on the concept of artboards.

Source/dom/models/Selection.js

@@ -61,6 +61,10 @@ export class Selection {
     return this.layers.reduce(fn, initial)
   }
 
+  filter(fn) {
+    return this.layers.filter(fn)
+  }
+
   /**
    * Clear the selection.
    */

Source/dom/models/__tests__/Selection.test.js

@@ -91,4 +91,5 @@ test('should define convenience array methods', (_context, document) => {
   expect(selection.forEach).toBeDefined()
   expect(selection.map).toBeDefined()
   expect(selection.reduce).toBeDefined()
+  expect(selection.filter).toBeDefined()
 })