Add Swift programming language #2734

atacan · 2025-01-18T15:41:38Z

Checklist

I have added tests
I have updated the docs and cheatsheet
I have not broken the cheatsheet

- Introduced `swiftScopeSupport` to manage language-specific scope features. - Updated `languageScopeSupport` to include Swift support. - Created a new file for Swift scope support definitions.

- Expanded `swiftScopeSupport` to include new language-specific features such as `collectionKey`, `className.iteration`, and `type.protocol`. - Updated handling of ternary operators and introduced Swift-specific conditions like `condition.guard`. - Added a new query file `swift.scm` to define grammar rules for Swift, covering statements, declarations, and control flow constructs.

- Updated `swiftScopeSupport` to use `key.mapPair` and `key.mapPair.iteration` instead of `collectionKey` and its iteration counterpart. - Modified the corresponding grammar rules in `swift.scm` to reflect these changes, ensuring proper handling of dictionary key-value pairs.

…rd scope types

@key

…tter query file. Here are the key changes made: 1. In swift.ts: Removed all iteration-specific scopes Simplified to use base scope types only Removed unsupported Swift-specific scopes Kept only standard scope types that are documented and used across languages In swift.scm: Removed @textFragment annotations Simplified function declarations to use standard @namedFunction Updated dictionary key-value pairs to use standard @key and @value Removed iteration-specific scopes Updated argument handling to use @argument.actual and @argument.formal Removed operator-specific annotations Simplified branch and condition handling Removed all iteration scopes for blocks, classes, and file-level

atacan · 2025-01-18T15:45:03Z

Currently I see the following error when I look at the console. I couldn't figure it out yet why Swift cannot be found in the language definitions.

