Added support for Shell script language. by fidgetingbits · Pull Request #2058 · cursorless-dev/cursorless

fidgetingbits · 2023-11-27T01:47:34Z

What

Adds support for some next gen scopes to shellscript programming language.

This is something I did recently while working on some bash scripts, but haven't had time to finish it off yet.

Checklist

Scope Support

Legend: ✓ Supported, ✗ Not supported, _ Not applicable

Supported	Tested	Term	Capture	Definition	Comment
✓	✓	`list`	`@list`	List type equivalent	-
✓	✓	`inside list`	`@list.interior`	Inside of a list	-
_	_	`map`	`@map`	Dictionary type equivalent	-
_	_	`inside map`	`@map.interior`	Inside of a dictionary	-
_	_	`key`	`@collectionKey`	Dictionary key equivalent	-
✓	✓	`funk`	`@namedFunction`	A named function declaration	-
✓	✓	`inside funk`	`@namedFunction.interior`	The inside of a lambda declaration	-
✓	✓	`funk name`	`@functionName`	Name of declared function	-
_	_	`lambda`	`@anonymousFunction`	A lambda declaration	-
_	_	`inside lambda`	`@anonymousFunction.interior`	The inside of a lambda declaration	-
✓	✓	`name`	`@name`	Variable name	-
✓	✓	`value`	`@value`	Right-hand-side value of an assignment	-
_	_	`value`	`@value`	Value returned from a function	-
		`value`	`@value`	Value of a key-value pair	-
✓	✓	`state`	`@statement`	Any single coded statement	-
✓	✓	`if state`	`@ifStatement`	An if conditional block	-
✓	✓	`condition`	`@condition`	Condition of an if block	-
✓		`condition`	`@condition`	Condition of a while loop	-
✓		`condition`	`@condition`	Condition of a do while style loop	-
✓		`condition`	`@condition`	Condition of a for loop	-
✓		`condition`	`@condition`	Condition of a switch case	-
_	_	`condition`	`@condition`	Condition of a ternary expression	-
✓	✓	`branch`	`@branch`	The resulting code associated with af conditional expression	-
✓	✓	`inside branch`	`@branch.interior`	The statements associated with the body of a conditional expression	-
✓	✓	`comment`	`@comment`	Code comment	-
_	_	`comment`	`@comment`	Multi-line code comment	-
		`inside comment`	`@comment.interior`	The inside of a code comment	-
✓	✓	`string`	`@string`	Single line strings	-
_	_	`string`	`@string`	Multi-line strings
✓	✓	-	`@textFragment`	Used to capture string-type nodes (strings and comments)	-
✓	✓	`call`	`@functionCall`	A function call (not a function definition)	-
✓	✓	`callee`	`@functionCallee`	Name of the function being called	-
_	_	`arg`	`@argumentOrParameter`	Arguments to function definition	-
✓	✓	`arg`	`@argumentOrParameter`	Arguments to function call	-
✓	✓	`arg`	`@argumentOrParameter`	Interpolated variables in strings	-
_	_	`class`	`@class`	Class or structure declaration	-
_	_	`inside class`	`@class.interior`	The inside of a class declaration	-
_	_	`class name`	`@className`	Name of class or structure declaration	-
_	_	`type`	`@type`	Type declarations	-
✓	✓	`regex`	`@regex`	Regular expression	-

pokey

Once again fantastic work. Left a few minor comments

pokey · 2023-12-06T20:13:00Z

Oh also fwiw the infrastructure to formalize those test facets is now in place. Feel free to try it out!

Ensure the facet you care about exists in https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts. Add it if not (tho feel free to ask us if unsure whether it makes sense)
Add a facet support file for your language. See eg https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/javascript.ts
Expose your facet support info in https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/getLanguageScopeSupport.ts
Create a subdirectory for your language in the test dir.
Drop a file in there named after the facet. Eg packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/shellscript/value.assignment.scope. Just include your desired test code, followed by a line containing just ---
Run the Update test fixtures launch config. It should dump a nice pretty representation of the scopes found there
Repeat step 5 as many times as desired, followed by step 6 again!

fidgetingbits · 2024-01-02T15:11:46Z

