Skip to content
Cory Smith edited this page Aug 22, 2022 · 1 revision

Contribute

Prerequisites

  1. NPM: https://nodejs.org/en/download/ or https://nodejs.dev/learn/how-to-install-nodejs
  2. Typescript: npm install -g typescript
  3. VSCode Types: npm install -g --save @types/vscode
  4. NodeJS Types: npm install -g --save @types/node
  5. To get Node:FS to compile npm i --save-dev @types/node
  6. For the linter npm install vscode-languageserver

How to edit & debug.

  1. Download the source to a folder
  2. Open VS Code an open the downloaded folder from step 1
  3. Run npm install -g vsce in the terminal (if you don't your changes won't get applied)
  4. Press F5 -- A new VS code window will open
  5. In the new VS Code window open a QB64 file
  6. This new VS Code window will have the QB64 extension enabled
  7. Open settings and change the path to your QB64.exe: qb64.compilerPath
    • Note on Windows need to use \\ for path separators
      • Example: "qb64.compilerPath": "c:\\QB64\\qb64.exe"
      • This has been updated to work with '/' in windows (as of v0.2.0).
    • Linux and Mac OS should use / for path separators
  8. The launch.json & extensions.json are now auto created.
    -- The files are not overwritten so any custom changes are safe.
  9. The extension is now always rebuilt when debugging.
  • The syntax settings are in the file syntaxes\qb64.Language.json
  • The build tasks are in tasks folder

How to Build

  1. Open VS Code and add the folder from this project to the workspace
  2. Open a terminal window in VS Code
  3. Run npm install -g vsce from the terminal window (if not already installed)
  4. Run npm i vscode-debugadapter from the terminal window (if not already installed)
  5. Run vsce package from the terminal window
  6. Right click the qb64*.vsix extension file and choose Install Extension
  7. The project install will be placed in root of this project

Where's What?

Syntax Highlighting

The syntax settings can be found in /syntaxes/qb64.tmLanguage.json.

Build Tasks

The build tasks are in /tasks folder.

Clone this wiki locally