{
  "type": "primitive",
  "mark": {
    "type": "cursor"
  },
  "modifiers": [
    {
      "type": "containingScope",
      "scopeType": {
        "type": "statement"
      }
    }
  ]
}
extensionHostProcess.js:163
Error: Expected language definition entry is missing for languageId swift
    at _LanguageDefinitionsImpl.get (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/languages/LanguageDefinitions.ts:157:13)
    at ScopeHandlerFactoryImpl.maybeCreate (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts:127:12)
    at ContainingScopeStage.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/modifiers/ContainingScopeStage.ts:37:51)
    at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:264:49
    at Array.flatMap (<anonymous>)
    at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:264:23
    at Array.forEach (<anonymous>)
    at processModifierStages (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:263:18)
    at TargetPipeline.processPrimitiveTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:241:12)
    at TargetPipeline.processTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:99:21)
    at TargetPipeline.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:86:29)
    at TargetPipelineRunner.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:59:7)
    at CommandRunnerImpl.getTargets (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:236:32)
    at CommandRunnerImpl.runAction (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:224:32)
    at CommandRunnerImpl.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:80:20)
    at runCommand (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/runCommand.ts:74:20)
    at runCommandWrapper (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/src/registerCommands.ts:43:14)
    at cw.h (file:///Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:115:32825)
extensionHostProcess.js:163

data/fixtures/scopes/swift/index.json

AndreasArvidsson · 2025-01-18T15:58:05Z

Currently I see the following error when I look at the console. I couldn't figure it out yet why Swift cannot be found in the language definitions.

{
  "type": "primitive",
  "mark": {
    "type": "cursor"
  },
  "modifiers": [
    {
      "type": "containingScope",
      "scopeType": {
        "type": "statement"
      }
    }
  ]
}
extensionHostProcess.js:163
Error: Expected language definition entry is missing for languageId swift
    at _LanguageDefinitionsImpl.get (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/languages/LanguageDefinitions.ts:157:13)
    at ScopeHandlerFactoryImpl.maybeCreate (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/modifiers/scopeHandlers/ScopeHandlerFactoryImpl.ts:127:12)
    at ContainingScopeStage.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/modifiers/ContainingScopeStage.ts:37:51)
    at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:264:49
    at Array.flatMap (<anonymous>)
    at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:264:23
    at Array.forEach (<anonymous>)
    at processModifierStages (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:263:18)
    at TargetPipeline.processPrimitiveTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:241:12)
    at TargetPipeline.processTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:99:21)
    at TargetPipeline.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:86:29)
    at TargetPipelineRunner.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/processTargets/TargetPipelineRunner.ts:59:7)
    at CommandRunnerImpl.getTargets (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:236:32)
    at CommandRunnerImpl.runAction (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:224:32)
    at CommandRunnerImpl.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/core/commandRunner/CommandRunnerImpl.ts:80:20)
    at runCommand (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-engine/src/runCommand.ts:74:20)
    at runCommandWrapper (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/src/registerCommands.ts:43:14)
    at cw.h (file:///Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:115:32825)
extensionHostProcess.js:163

It looks like load language has never run.

cursorless/packages/cursorless-engine/src/languages/LanguageDefinitions.ts

Line 130 in 6c1e0ce

public async loadLanguage(languageId: string): Promise<void> {

Or this code ran, but it was an error. Whenever the cursorless extension starts up have a look at the log.

atacan · 2025-01-18T16:11:49Z

below is what I see in the first start

Activating tree-sitter...
extensionHostProcess.js:163
Creating communication dir /var/folders/_z/hg3p0pxs2fn7z1985xlhlt5c0000gn/T/vscode-command-server-501
extensionHostProcess.js:163
taking snapshot

when I say "take state" I see the following error. the error code is the same but I think the files mentioned are different

{
  "version": 7,
  "spokenForm": "take state",
  "usePrePhraseSnapshot": true,
  "action": {
    "name": "setSelection",
    "target": {
      "type": "primitive",
      "modifiers": [
        {
          "type": "containingScope",
          "scopeType": {
            "type": "statement"
          }
        }
      ]
    }
  }
}
extensionHostProcess.js:163
taking snapshot
extensionHostProcess.js:163
Full target:
extensionHostProcess.js:163
{
  "type": "primitive",
  "mark": {
    "type": "cursor"
  },
  "modifiers": [
    {
      "type": "containingScope",
      "scopeType": {
        "type": "statement"
      }
    }
  ]
}
extensionHostProcess.js:163
Error: Expected language definition entry is missing for languageId swift
	at _LanguageDefinitionsImpl.get (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:33609:13)
	at ScopeHandlerFactoryImpl.maybeCreate (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:28502:41)
	at ContainingScopeStage.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:33880:51)
	at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34184:49
	at Array.flatMap (<anonymous>)
	at /Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34184:23
	at Array.forEach (<anonymous>)
	at processModifierStages (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34183:18)
	at TargetPipeline.processPrimitiveTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34176:12)
	at TargetPipeline.processTarget (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34074:21)
	at TargetPipeline.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34062:29)
	at TargetPipelineRunner.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:34037:7)
	at CommandRunnerImpl.getTargets (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:40666:32)
	at CommandRunnerImpl.runAction (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:40658:32)
	at CommandRunnerImpl.run (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:40544:20)
	at async runCommand (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:40960:20)
	at async runCommandWrapper (/Users/atacan/Developer/Repositories/cursorless-dev-cursorless/packages/cursorless-vscode/dist/extension.cjs:59429:14)
	at async cw.h (file:///Applications/Visual%20Studio%20Code.app/Contents/Resources/app/out/vs/workbench/api/node/extensionHostProcess.js:115:32825)
extensionHostProcess.js:163

AndreasArvidsson · 2025-01-18T16:19:07Z

When I run this code I get the following:

AndreasArvidsson · 2025-01-18T16:23:41Z

Also you can't just make up your own scopes for the capture names. Cursorless has no idea what to do with @struct, @enum etc.

atacan · 2025-01-18T16:25:11Z

When I run this code I get the following:

interesting I don't see the red text

AndreasArvidsson · 2025-01-18T16:27:37Z

When I run this code I get the following:

interesting I don't see the red text

Restart. Clean and recompile.

atacan · 2025-01-18T17:11:29Z

okay, thank you very much I followed the advice to start small, and made function declaration work

AndreasArvidsson · 2025-01-18T17:21:58Z

Glad to hear it!

…array, dictionary, and regex declarations

…wift.scm

pokey · 2025-01-18T18:40:43Z

You'll want to re-run step 6 now that you have things working, as the tests are currently actually checking to ensure things are still broken, so they'll fail in CI now

atacan · 2025-01-18T18:52:02Z

You'll want to re-run step 6 now that you have things working, as the tests are currently actually checking to ensure things are still broken, so they'll fail in CI now

In that step, I say the command "debug edit subset" Then, I get the "testSubsetGrep.properties does not exist on this computer" error because, in the repository, I don't see such a file: cursorless/packages/test-harness/testSubsetGrep.properties'

…ling in swift.scm

pokey · 2025-01-18T20:06:41Z

oh you might need to say "debug generate subset" the first time sorry; worth a quick docs PR saying you need to do that the first time if that's the case

atacan · 2025-01-19T10:42:49Z

I generated that file. Below is the content of it. But strangely, now when I say "cursorless record scope" I don't see 'swift' in the opened dropdown. But when I run the extension the scopes for Swift works and I don't see any error message.

Also, I assumed "Update fixtures subset" meant to be "VSCode: Update test fixtures (subset)" in the launch.json

# This file contains the grep strings to pass to Mocha when running a subset of tests.
# These grep strings will be used with the "Run test subset" launch configuration.
# See https://mochajs.org/#-grep-regexp-g-regexp for supported syntax.
#
# One regular expression per line.
# Tests matching any of the regular expressions will be run.

languages/swift/

…n swift.scm

atacan added 6 commits January 18, 2025 15:33

initial edits for Swift language support

c706436

- Introduced `swiftScopeSupport` to manage language-specific scope features. - Updated `languageScopeSupport` to include Swift support. - Created a new file for Swift scope support definitions.

remove the Swift-specific type scopes since they're not in the standa…

e01350e

…rd scope types

wip

3a54328

atacan requested a review from a team as a code owner January 18, 2025 15:41

swift MDX

e9323fe

AndreasArvidsson reviewed Jan 18, 2025

View reviewed changes

data/fixtures/scopes/swift/index.json Outdated Show resolved Hide resolved

deleted

3f4506c

atacan added 2 commits January 18, 2025 17:05

start from scratch

1655be7

Add Swift grammar rules and declarations to swift.scm

e6b91c8

atacan added 2 commits January 18, 2025 17:49

start small

231064a

make the function work

8a0ddd2

atacan added 4 commits January 18, 2025 18:36

swift.scm by adding class and protocol declarations.

f2d8d64

full support not-support list

31d4d2a

Enhance swift.scm by adding support for import, property, typealias, …

dbda618

…array, dictionary, and regex declarations

Add support for ternary expressions and enhance comment handling in s…

a568661

…wift.scm

[pre-commit.ci lite] apply automatic fixes

df4ac3d

Add support for switch statements and enhance if/guard statement hand…

53ec6d1

…ling in swift.scm

atacan added 3 commits January 19, 2025 11:47

wrong folder?

1cc4244

swift playground

93437b6

Add support for protocol declarations and enhance argument handling i…

5a7de2e

…n swift.scm

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Swift programming language #2734

Add Swift programming language #2734

atacan commented Jan 18, 2025

atacan commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025 •

edited

Loading

atacan commented Jan 18, 2025 •

edited

Loading

AndreasArvidsson commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025 •

edited

Loading

atacan commented Jan 18, 2025 •

edited

Loading

AndreasArvidsson commented Jan 18, 2025

atacan commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025

pokey commented Jan 18, 2025

atacan commented Jan 18, 2025

pokey commented Jan 18, 2025

atacan commented Jan 19, 2025 •

edited

Loading

Add Swift programming language #2734

Are you sure you want to change the base?

Add Swift programming language #2734

Conversation

atacan commented Jan 18, 2025

Checklist

atacan commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025 • edited Loading

atacan commented Jan 18, 2025 • edited Loading

AndreasArvidsson commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025 • edited Loading

atacan commented Jan 18, 2025 • edited Loading

AndreasArvidsson commented Jan 18, 2025

atacan commented Jan 18, 2025

AndreasArvidsson commented Jan 18, 2025

pokey commented Jan 18, 2025

atacan commented Jan 18, 2025

pokey commented Jan 18, 2025

atacan commented Jan 19, 2025 • edited Loading

AndreasArvidsson commented Jan 18, 2025 •

edited

Loading

atacan commented Jan 18, 2025 •

edited

Loading

AndreasArvidsson commented Jan 18, 2025 •

edited

Loading

atacan commented Jan 18, 2025 •

edited

Loading

atacan commented Jan 19, 2025 •

edited

Loading