OasysAPI IntelliSense

Autocomplete, parameter hints, types, and inline docs for Oasys LS-DYNA Environment JavaScript APIs in VS Code (Primer, D3plot, Reporter, T/HIS).

Works in .js files.

Quick Start: Choose an API from the Status Bar

1. Open a JavaScript file (.js) to activate the extension
2. Click the IntelliSense indicator in the bottom-right corner of VS Code
3. Select your desired API file from the picker:
   • primer.d.ts
   • d3plot.d.ts
   • reporter.d.ts
   • this.d.ts
   • None
4. Optionally click "Change Version..." to switch between v21.1, v22.0 or v23.0

Keyboard Shortcuts

Quickly switch API types while editing JavaScript files:

These shortcuts can be customized via File > Preferences > Keyboard Shortcuts (search for "OasysAPI").

Workspace API mode

The extension supports two workspace API modes:

• Fixed - one API type is used for the whole workspace
• Auto-detect - the API type is chosen per file

Use Fixed if most files in the workspace use the same Oasys API.
Use Auto-detect if the workspace contains a mix of Primer, D3plot, Reporter, or T/his scripts.

In Auto-detect mode, the plugin resolves the API type in this order:

1. File name
   Files ending in .<type>.js or .<type>.mjs take priority
   Examples:

   • myscript.primer.js
   • myscript.d3plot.mjs

2. Special comment
   Add a comment within the first 10 lines:

   // api: primer
   

3. Workspace config
   Add oasysapi.config.json in the workspace root:

   {
     "files": {
       "relative/path/to/file.js": "primer"
     },
     "wildCards": {
       "**/d3plot/**": "d3plot"
     }
   }
   

4. Selected default API
   If no per-file marker is found, the extension falls back to the currently selected API type.

Notes:

• Fixed mode is the simplest and lowest-risk option
• Auto-detect is intended for mixed workspaces and adds more routing logic inside the TS plugin
• File names and comments are usually easier to maintain than large wildcard configs

Workspace Configuration

The extension will check your jsconfig.json file and:

• Create one if it doesn't exist
• Enable JavaScript type checking (checkJs: true)
• Configure the correct library settings
• remove any other .d.ts file includes
• save a backup of your old config as jsconfig.json.old

Icon theme

The extension includes an optional icon theme. To enable it:

1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
2. Search for Preferences: File Icon Theme
3. Select OasysAPI Icons from the list

Files with the .<type>.js naming convention will show custom icons.

Troubleshooting

IntelliSense Not Working?

1. Confirm you're editing a .js file
2. Check the bottom-right status bar: it should show IntelliSense: <apiType> (v2x.x)
3. Click it and select a valid API (not None)
4. If it still doesn’t update, try running TypeScript: Restart TS Server (Command Palette)

Commands

Access these commands from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Settings

This is unlikely to be usful, but the API type and version can be set manually in settings. Additionally, logging can be enabled for troubleshooting.