Implements vimgrep, #5991

src/cmd_line/commands/grep.ts

@@ -0,0 +1,65 @@
+import * as vscode from 'vscode';
+
+import * as error from '../../error';
+import { VimState } from '../../state/vimState';
+import { Pattern, SearchDirection } from '../../vimscript/pattern';
+import { ExCommand } from '../../vimscript/exCommand';
+import { Parser, seq, optWhitespace, whitespace } from 'parsimmon';
+import { fileNameParser } from '../../vimscript/parserUtils';
+
+// Still missing:
+// When a number is put before the command this is used
+// as the maximum number of matches to find.  Use
+// ":1vimgrep pattern file" to find only the first.
+// Useful if you only want to check if there is a match
+// and quit quickly when it's found.
+
+// Without the 'j' flag Vim jumps to the first match.
+// With 'j' only the quickfix list is updated.
+// With the [!] any changes in the current buffer are
+// abandoned.
+interface IGrepCommandArguments {
+  pattern: Pattern;
+  files: string[];
+}
+
+// Implements :grep
+// https://vimdoc.sourceforge.net/htmldoc/quickfix.html#:vimgrep
+export class GrepCommand extends ExCommand {
+  public static readonly argParser: Parser<GrepCommand> = optWhitespace.then(
+    seq(
+      Pattern.parser({ direction: SearchDirection.Backward, delimiter: ' ' }),
+      fileNameParser.sepBy(whitespace),
+    ).map(([pattern, files]) => new GrepCommand({ pattern, files })),
+  );
+
+  public readonly arguments: IGrepCommandArguments;
+  constructor(args: IGrepCommandArguments) {
+    super();
+    this.arguments = args;
+  }
+
+  async execute(): Promise<void> {
+    const { pattern, files } = this.arguments;
+    if (files.length === 0) {
+      throw error.VimError.fromCode(error.ErrorCode.NoFileName);
+    }
+    // There are other arguments that can be passed, but probably need to dig into the VSCode source code, since they are not listed in the API reference
+    // https://code.visualstudio.com/api/references/commands
+    // This link on the other hand has the commands and I used this as a reference
+    // https://stackoverflow.com/questions/62251045/search-find-in-files-keybinding-can-take-arguments-workbench-view-search-can
+    await vscode.commands.executeCommand('workbench.action.findInFiles', {
+      query: pattern.patternString,
+      filesToInclude: files.join(','),
+      triggerSearch: true,
+      isRegex: true,
+    });
+    await vscode.commands.executeCommand('search.action.focusSearchList');
+    // Only if there's no [j] flag
+    await vscode.commands.executeCommand('search.action.focusNextSearchResult');
+    // TODO: this will always throw an error, since the command returns nothing
+    // if (!grepResults) {
+    //   throw error.VimError.fromCode(error.ErrorCode.PatternNotFound);
+    // }
+  }
+}

src/vimscript/exCommandParser.ts

@@ -13,6 +13,7 @@ import { FileInfoCommand } from '../cmd_line/commands/fileInfo';
 import { EchoCommand } from '../cmd_line/commands/echo';
 import { GotoCommand } from '../cmd_line/commands/goto';
 import { GotoLineCommand } from '../cmd_line/commands/gotoLine';
+import { GrepCommand } from '../cmd_line/commands/grep';
 import { HistoryCommand } from '../cmd_line/commands/history';
 import { ClearJumpsCommand, JumpsCommand } from '../cmd_line/commands/jumps';
 import { CenterCommand, LeftCommand, RightCommand } from '../cmd_line/commands/leftRightCenter';
