https://github.com/fcrespo82/vscode-secretlens
https://github.com/fcrespo82/vscode-secretlens
open-vsx openvsx visual-studio-code visual-studio-code-extension vscode vscode-extension
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fcrespo82/vscode-secretlens
- Owner: fcrespo82
- Created: 2016-12-01T21:24:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T19:54:42.000Z (over 2 years ago)
- Last Synced: 2024-05-02T01:34:07.694Z (about 2 years ago)
- Topics: open-vsx, openvsx, visual-studio-code, visual-studio-code-extension, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=fcrespo82.secretlens
- Size: 849 KB
- Stars: 8
- Watchers: 4
- Forks: 6
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# SecretLens
- - -
**WARNING**
Version 2.0.0 breaks compatibility with current encrypted messages **unless** you follow the steps described in [Keep the previous behavior](#keep-the-previous-behavior)
- - -
A CodeLens/Hover provider that automatically decrypts identified text and show as a CodeLens/Hover.
## What does this extension do?
Encrypt/decrypt text within the file.
### How?
Encrypting accepts your selection, or hole line if no selection, encrypts it and replaces with the fenced block `${token}${endToken}` (token/endToken are configurable)
Decrypting search for the fenced block and then replaces by the plain text.
The fenced block is the default behavior because of [this limitation](https://github.com/fcrespo82/vscode-secretlens/issues/2).
#### Keep the previous behavior
1. Set **Start token** to `secretlens:`
2. Set **End token** to empty string or `null`
3. Set **Exclude end fence** option to `true`
## Extension Commands
| Command | Description |
|:--------------------|:-------------------------------------------------------------------------------|
| **Encrypt** | Encrypt the text and replaces with `${token}${endToken}` |
| **Decrypt** | Decrypt the fenced block and replaces with `` |
| **Set password** | Set a new password |
| **Forget password** | Clears the current password |
| **Copy secret** | Copy the selected secrets decrypted to clipboard separated by *Copy separator* |
## Extension Settings
| Setting | Description | Default Value |
|:-------------------------|:--------------------------------------------------------------------------------|:-----------------------------:|
| **Display Type** | How to display the secret: CodeLens, Hover or both | CodeLens |
| **Start token** | Token for identifying the begining of encrypted text | `` |
| **Exclude end fence** | Exclude the end fence when encrypting texts | false |
| **Language identifiers** | Languages in which SecretLens will run | ALL |
| **Copy separator** | Separator for when copying multiple secrets | `\n` |
| **Remember period** | How many seconds the password will be remembered before being erased from cache | -1 (forever) |
| **Recursive** | Go inside subdirectories to encrypt/decrypt files | false |
| **Crypto method** | How the secrets are encrypted | Default legacy implementation |
- - -
If you like this extension, please consider [donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6H283FQKCUB9G) and/or take a moment to [write a review](https://marketplace.visualstudio.com/items?itemName=fcrespo82.secretlens#review-details) and share on Facebook or Twitter
