Bash: Add snippets for VS Code #664

EmilyGraceSeville7cf · 2023-01-07T11:37:07Z

Add snippets for:

language constructs
builtins
expansions
devices

Motivation: have standardized and easy memorable snippets.

- the first argument is not an option - the first argument is mandatory

EmilyGraceSeville7cf · 2023-01-07T11:39:43Z

I guess I can do the same job for other supported editors by this extension. :)

skovhus · 2023-01-07T13:49:29Z

Thanks for the contribution!

I guess I can do the same job for other supported editors by this extension. :)

Yes, if we move this to the server (instead of part of the vscode extension as done here), then all editors will get these snippets available. I believe that is the way to go if we support snippets.

I’m curious to know how many would prefer having snippets available. I assume we need a way to disable them or potentially override them. As the server is used by a lot of people, we need to think about the reception of this feature.

Example of other language servers returning snippets: https://github.com/iamcco/vim-language-server/blob/30f442dfa0ff8436eceeb2a306d1e8fd17bbdc6b/src/server/snippets.ts

EmilyGraceSeville7cf · 2023-01-07T14:04:34Z

@skovhus, it's possible to disable them now AFAIK.

EmilyGraceSeville7cf · 2023-01-08T13:31:15Z

Is it possible to move snippets to server a little bit later but now accept these ones? I am not JS/TS developer that's why I am asking for it.

skovhus · 2023-01-08T15:03:56Z

Is it possible to move snippets to server a little bit later but now accept these ones? I am not JS/TS developer that's why I am asking for it.

That’s a nice and lean approach. Then we might get some feedback before rolling this out to all clients.

Let me know once you are satisfied with these. I’m not a big snippet developer myself, so I would need to spend some time playing around with these. Maybe there are some standard bash snippets that we can get inspiration from?

vscode-client/snippets/snippets.json

skovhus · 2023-01-09T12:58:53Z

vscode-client/snippets/snippets.json

+            "{${1:from}..${2:to}}"
+        ]
+    },
+    "echo": {


I'm not sure how much value very basic snippets like echo and source provides.

Just to save some keystrokes and quote argument automatically. :)

skovhus · 2023-01-09T12:59:53Z

vscode-client/snippets/snippets.json

+        "description": "[cd]",
+        "prefix": "cd",
+        "body": [
+            "cd \"${1:path/to/directory}\" || echo \"${2:error_message}\" >&2"


This seems rather non-generic.

What do u mean? Can you tell me what you expect to see? I've added || as cd potentially can fail.

For snippets to be useful I believe they should be fairly generic and applicable for most users. A good example is the test snippet that is a very generic. For cd we assume that the user wants to handle error case like this and swallow the error (exit code would be 0 after running this).

I would like us to remove the snippet for cd for now.

skovhus · 2023-01-09T13:00:15Z

vscode-client/snippets/snippets.json

+            "let ${1:argument}"
+        ]
+    },
+    "test": {


test seems really useful with all the different options here.

=~ has been added.

- describe naming convention

skovhus

This is a really good start! Thanks for your work. I've added a few suggestions. I believe we can release this soon. 👏

skovhus · 2023-01-10T08:45:08Z

vscode-client/snippets/convention.md

@@ -0,0 +1,16 @@
+# Snippet naming convention


Nice with this documentation. Once the snippets are in TypeScript, then we should change this markdown file to some unit tests to ensure that this is enforced.

vscode-client/snippets/snippets.json

skovhus · 2023-01-10T08:54:05Z

vscode-client/snippets/snippets.json

+            "[[ ${1:argument1} ${2|-ef,-nt,-ot,==,=,!=,=~,<,>,-eq,-ne,-lt,-le,-gt,-ge|} ${3:argument2} ]]"
+        ]
+    },
+    "device": {


I suggest we get rid of the device. They content here are all standard streams and not really devices, and I'm not convinced anyone would find them by typing de.

I've renamed snippet to stream.

I'm also not convinced anyone would find them by typing stream, so I would just get rid of it. But no strong opinion here. :)

But we don't need to type stream we need to type dev now as it's one of the prefixes. :)

Ah awesome! 👏

skovhus · 2023-01-10T09:02:26Z

vscode-client/snippets/snippets.json

