|
| Style | Example Output | Best Use Case |
|---|---|---|
| Standard | PATH: src/app.ts REPO: user/repo (ref: a1b2c) CONTEXT: Auth > Login [L10-L15] |
Detailed documentation or internal notes. |
| GitHubLink | https://github.com/user/repo/blob/a1b2c/src/app.ts#L10-L15 Auth > Login |
Code reviews or Slack/Jira comments. |
| Minimalist | user/repo (a1b2c) :: src/app.ts :: Auth > Login (L10-L15) |
Quick references that fit on a single line. |
smart-vscode-copy.includeGitInfo
- Type:
boolean - Default:
true - Description: Toggle to include or exclude the Repository URL and Commit Hash. If no Git repository is detected, no repository information is shown.
📦 Installation
Option 1: VS Code Marketplace (Recommended)
- Open VS Code.
- Go to the Extensions view by clicking the square icon on the left sidebar or pressing
Ctrl+Shift+X(Cmd+Shift+Xon macOS). - Search for "smart-vscode-copy".
- Click Install.
Option 2: Manual Installation (.vsix)
If you prefer to install the extension manually or are using a pre-release version:
- Download the latest
.vsixfile from the Releases page. - In VS Code, open the Extensions view.
- Click the "..." (More Actions) menu in the top-right corner of the Extensions bar.
- Select Install from VSIX... and choose the file you downloaded.
Requirements
- VSCode ^=1.110.0
- vscode.git: Must be enabled to fetch repo/commit data.
- Language Extensions: To see class/method/function names in the "context" field. Ensure you have the relevant Language Server installed. (e.g.,
rust-analyzerfor Rust,Haskellfor Haskell,Pyrightfor Python)
🛠️ Known Issues
- If no symbols are found in the file, the CONTEXT field will show line numbers only.
📔 Release Notes
Users appreciate release notes as you update your extension.
1.0.0
- Initial release.
- Support for "Simple" (Metadata only) and "Code Block" (Markdown block) references.
- Automatic Git repository and commit detection.
- Context-aware symbol detection for nested functions and classes.
✉️ Support
I'm happy to hear your thoughts or feature suggestions!
Maintainer: Sam Lloyd-Williams Email: samlloydw+referencevscode@gmail.com