diff --git a/vscode_extensions/run-until-cursor/README.md b/vscode_extensions/run-until-cursor/README.md index 414f550e703..50ce119ac3e 100644 --- a/vscode_extensions/run-until-cursor/README.md +++ b/vscode_extensions/run-until-cursor/README.md @@ -3,20 +3,25 @@ This extension allows you to **execute all lines inside `run()` up to the line where the cursor currently is** in the VS Code **Interactive Window**. ## Usage -1. Place your cursor anywhere inside `run()`. -2. Press **Cmd+Enter**. -3. The extension will **automatically select and execute the code inside run() up to the cursor**. +* If the cursor is anywhere outside the `run()` function, press `cmd+Enter` to execute the entire script in the interactive window. After doing this, the cursor will be moved to the beginning of the `run()` function. + * This is useful when you just opened a new data step script and haven't yet initialized an interactive window. +* Once an interactive window has already been initialized, if the cursor is inside the `run()` function, press `cmd+Enter` to execute all the code inside the function until the current line (the current line will also be executed). + * This is useful while working on a data step, when you want to quickly test the entire content of `run()` from the beginning. ## Installation +You don't have to install it manually if you are on a working ETL environment. Just running `make test` should install the latest version of this extension. + +However, if you want to manually install this extension, you can: - Press `cmd+shift+p` and select "Extensions: Install from VSIX". - Select the latest version of the packaged extension, e.g. `install/run-until-cursor-0.0.1.vsix`. -- Restart VSCode to ensure the new version is installed (although it may not be necessary). +- Restart VSCode to ensure the new version is installed (although it may not be necessary). You can do it by doing `cmd+shift+p` and selecting "Developer: Reload Window". Alternatively, from the command line, go to `vscode_extensions/run-until-cursor/` and run: ``` -code --install-extension run-until-cursor-0.0.1.vsix +code --install-extension install/run-until-cursor-0.0.1.vsix ``` +(or any other version). ## Development @@ -26,4 +31,4 @@ npm run compile vsce package code --install-extension run-until-cursor-0.0.1.vsix ``` -(or whatever the version is, specified in `package.json`). Then, from VSCode, `cmd+shift+p` and select "Developer: Reload Window". +(or whatever version is specified in `package.json`). Then, from VSCode, `cmd+shift+p` and select "Developer: Reload Window".