+        "description": "[cd]",
+        "prefix": "cd",
+        "body": [
+            "cd \"${1:path/to/directory}\" || echo \"${2:error_message}\" >&2"


For snippets to be useful I believe they should be fairly generic and applicable for most users. A good example is the test snippet that is a very generic. For cd we assume that the user wants to handle error case like this and swallow the error (exit code would be 0 after running this).

I would like us to remove the snippet for cd for now.

EmilyGraceSeville7cf · 2023-01-10T11:46:07Z

I would like us to remove the snippet for cd for now.

Can I ask what best shell scripting practices to stick with to form expectations of what user might want to type? Can we assume that user don't want to include error handling for cd-like commands by default?

I've removed error message printing from this snippet now.

skovhus · 2023-01-10T12:04:41Z

Can I ask what best shell scripting practices to stick with to form expectations of what user might want to type? Can we assume that user don't want to include error handling for cd-like commands by default?

As there isn't one standard way of doing it and the command is so trivial to type, I don't see that much value in keeping it.

vscode-client/snippets/snippets.json

EmilySeville7cfg added 7 commits January 7, 2023 20:58

Add basic snippets

3962e3c

Move command snippets to the end

728c362

Add snippets for all builtins where:

cfba66f

- the first argument is not an option - the first argument is mandatory

Add snippets for parameter expansions

03382a2

Add brace expansion snippet

b7f3d76

Add snippet for devices

85bcde4

Extend sheband snippet

24f5ce3

Mention snippets in README

2076714

Merge branch 'main' into feature/add-snippets

5319cd1

EmilySeville7cfg added 4 commits January 9, 2023 00:43

Fix fo snippet

1c8d7e6

Fix fo snippet - 2

e3a7ba7

Fix placeholder indexing

9edc28b

Add placeholder for ife snippet

7a49911

skovhus reviewed Jan 8, 2023

View reviewed changes

vscode-client/snippets/snippets.json Outdated Show resolved Hide resolved

EmilySeville7cfg added 2 commits January 9, 2023 01:15

Remove builtin snippet

4e97c0a

Merge branch 'main' into feature/add-snippets

8e56a40

skovhus reviewed Jan 9, 2023

View reviewed changes

vscode-client/snippets/snippets.json Outdated Show resolved Hide resolved

skovhus reviewed Jan 9, 2023

View reviewed changes

skovhus mentioned this pull request Jan 9, 2023

Support snippets #175

Closed

EmilySeville7cfg added 2 commits January 10, 2023 00:05

Make snippets more user-friendly and:

b386a82

- describe naming convention

Add sed and awk snippets

65021b0

skovhus reviewed Jan 10, 2023

View reviewed changes

Merge branch 'main' into feature/add-snippets

1bc5a0d

EmilySeville7cfg added 2 commits January 10, 2023 21:43

Add dev prefix for device snippet

f10bcbc

Rename device to stream

ea06f10

Remove error handling from cd snippet

4e7745c

Emily Grace Seville added 2 commits January 10, 2023 22:38

Merge branch 'main' into feature/add-snippets

1e7f641

Keep just long prefixes

1e17a6d

skovhus enabled auto-merge January 10, 2023 13:45

skovhus approved these changes Jan 10, 2023

View reviewed changes

skovhus merged commit d9dc4cd into bash-lsp:main Jan 10, 2023

skovhus reviewed Jan 10, 2023

View reviewed changes

vscode-client/snippets/snippets.json Show resolved Hide resolved

skovhus mentioned this pull request Jan 10, 2023

Release vscode extension to 1.27.0 #674

Merged

EmilyGraceSeville7cf mentioned this pull request Jan 11, 2023

Fix mnemonics for snippets #675

Merged

Bash: Add snippets for VS Code #664

Bash: Add snippets for VS Code #664

Uh oh!

Conversation

EmilyGraceSeville7cf commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EmilyGraceSeville7cf commented Jan 7, 2023

Uh oh!

skovhus commented Jan 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EmilyGraceSeville7cf commented Jan 7, 2023

Uh oh!

EmilyGraceSeville7cf commented Jan 8, 2023

Uh oh!

skovhus commented Jan 8, 2023

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

skovhus left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EmilyGraceSeville7cf Jan 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

EmilyGraceSeville7cf commented Jan 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

skovhus commented Jan 10, 2023

Uh oh!

Uh oh!

Uh oh!

EmilyGraceSeville7cf commented Jan 7, 2023 •

edited

Loading

skovhus commented Jan 7, 2023 •

edited

Loading

skovhus left a comment •

edited

Loading

EmilyGraceSeville7cf Jan 10, 2023 •

edited

Loading

EmilyGraceSeville7cf commented Jan 10, 2023 •

edited

Loading