This is a simple extension to remove a specific LaTeX command (e.g. \revision) from a file or a selection of text.
How to install
Marketplace installation
You can install this extension from the Visual Studio Code marketplace by searching for CleanTeX in the extensions sidebar.
Manual installation
Open the extension sidebar in Visual Studio Code and click on the three dots in the top right corner. Click on Install from VSIX... and select the .vsix file of this extension. This repository is set up to build the extension and upload it as an artifact on every push to the main branch. Therefore, you can go to the Actions tab of this repository and click on the latest workflow run to download a zip folder containing the .vsix file from the artifacts section.
How to use
Usage in the editor
Open a LaTeX file in the editor and make a selection.
Right-click and hover over the CleanTeX submenu in the context menu.
Click on Clean current selection to remove the command from the selected text. You can also wrap the selected text in the LaTeX command by clicking on Wrap current selection.
The command Toggle current selection will remove the command if it is present in the selection and wrap the selection if it is not.
With Replace macros in selection you can replace all macros (that are defined in cleantex.macroPaths) in the selection with their respective definitions.
Important: The extension currently expects that curly braces are used when calling the macros. For example, \macro{arg} will be replaced, but \macro arg will lead to issues.
Usage in the file explorer
Select one or more LaTeX files in the file explorer.
Right-click and hover over the CleanTeX submenu in the context menu.
Click on Clean selected files to remove the command from the selected files.
The command Replace macros in files will replace all macros (that are defined in cleantex.macroPaths) in the selected files with their respective definitions.
Important: The extension currently expects that curly braces are used when calling the macros. For example, \macro{arg} will be replaced, but \macro arg will lead to issues.
Usage with commands
Alternatively, you can use the command palette to search for the commands:
CleanTeX: Clean selected files
CleanTeX: Clean current selection
CleanTeX: Wrap current selection
CleanTeX: Toggle current selection
CleanTeX: replaceMacrosInFiles
CleanTeX: replaceMacrosInSelection
You can also bind the commands to keyboard shortcuts to make them easier to use. Just open the keyboard shortcuts settings in Visual Studio Code and search for the commands above.
Extension Settings
This extension contributes the following settings:
cleantex.command: The LaTeX command to remove from the file or selection of text. Default is revision.
cleantex.mode: If set to unwrap (default) the command is removed but its content is kept. If set to remove the command and its content are removed.
cleantex.makeBackup: Whether to create a backup before cleaning a file (named <filename>.old.<extension>). Default is false.
cleantex.macroPaths: A list of absolute (!) paths to LaTeX files containing the macros to replace. Default is [].
