Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/better external command support #897

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

EmilyGraceSeville7cf
Copy link
Contributor

Added snippets for:

  • zip, unzip
  • find

@skovhus
Copy link
Collaborator

skovhus commented Jul 5, 2023

Thanks. There seems to be some formatting issues. Running yarn lint should fix it.

@Shane-XB-Qian
Copy link
Contributor

to be honest, those un-general chars in the label mostly would cause issues,
i would suggest you gave up those non word chars;
or actually the snip had committed in this repo looks not very good quality,
how about rollback but just keep using snip from local plugin? that mostly maintained by community perhaps better?

@EmilyGraceSeville7cf
Copy link
Contributor Author

EmilyGraceSeville7cf commented Jul 7, 2023

@Shane-XB-Qian, can you clarify what quality issues do you mean and what extension you propose to use? I remember there was a shellman VS Code extension.

UPD:
I took a look at shellman extension. The problem with it that it doesn't support option between short/long options for some commands. But I think it's fixable. So... my plan to enhance that extension, embrace some of our snippets and remove them from this repo when everything is done with shellman.

@skovhus
Copy link
Collaborator

skovhus commented Jul 16, 2023

how about rollback but just keep using snip from local plugin?

The argument for having the snippets as part of the language server is that the usage is much wider than an extension for vscode. Bash language server is used in all editors supporting the language server protocol (which is basically all major code editors or IDEs).

But if quality is a concern, then we should fix that. I’m personally barely using snippets, so I’m unaware of the best practices here.

@Shane-XB-Qian
Copy link
Contributor

Shane-XB-Qian commented Jul 17, 2023 via email

@skovhus
Copy link
Collaborator

skovhus commented Jul 17, 2023

Thanks for the additional context. I’m not sure I fully understand why specialized snippets for a single editor can be more flexible or better maintained than an LSP based on.

Personally I’m not bothered by the bash language server snippets, but I’m curious if you would suggest having a config flag to disable them?

@EmilyGraceSeville7cf
Copy link
Contributor Author

or config well, then those snips looks buggy or dup.

Can you propose your suggestions on enhancing snippets? Somewhere, maybe as an issue, maybe as PR. I wanna see what you miss in snippets.

@Shane-XB-Qian
Copy link
Contributor

I’m not sure I fully understand why specialized snippets for a single editor can be more flexible or better maintained than an LSP based on.

well, this is open source, basically it's just a json file (or similar), user can modify, remove, add or just delete it.
compare to snips in server, maybe you can add a flag to disable it, but well, it looks a like tech burden? or dup?

@EmilyGraceSeville7cf
Copy link
Contributor Author

Please don't merge before #923. Thanks!

@EmilyGraceSeville7cf EmilyGraceSeville7cf marked this pull request as draft August 2, 2023 13:19
@Shane-XB-Qian
Copy link
Contributor

"sed ${1|-E,--regexp-extended|} ':${2:x} N $! b$2 ${3:command}' ${4:file}" (from #923)

$! made following expanding failed, you may need to avoid or change to another way.
// looks same case if $$.

@EmilyGraceSeville7cf
Copy link
Contributor Author

EmilyGraceSeville7cf commented Aug 3, 2023

@Shane-XB-Qian thanks for notifying me. I'll take a look how to fix it.

UPD: In VS Code it seems to work fine. What editor do u use?

@Shane-XB-Qian
Copy link
Contributor

diff --git a/server/src/snippets.ts b/server/src/snippets.ts
index 2730fc1..ff3d491 100644
--- a/server/src/snippets.ts
+++ b/server/src/snippets.ts
@@ -594,13 +594,13 @@ export const SNIPPETS: BashCompletionItem[] = [
     insertText: "sed '' ${1:file}",
   },
   {
     documentation: 'file read',
     label: 'file-read',
     insertText:
-      "sed ${1|-E,--regexp-extended|} ':${2:x} N $! b$2 ${3:command}' ${4:file}",
+      "sed ${1|-E,--regexp-extended|} ':${2:x} N \\$! b$2 ${3:command}' ${4:file}",
   },
   {
     documentation: 'skip first',
     label: 'skip-first',
     insertText: 'tail ${1|-n,-c,--lines,--bytes|} +${2:count}',
   },
@@ -637,26 +637,26 @@ export const SNIPPETS: BashCompletionItem[] = [
   {
     documentation: 'device',
     label: 'device',
     insertText: '/dev/${1|null,stdin,stdout,stderr|}',
   },
   {
-    documentation: 'completion',
-    label: 'completion definition',
+    documentation: 'completion definition',
+    label: 'completion-definition',
     insertText: [
       '_$1_completions()',
       '{',
       '\treadarray -t COMPREPLY < <(compgen -W "-h --help -v --version" "\\${COMP_WORDS[1]}")',
       '}',
       '',
       'complete -F _$1_completions ${1:command}',
     ].join('\n'),
   },
   {
-    documentation: 'comment',
-    label: 'comment definition',
+    documentation: 'comment definition',
+    label: 'comment-definition',
     insertText: '# ${1:description}',
   },
 ].map((item) => ({
   ...item,
   documentation: {
     value: [

a bit complex or no idea some of them,
but since this had been merged to lsp server side, then let's try to refine it a bit.

@Shane-XB-Qian
Copy link
Contributor

Shane-XB-Qian commented Oct 18, 2023

@EmilyGraceSeville7cf if you still wish to merge your left 3 snip PR, maybe better tidy up them (plus above my patch) again by rebase and squash and sort/review/correct etc, and some notes we've discussed, if so maybe a bit clear, and no include the dependency npm json/yaml files, or there conflicted at least.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants