Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Change Log
All notable changes to the "vscode-terminal-capture" extension will be documented in this file.

All notable changes to the "terminal-recorder" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

## [0.1.0]
- Initial release
## [Unreleased]

- Initial release
102 changes: 48 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,71 @@
VSCode - Terminal Capture
=================================================
# terminal-recorder README

As a vim user, one of the features that I truly enjoy is the integrated
terminal and the ability to switch to `Terminal-Normal` and quickly scroll
through the output of my terminal. As such I wanted a quick and easy way
to do something simliar in vscode (including using vi keys to navigate/interact
with the terminal).

The first thing that I tried was using tmux in the terminal and start it by
default when in a vscode environment. While this worked, I didn't like the
flow quite as much. So I decided to try my hand at writing a vscode extension.
This is the README for your extension "terminal-recorder". After writing up a brief description, we recommend including the following sections.

## Features

Take the output from the last active terminal and dump it into a new file.
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.

For example if there is an image subfolder under your extension project workspace:

![Capture using Clipboard](images/vscode-terminal-capture-clipboard.gif)
\!\[feature X\]\(images/feature-x.png\)

There are currently two modes that the extension can run in.
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.

1. clipboard mode
2. caching mode (**alpha** mode)
## Requirements

When using clipboard mode, the extension functions just like a macro where it
quickly runs the following vscode commands.
If you have any requirements or dependencies, add a section describing those and how to install and configure them.

* `workbench.action.terminal.selectAll`
* `workbench.action.terminal.copySelection`
* `workbench.action.terminal.clearSelection`
* `workbench.action.files.newUntitledFile`
* `editor.action.clipboardPasteAction`
## Extension Settings

The caching mode system will track all data entered into the terminal (including
keypresses like backspace) and display all the captured content. Right now this
means that it will display all the special characters including `\b` and `\r`, etc.
This is nice in that it can capture more of the history of how the terminal was run,
however it will also use more memory as it is caching the output for the life of
the terminal.
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.

### Adding a Keybinding
For example:

By default, this extension does not introduce a keybinding as we don't want
to introduce a conflict or other confusion to your workflow. It you would
like to setup this command to a keybinding, here is an example of the json
you can enter in the `keybindings.json` file.
This extension contributes the following settings:

{
"key": "ctrl+t c",
"command": "extension.terminalCapture.runCapture",
"when": "terminalFocus"
}
* `myExtension.enable`: Enable/disable this extension.
* `myExtension.thing`: Set to `blah` to do something.

## Extension Settings
## Known Issues

This extension has a couple of settings depending on the type of usage you would
like to have.
Calling out known issues can help limit users opening duplicate issues against your extension.

* `terminalCaptuer.enable`: enable/disable this extension
* `terminalCapture.useClipboard`: use/disable clipboard copy mode
## Release Notes

This extension has a single command.
Users appreciate release notes as you update your extension.

* **Terminal: Capture Output** - `extension.terminalCapture.runCapture`
### 1.0.0

## Known Issues
Initial release of ...

### 1.0.1

Fixed issue #.

### 1.1.0

Added features X, Y, and Z.

---

## Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)

## Working with Markdown

You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

At this time, it is known that the caching mode will include style characters
in the output. This is to be fixed soon.
* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux).
* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux).
* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets.

### 0.1.0
## For more information

For this version, this is the initial release that supports using the clipboard to
copy content from the terminal to an unamed file.
* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)

The cache mode is partially supported, but does not handle all special characters
correctly. This is currently not the recommended mode.
**Enjoy!**
Loading