/vscode-tracy-csv-converter

A CSV converter example for Tracy

Primary LanguageTypeScriptMIT LicenseMIT

Tracy CSV converter

A utility to read, merge, and slice log files for subsequent analysis in Tracy.

PS. To create your own converter for Tracy, press "Use this template" (above) -> "Create a new repository" and adapt src/converters.ts.

Installation

To install in Visual Studio Code:

  1. Obtain the plugin .vsix file:
    • If you want to install the latest release, go to the Latest release and download the vscode-tracy-csv-converter-X.X.X.vsix file under Assests.
    • If you want to install a specific commit, click on the ✔️ next to the commit -> Details -> Summary -> under Artifacts, vscode-vsix and extract the downloaded vscode-vsix.zip.
  2. Open Visual Studio Code, in the side bar go to Extensions -> ··· (right top) -> Install from VSIX... -> open the downloaded vscode-tracy-csv-converter-X.X.X.vsix.
  3. To test, download the example, extract the zip and open it with Vistual Studio Code. Press "Help" (top bar) -> "Show All Commands" (or CTRL + SHIFT + P). Now there are two extra options.
    1. Search for "Tracy CSV converter: open current document with Tracy". Press enter and select "Using standard converter". Tracy will now open.
    2. Search for "Tracy CSV converter: open multiple documents with Tracy". A new view will appear, where you can add files using a file selection dialog. Press "Merge & Open" to open Tracy.
  4. If you want to upgrade Tracy in the future, repeat the instructions above.

Developing

To develop Tracy CSV converter:

  1. Make sure that Node.js (version 18+ recommended) and Git are installed.
  2. Execute: 
    # Clone the repository
git clone https://github.com/TNO/vscode-tracy-csv-converter.git
cd vscode-tracy-csv-converter
# Install dependencies
npm ci 
# Open the repository in Visual Studio Code
code .
  3. In Vistual Studio Code, go to Run (menu bar) -> Start Debugging. A new Visual Studio Code instance (Extension Development Host) will be started with Tracy CSV converter installed. To apply any code changes go to Run (menu bar) -> Restart Debugging.
  4. Code changes to the UI can be watched using npm run watch-viewer.
  5. Linting is done via npx eslint src.

Creating a new release

To create a new release, go to the CI GitHub action -> Run workflow -> adjust type accordingly -> Run workflow. Wait till build completes and add the release notes.