vscode-line-meta

Makes sharing code locations easier by providing useful editor and repository metadata.

Features

The vscode-line-meta extension makes sharing code locations easier by complementing the usual code screenshot with useful editor (e.g., selected lines, file path, etc.) and repository (e.g., branch, last commit, etc.) metadata.

Features include:

• Generate useful editor and repository metadata
• Select from 3 supported metadata output formats:
  • JSON: all metadata contained in editor and repo sub-objects (e.g., editor.selectedContent, repo.fetchUrl, repo.branch.name, etc.)
  • CSV: simplified metadata of the format <branch>,<file-path>,<selected-lines>
  • Text: like CSV but delimited by |

Usage

• Use the command Get Line Meta to launch the output format menu
• Select an output format
• A new editor tab will open with the metadata in the selected output format
• Edit & share the metadata

Video Demo

Video demonstration available on YouTube.

Requirements

None.

Extension Settings

This extension contributes the following settings:

• vscode-line-meta.enable: enable/disable this extension (TODO)
• vscode-line-meta.csv-delimiter: change the delimiter in meta csv output (TODO)
• vscode-line-meta.text-delimiter: change the delimiter in meta text output (TODO)

Known Issues

None.

Release Notes

See the changelog.

Testing

Install locally:

git clone https://github.com/surajs02/vscode-line-meta.git
cd vscode-line-meta
npm install
npm install -g vsce
vsce package
code --install-extension vscode-line-meta-1.0.0.vsix

Future Plans

• [x] Select between json & text output
• [x] Text fmt:
  • (<branch><git-status>){<commit-hash>}[<file-path>:<selected-lines]
  • <branch>|<file-path>|<selected-lines (chosen)
• [x] Fix no output if no repo
• [x] Fix missing repo data on cmd first run
• [x] Ext icon?
• [x] Ext screenshots?
• [x] Ext gif?
• [ ] Publish?
• [x] Automated tests?
• [x] File logging
• [ ] Custom ext filename with webpack?
• [x] Improve download/performance with bundling?
• [ ] Ext settings?
• [ ] Allow customizing text delimiter?
• [ ] Other output options?
• [ ] Img snapshot of selected code?