All issues from initial review pass are fixed. I have support for a few node types that are dependent on an updated tree-sitter-bash (vscode-parse-tree PR #77). I've also fixed lots of other quirks and edge cases I ran into.

I added the initial scope facet files, but running the Update Fixtures config throws a bunch of errors (not sure if nix-related or not), and I haven't dug into it quite yet. So I don't see any updated content in the test .scope file I created, but still pushed it anyway.

pokey · 2024-01-19T17:50:46Z

I switched to tip of bash branch, and noticed some tests breaking. I'm not sure if that was the cause, but I fixed them. Along the way I cleaned up a bit and added / updated facet tests. The auto facet update worked fine for me fwiw

See my fixes; haven't looked at all the code, but possible some of the techniques there apply elsewhere? But if not limk and I'll continue reviewing

wenkokke · 2024-01-22T14:04:44Z

Oh also fwiw the infrastructure to formalize those test facets is now in place. Feel free to try it out!

Ensure the facet you care about exists in https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/scopeSupportFacets.types.ts. Add it if not (tho feel free to ask us if unsure whether it makes sense)

Add a facet support file for your language. See eg https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/javascript.ts

Expose your facet support info in https://github.com/cursorless-dev/cursorless/blob/main/packages/common/src/scopeSupportFacets/getLanguageScopeSupport.ts

Create a subdirectory for your language in the test dir.

Drop a file in there named after the facet. Eg packages/cursorless-vscode-e2e/src/suite/fixtures/scopes/shellscript/value.assignment.scope. Just include your desired test code, followed by a line containing just ---

Run the Update test fixtures launch config. It should dump a nice pretty representation of the scopes found there

Repeat step 5 as many times as desired, followed by step 6 again!

How do I actually run this for a subset? There is very little documentation for the regular expressions, and the example folders don't seem to actually exist.

pokey · 2024-01-22T14:55:07Z

How do I actually run this for a subset? There is very little documentation for the regular expressions

See https://www.cursorless.org/docs/contributing/#running-a-subset-of-tests

Thought the regex was documented somewhere. It’s just the one supported by mocha cli. A PR to add a link to that to those docs would be much appreciated ☺️

(pasted from slack form posterity)

the example folders don't seem to actually exist.

Sorry, not sure I follow. Which example folders?

fidgetingbits · 2024-01-23T02:54:12Z

My problem was the regex. I realized after I ran the non subset and it worked. My regex was set to languages/shellscript because that's what I had been doing for the test cases (not sure why I prefixed languages/ in the first place), and of course scope doesn't have the languages/ subdir.

Fwiw, one error I get when running tests (though doesn't impact the scopes updating):

rejected promise not handled within 1 second: NeedsInitialTalonUpdateError: Custom spoken forms file not found at /tmp/ffa46ea4b829416627bdcd0114572b73/state.json. Using default spoken forms.
extensionHostProcess.js:131
stack trace: NeedsInitialTalonUpdateError: Custom spoken forms file not found at /tmp/ffa46ea4b829416627bdcd0114572b73/state.json. Using default spoken forms.
	at TalonSpokenFormsJsonReader.getSpokenFormEntries (/home/aa/persist/source/fidgetingbits-cursorless/packages/cursorless-vscode/dist/extension.cjs:50288:15)
	at async CustomSpokenForms.updateSpokenFormMaps (/home/aa/persist/source/fidgetingbits-cursorless/packages/cursorless-vscode/dist/extension.cjs:34339:26)

Not sure if this is another issue with TMPDIR style stuff or what. Didn't get time to dig into it yet.

pokey · 2024-01-23T10:50:53Z

Is your cursorless talon up to date?

pokey · 2024-01-23T13:39:06Z

lmk if you want me to review the code or if you wanted to do another pass first

fidgetingbits · 2024-01-23T14:33:07Z

I'll take a look at it tomorrow to see if I spot any candidates for using removal, and also add the fixtures I've been working on.

fidgetingbits · 2024-06-17T02:53:00Z

Trying to update this in light of the conflict from getLanguageScopeSupport being deleted, and seeing new pre-commit errors I've not run into before:

eslint...................................................................Passed
prettier.................................................................Failed
- hook id: prettier
- exit code: 1

[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js
[error] Cannot find package 'prettier-plugin-tailwindcss' imported from /home/aa/dev/talon/fidgetingbits-curs
orless/noop.js

format-recorded-tests....................................................Failed
- hook id: format-recorded-tests
- exit code: 1

✘ [ERROR] Could not resolve "chai"

    packages/common/src/testUtil/runRecordedTest.ts:34:23:
      34 │ import { assert } from "chai";
         ╵                        ~~~~~~

  You can mark the path "chai" as external to exclude it from the bundle, which will remove this error.

Will look into it, but just throwing it out here in case you happen to know what to do.

fidgetingbits · 2024-06-17T03:22:17Z

The tailwind bug is from commit de37ebf. This adds an external pnpm package dependency that pre-commit itself won't install, so pre-commit install is no longer enough. Nixos doesn't have a prettier-plugin-tailwindcss npm package, so atm I have to manually pnpm install -w -D prettier-plugin-tailwindcss, which then changes the pnpm-lock.yaml file lol. :/ I will create a nix package for prettier-plugin-tailwindcss and get it upstreamed, but in the meantime I'll have to use a bit of a hack to get that to work I guess (will just install the package in the dev shell and then git restore the lock file..)

The second bug seems to be related to me recently changing the flake.nix file to use corepack per auscompgeek suggestion. Reverting it back to using hardcoded nodejs 18 makes it go away, so I will revert that latest commit in I guess, as using pre-commit wasn't something I had tested.

fidgetingbits · 2024-06-17T05:55:52Z

Looks like a bunch of tests are breaking related to @dummy and other things which I vaguely recall fixing a long time ago, so not sure what's up, but will investigate.

chatgpt-codex-connector · 2026-09-09T15:52:18Z

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-09-09T16:48:08.758902Z	`dd0947c`	New commits

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: eedaf0a3d0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e1de69cc8e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dd0947cf1d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

fidgetingbits requested review from AndreasArvidsson and pokey as code owners November 27, 2023 01:47

pokey reviewed Dec 6, 2023

View reviewed changes

fidgetingbits force-pushed the bash-lang branch from 307d7ea to f235bda Compare December 27, 2023 04:11

fidgetingbits commented Jan 22, 2024

View reviewed changes

Comment thread resources/queries/shellscript.scm Outdated

pokey marked this pull request as draft April 22, 2024 14:09

fidgetingbits force-pushed the bash-lang branch from d21b706 to 59a9341 Compare April 23, 2024 02:46

initial next-gen shellscript support

b650b22

fidgetingbits force-pushed the bash-lang branch from 59a9341 to b650b22 Compare June 17, 2024 03:16

fidgetingbits mentioned this pull request Jun 17, 2024

Add nix flake #1908

Merged

fidgetingbits mentioned this pull request Jul 26, 2024

Add shell check pre commit hook #2574

Merged

3 tasks

fidgetingbits and others added 3 commits August 5, 2024 09:08

Merge remote-tracking branch 'upstream/main' into bash-lang

9200cec

[pre-commit.ci lite] apply automatic fixes

42f1f4b

Merge with main

64f0a30

github-actions Bot added the lines/1000+ Pull request changes at least 1,000 lines label Sep 6, 2026

Remove legacy scope recorded test fixtures

bfcfe5b

github-actions Bot added lines/500-999 Pull request changes 500 to 999 lines and removed lines/1000+ Pull request changes at least 1,000 lines labels Sep 9, 2026

AndreasArvidsson added 16 commits September 9, 2026 12:57

string

ec07b6b

update

f8c7aff

for

049c925

Funk

cb40fcd

List and map

8152fe4

key value pairs

cb6d634

Move playground file

737355d

clean up

3868978

argument list

2791cb5

arguments

76d83a6

branch

c952ab5

interior

89d29f6

if interior

ce21798

iteration

9987096

Fix lint problems

3cd12b5

more lint issues

eedaf0a

AndreasArvidsson marked this pull request as ready for review September 9, 2026 15:52

AndreasArvidsson requested a review from a team as a code owner September 9, 2026 15:52

AndreasArvidsson changed the title ~~Initial next gen scope support for shellscript~~ Added scope support for shellscript Sep 9, 2026

Updated changelog

b53084d

AndreasArvidsson changed the title ~~Added scope support for shellscript~~ Added support for Shell script language. Sep 9, 2026

chatgpt-codex-connector Bot reviewed Sep 9, 2026

View reviewed changes

Comment thread resources/queries/shellscript.scm Outdated

Comment thread resources/queries/shellscript.scm

AndreasArvidsson added 3 commits September 9, 2026 18:01

Clean up

73fda37

Bug fixes

07ec316

More fixes

e1de69c

chatgpt-codex-connector Bot reviewed Sep 9, 2026

View reviewed changes

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

lint fix

dd0947c

AndreasArvidsson merged commit 7b79f6d into cursorless-dev:main Sep 9, 2026
17 checks passed

chatgpt-codex-connector Bot reviewed Sep 9, 2026

View reviewed changes

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Comment thread resources/queries/shellscript.scm

Uh oh!

Conversation

fidgetingbits commented Nov 27, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Checklist

Scope Support

Uh oh!

pokey left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pokey commented Dec 6, 2023

Uh oh!

fidgetingbits commented Jan 2, 2024

Uh oh!

pokey commented Jan 19, 2024

Uh oh!

Uh oh!

wenkokke commented Jan 22, 2024

Uh oh!

pokey commented Jan 22, 2024

Uh oh!

fidgetingbits commented Jan 23, 2024

Uh oh!

pokey commented Jan 23, 2024

Uh oh!

pokey commented Jan 23, 2024

Uh oh!

fidgetingbits commented Jan 23, 2024

Uh oh!

fidgetingbits commented Jun 17, 2024

Uh oh!

fidgetingbits commented Jun 17, 2024

Uh oh!

fidgetingbits commented Jun 17, 2024

Uh oh!

chatgpt-codex-connector Bot commented Sep 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codex Review Summary

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

fidgetingbits commented Nov 27, 2023 •

edited

Loading

chatgpt-codex-connector Bot commented Sep 9, 2026 •

edited

Loading