MaskMeister

MaskMeister is a Visual Studio Code extension that allows you to mask and unmask code by replacing sensitive information with placeholders. This helps protect sensitive data when sharing code snippets with others.

Features

Mask sensitive information in your code
Unmask the code to reveal the original content
Edit the keywords used for masking and unmasking

Usage

Install the MaskMeister extension in Visual Studio Code
Open the file containing the code you want to mask
To mask your code, use one of the following methods:
- Press Ctrl+Shift+P and run the Mask Code command
- Right-click and select Mask Code from the context menu
To unmask your code, use one of the following methods:
- Press Ctrl+Shift+P and run the Unmask Code command
- Right-click and select Unmask Code from the context menu
To edit the keywords used for masking and unmasking:
- Press Ctrl+Shift+P and run the Edit Masked Code Keywords command
- Edit the keywords.json file to add or remove keyword/placeholder pairs

Example Usage

Assume we have a keywords.json file with the following content:

[
  {
    "key": "mySecretPassword",
    "value": "AlteredPasswordSecret",
    "matchType": "exact"
  },
  {
    "key": "anotherSecret",
    "value": "AnotherAlteredSecret",
    "matchType": "partial"
  },
  {
    "key": "yetAnotherSecret",
    "value": "YetAnotherAlteredSecret",
    "matchType": "exact"
  }
]

Let's take the following test sentences:

"My name is Sam and my password is mySecretPassword."
"I am a huge fan of anotherSecret and I talk about it all the time."
"My yetAnotherSecret is that I love chocolate."
"The best part of the day is when I can sit down and write in peace."
"I use the keyword mySecretPassword to access my private files."
"I keep all my important information under anotherSecret."
"Everyone should have a yetAnotherSecret in their lives."

After running the maskCode command, the sentences would be altered as follows.

"My name is Sam and my password is AlteredPasswordSecret." (Exact match of mySecretPassword is replaced)
"I am a huge fan of AnotherAlteredSecret and I talk about it all the time." (All instances of anotherSecret are replaced, even if they are part of another word)
"My YetAnotherAlteredSecret is that I love chocolate." (Exact match of yetAnotherSecret is replaced)
"The best part of the day is when I can sit down and write in peace." (This sentence remains unchanged as it does not contain any keywords)
"I use the keyword AlteredPasswordSecret to access my private files." (Exact match of mySecretPassword is replaced)
"I keep all my important information under AnotherAlteredSecret." (All instances of anotherSecret are replaced, even if they are part of another word)
"Everyone should have a YetAnotherAlteredSecret in their lives." (Exact match of yetAnotherSecret is replaced)

Please remember to replace the text within keywords.json and the sentences with your own content and keywords.

Note: In the example above, the "matchType" parameter is used to control how the keywords are matched. An "exact" match means the keyword is replaced only when it appears exactly as is. A "partial" match means the keyword is replaced even when it is part of another word.

Configuration

You can configure the keywords and the path to the keywords file in your VS Code settings. Open your settings and search for "masked-code" to find the available options.

Add Configuration to User Settings

To add the configuration to your user settings in Visual Studio Code, include the following line:

Press Ctrl+Shift+P and run the user settings (json) command

Add the desired key-value pair using the correct JSON syntax. For example, to add the "maskmeister.keywordsFilePath" setting, you would add the following line:

"maskmeister.keywordsFilePath": "C:\\dev\\keywords.json",

Make sure to adjust the file path according to your system's directory structure.

Contributing

If you'd like to contribute to MaskMeister, please submit issues or pull requests on the GitHub repository.

License

MIT License

henrikroschmann/MaskMeister