@@ -248,7 +249,7 @@ export const builtinExCommands: ReadonlyArray<[[string, string], ArgParser | und
   [['fu', 'nction'], undefined],
   [['g', 'lobal'], undefined],
   [['go', 'to'], GotoCommand.argParser],
-  [['gr', 'ep'], undefined],
+  [['gr', 'ep'], GrepCommand.argParser],
   [['grepa', 'dd'], undefined],
   [['gu', 'i'], undefined],
   [['gv', 'im'], undefined],
@@ -577,7 +578,8 @@ export const builtinExCommands: ReadonlyArray<[[string, string], ArgParser | und
   [['vert', 'ical'], undefined],
   [['vi', 'sual'], undefined],
   [['vie', 'w'], undefined],
-  [['vim', 'grep'], undefined],
+  [['vim', 'grep'], GrepCommand.argParser],
+  [['grep', ''], GrepCommand.argParser],
   [['vimgrepa', 'dd'], undefined],
   [['viu', 'sage'], undefined],
   [['vm', 'ap'], undefined],

test/cmd_line/grep.test.ts

@@ -0,0 +1,83 @@
+import * as assert from 'assert';
+import * as vscode from 'vscode';
+
+import { getAndUpdateModeHandler } from '../../extension';
+import * as t from '../testUtils';
+import { GrepCommand } from '../../src/cmd_line/commands/grep';
+import { Pattern, SearchDirection } from '../../src/vimscript/pattern';
+import { Mode } from '../../src/mode/mode';
+
+// This will go into the exCommandParse test
+// function exParseTest(input: string, parsed: ExCommand) {
+//   test(input, () => {
+//     const { command } = exCommandParser.tryParse(input);
+//     assert.deepStrictEqual(command, parsed);
+//   });
+// }
+
+// suite('grep', () => {
+//     const pattern = Pattern.parser({ direction: SearchDirection.Forward, delimiter: '/' });
+//   exParseTest(':vimgrep "t*st" foo.txt',
+//     new GrepCommand({
+//       pattern: pattern.tryParse('t*st'),
+//       files: ['foo.txt'],
+//     }),
+//   );
+// });
+
+function grep(pattern: Pattern, files: string[]): GrepCommand {
+  return new GrepCommand({ pattern, files });
+}
+
+suite('Basic grep command', () => {
+  setup(t.setupWorkspace);
+  suiteTeardown(t.cleanUpWorkspace);
+  test('GrepCommand parses correctly', async () => {
+    await vscode.commands.executeCommand('workbench.action.files.newUntitledFile');
+    const pattern = Pattern.parser({ direction: SearchDirection.Backward, delimiter: '/' });
+    const command = grep(pattern.tryParse('t*st'), ['Untitled-1']);
+    assert.deepStrictEqual(command.arguments, {
+      pattern: pattern.tryParse('t*st'),
+      files: ['Untitled-1'],
+    });
+  });
+  // when you search.action.focusNextSearchResult , it will enter the file in visual mode for some reason, we can test whether it is in visual mode or not after running that command
+  // that only happens if the search panel is not open already
+  // if the search panel is open, it will be in normal mode
+  // it will also be in normal mode if you run vimgrep from another file
+  test('GrepCommand executes correctly', async () => {
+    // Untitled-1
+    await vscode.commands.executeCommand('workbench.action.files.newUntitledFile');
+    const editor = vscode.window.activeTextEditor;
+    if (editor) {
+      await editor.edit((editBuilder) => {
+        editBuilder.insert(
+          new vscode.Position(0, 0),
+          'this is a test\nanother t*st line\nno match here\n',
+        );
+      });
+      // Because of the save confirmation dialog, it will timeout
+      // await editor.document.save()
+    }
+    // Untitled-2
+    await vscode.commands.executeCommand('workbench.action.files.newUntitledFile');
+    const modeHandler = await getAndUpdateModeHandler();
+    const pattern = Pattern.parser({ direction: SearchDirection.Backward, delimiter: '/' });
+    const command = grep(pattern.tryParse('t*st'), ['Untitled-1']);
+    await command.execute();
+    await vscode.commands.executeCommand('search.action.focusNextSearchResult');
+    // Assert that the active editor is Untitled-1
+    const activeEditor = vscode.window.activeTextEditor;
+    assert.ok(activeEditor, 'There should be an active editor');
+    assert.ok(
+      activeEditor?.document.fileName.endsWith('Untitled-1'),
+      'Active editor should be Untitled-1 after grep',
+    );
+    assert.ok(modeHandler, 'modeHandler should be defined');
+    assert.notStrictEqual(
+      modeHandler.vimState,
+      Mode.Visual,
+      'Should not be in visual mode after grep',
+    );
+  });
+});