Skip to content

Command Line Arguments

Si Dunford edited this page Jan 2, 2022 · 16 revisions

Adding Command Line Arguments to VSCODE

  • From main menu, select File | Preferences > Settings
  • Select "User" tab
  • Expand the section titled "Extensions"
  • Select BlitzMax
  • Scroll down to find the section Lsp:args
  • Click "Edit in settings.json"

Within the settings file, locate the key "blitzmax.lsp.path" and add a new key below it to look something like this:

   "blitzmax.lsp.path": "./bin/bls",
   "blitzmax.lsp.args": [
    "-o:ast", "-o:eol"
    ],

(Don't forget to make sure all the comma's line up)

Settings can also be combined. The above example can also be configured like this:

   "blitzmax.lsp.args": [
    "-o:ast,eol"
    ],

Settings

ARG STATE PURPOSE
-o:ast ✔️ Displays AST instead of Document Symbols in Outline
⚠️ Some nodes incomplete
-o:eol ✔️ Displays EOL nodes in the AST (disabled by default)
-o:notype ⚠️
Experimental
Do not display the node type in Outline.
-o:desc ⚠️
Experimental
Show descriptive Constructor()/Destructor() in Outline

Experimental Features

⚠️ These features are being tested and may contain bugs or be incomplete.

ARG STATE PURPOSE
-x:compl ⚠️
Experimental
Code Completion provider
-x:def ⚠️
Experimental
Definition provider
-x:diag ⚠️
Experimental
Provides diagnostics information
-x:hover ⚠️
Experimental
Hover Provider
-x:sighelp ⚠️
Experimental
Signature Help Provider
-x:wsym ⚠️
Experimental
Provides workspace symbols

Command line

The following command line arguments are designed to be used from a terminal/command prompt:

ARG PURPOSE
--help, -h, /? Show help
--version, -v, /v Show Version
set <key> <value> Update a setting in the configuration file
unset <key>
clear <key>
Reset a setting in the configuration file

set and unset can be used to configure linting rules. For example, to enable rule "xyz" to value 1 you could type the following at the command line:

   bls set linting.xyz 1
Clone this wiki locally