https://github.com/yhirose/vscode-filtertext
Filter Text extension for VS Code
https://github.com/yhirose/vscode-filtertext
Last synced: 6 months ago
JSON representation
Filter Text extension for VS Code
- Host: GitHub
- URL: https://github.com/yhirose/vscode-filtertext
- Owner: yhirose
- License: mit
- Created: 2015-11-22T02:50:36.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2019-07-24T19:43:55.000Z (about 6 years ago)
- Last Synced: 2025-04-18T09:34:34.719Z (6 months ago)
- Language: TypeScript
- Size: 85 KB
- Stars: 33
- Watchers: 5
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Filter Text extension for Visual Studio Code
This extension filters selected text through an external shell command inplace or into temp file.
It brings the power of Unix commands such as `sort` and `uniq` into your VS Code editor.
https://marketplace.visualstudio.com/items?itemName=yhirose.FilterText
## Usage
* Select text that you want to filter.
* Press `Ctrl+K Ctrl+F` (`⌘K ⌘F` on macOS).
* Alternatively, press `F1` and run the command named `Filter Text Inplace`.
* Type shell command like `sort -r` and press enter.
* It replaces the selected text with the text from stdout of the command.
### NOTE
* If you didn't select anything, it simply inserts the result text at the current cursor position.
* If you selected `Filter Text` command it opens temp editor with the result.
### Keybindings
It is possible to map specific commands to key bindings. Example usage in `keybindings.json`:
```json
{
"key": "shift+alt+l",
"command": "extension.filterTextInplace",
"args": { "cmd": "sort" }
}
```
### Configuration
Commands can be predefined in the `settings.json` as follows:
```json
"filterText.commandList": [
{
"name": "Sort unique",
"description": "Sorts and find the unique entries",
"command": "sort | uniq"
},
{
"name": "Columnize CSV",
"description": "Columnize comma separated values",
"command": "column -s \",\" -t"
},
{
"name": "XML lint",
"description": "Run the command through xmllint",
"command": "xmllint --format -"
}
]
```
## Changes
* 07/24/2019: v0.0.15 - Predefined commands via settings.json. Add macOS keybinding to fix Delete All Right
* 03/31/2019: v0.0.14 - Fix used document filter flag when false
* 03/16/2019: v0.0.13 - Implemented passing in the command as an argument
* 03/14/2019: v0.0.12 - Improvement: Add option to always use a file's dir as current working
* 08/30/2018: v0.0.11 - Better working directry handling.
* 07/28/2018: v0.0.10 - Better error reporting. In case command exited with failure status, and leave only error messages without stdout, don't change text selection but pop an error message instead. When filter on empty document (zero bytes), need to close stdin to avoid child process reading stdin never terminate (dangling).
* 07/22/2018: v0.0.9 - Added support and settings for using bash's commands or scripts
* 01/25/2018: v0.0.8 - Set current working directory for the command to match the opened directory
* 01/14/2018: v0.0.7 - Set current working directory for the command to match the opened directory
* 12/25/2017: v0.0.6 - Pipe support
* 07/20/2017: v0.0.5 - Make temp buffer a vscode tmp doc instead of system tmp file
* 07/19/2017: v0.0.4 - Allow filter buffer if no selection
* 04/01/2017: v0.0.3 - Added ability to feed result into temp file
* 11/24/2015: v0.0.2 - Changed the keybindg from `Ctrl+Shift+F` to `Ctrl+K Ctrl+F`.
* 11/23/2015: v0.0.1 - Initial release.
## License
[MIT](https://github.com/yhirose/vscode-filtertext/blob/master/LICENSE)