Skip to content

Extension settings

Josh Tynjala edited this page Nov 18, 2019 · 38 revisions

To configure the ActionScript & MXML extension for Visual Studio Code, open the File menu (On macOS, open the Code application menu) and go to PreferencesWorkspace Settings.

Alternatively, you may manually create a file named settings.json inside your workspace's .vscode/ directory (you'll need to create this directory, if it doesn't exist in your workspace yet).

Settings

as3mxml.sdk.framework

Specifies the folder path of the ActionScript SDK used by the current workspace. Supports the Adobe AIR SDK & Compiler, Apache Royale, the classic Apache Flex or Adobe Flex SDKs, and the Feathers SDK.

{
	"as3mxml.sdk.framework": "/path/to/sdk"
}

This setting may also be customized by clicking the name of the currently selected SDK in the status bar to open the SDK picker.

as3mxml.sdk.searchPaths

Specifies a folder path containing one or more SDKs to add as custom options in the SDK picker.

{
	"as3mxml.sdk.searchPaths": "/path/to/custom/sdks"
}

Alternatively, you can use an array of paths, if you happen store SDKs in more than one location:

{
	"as3mxml.sdk.searchPaths": [
		"/path/to/custom/sdks",
		"/more/custom/sdks"
	]
}

as3mxml.asconfigc.useBundled

(Advanced) Indicates if the extension will use the bundled version of asconfigc or a different version that is installed on the system path. Defaults to true.

If you have the npm version of asconfigc installed globally, and you'd prefer to use that version of the program instead of the version that is bundled with the extension, change the value of this setting to false.

{
	"as3mxml.asconfigc.useBundled": false
}

as3mxml.asconfigc.verboseOutput

(Advanced) Specifies whether asconfigc will display more detailed output during builds. Displays command line options passed to tools, like the compiler and the Adobe AIR packager, lists the files copied to the output folder, and more.

{
	"as3mxml.asconfigc.verboseOutput": true
}

as3mxml.asconfigc.jvmargs

(Advanced) Specifies extra arguments that asconfigc will pass to the Java virtual machine when running Java programs.

The following example customize the Java memory heap size:

{
	"as3mxml.asconfigc.jvmargs": "-Xms512m -Xmx1024m"
}

as3mxml.java.path

(Advanced) If the extension cannot find Java automatically, this setting may be used to specify the exact path to the java executable that the extension should use (Note: it must be an executable, and not directory).

On macOS or Linux, you might specify a path like this:

{
	"as3mxml.java.path": "/usr/bin/java"
}

On Windows, you should specify the path to java.exe (the exact path may be different on your system):

{
	"as3mxml.java.path": "c:\\Program Files\\Java\\jre1.8.0_131\\bin\\java.exe"
}

as3mxml.sdk.editor

(Advanced) Specifies the folder path of the Apache Royale SDK used internally by the extension to provide code intelligence features. Unless you know what you're doing, you should probably set as3mxml.sdk.framework instead.

{
	"as3mxml.sdk.editor": "/path/to/sdk"
}

If you are working on a project that uses a nightly build of Apache Royale, you may be required to specify the as3mxml.sdk.editor setting to avoid compiler errors. Sometimes, new versions of Royale add new compiler options that older versions of compiler may not recognize.

Clone this wiki locally