vscode-miva-ide

A comprehensive syntax, autocompletion, and snippet package for Miva Script & MVT. This package will assist developers working within the Miva environment. Either module development with Miva Script, or site development with MVT.

Features

• Syntax highlighting for Miva Script and MVT languages.
• Syntax highlighting for MVT embedded in CSS and MVT embedded in JavaScript (MVTCSS, MVTJS)
• Autocompletion for Miva Script and MVT tags.
• Autocompletion for <mvt:do>/<MvDO> functions with automatic file path injection.
• Goto defintion/peek support for <mvt:do>/<MvDO> functions (requires copy of LSK on your computer).
• Autocompletion for system variables, global variables and local variables with automatic parsing of open files.
• Documentation is displayed inline when hovering over variables, functions and tags.
• Custom tag folding.
• Snippets for common MVT features including custom fields, readytheme and more.
• Function that converts entities => variables and variables => entities.
• Function that calculates the current l.posX variable at your current cursor position.
• Provides warning and error messages and hints users about Miva best practices:
  • Warns user about XSS vulnerabilities by outputting (via entity or mvt:eval) unencoded global variables within their files.
  • Warns users about using toolkit module functions.
  • Warns users about using toolbelt module functions.
  • Throws error about assigning g.null to a new value.
• Automatic error highlighting for Miva Script syntax. Requires the Miva Script Compiler to be installed.

Requirements

Goto Definition Support for Miva Merchant Functions

Enable support for goto function definition by following the steps below. This will allow you to jump to wherever the hovered mvt:do, <MvDO> or [].* funcion is defined within Miva Merchant's Limited Source Kit.

• Download the latest LSK version and save it to your computer.
• Configure the setting LSK.path to point to the downloaded folder.

Extension Settings

Miva IDE contributes the following settings:

Setting	Default	Description
enableTriggerSuggestAfterPaste	false	Enable triggering the suggestion popover after pasting text into a Miva Script or MVT editor.
showChangelogOnUpdate	true	Show CHANGELOG after updating to the latest version.
LSK.path	''	Path to your LSK folder. Used for Goto Definition support.
MVT.enableLegacyElseSnippets	false	Enable legacy <mvt:else> and <mvt:elseif> snippets.
mivaIde.MVT.defaultEncodingForVariableConversions	Entity (e)	The encoding type that will be used when converting a variable to an entity.
mivaIde.MVT.lint.showWarningOnToolkitUsage	true	Show a warning when the 'toolkit' item is referenced within the template.
mivaIde.MVT.lint.showWarningOnToolbeltUsage	true	Show a warning when the 'toolbelt' item is referenced within the template.
mivaIde.MVT.lint.showWarningForUnencodedVariables	true	Show a warning when unencoded entities and 'evals' are referenced within the file.
MVT.lint.showErrorForTksl	true	Show an error for the toolkit item's tksl param.
mivaScript.mivaScriptCompiler.enable	true	Enables automatic error reporting for Miva Script files using the Miva Script Compiler. Download the compiler here.
mivaScript.mivaScriptCompiler.disableLSK	true	Disable automatic error reporting for files contained within the configured LSK path.

Integrations

vscode-icons

1. Follow the instructions and identify the location of your custom icons folder.
2. Download the custom icons here.
3. Place the downloaded icons into your custom icon folder.
4. Add the following JSON to your Settings file:

"vsicons.associations.files": [
	{
		"icon": "mivascript",
		"extensions": [
			"mv"
		],
		"languages": [
			{
				"ids": "mv",
				"defaultExtension": "mv"
			}
		],
		"format": "svg"
	},
	{
		"icon": "mvt",
		"extensions": [
			"mvt"
		],
		"languages": [
			{
				"ids": [
					"mvt"
				],
				"defaultExtension": "mvt"
			}
		],
		"filename": true,
		"format": "svg"
	},
	{
		"icon": "mvtjs",
		"extensions": [
			"js/*.mvt"
		],
		"languages": [
			{
				"ids": [
					"mvtjs"
				],
				"defaultExtension": "mvt"
			}
		],
		"format": "svg"
	},
	{
		"icon": "mvtcss",
		"extensions": [
			"css/*.mvt"
		],
		"languages": [
			{
				"ids": [
					"mvtcss"
				],
				"defaultExtension": "mvt"
			}
		],
		"format": "svg"
	}
]

Known Issues

None.

Release Notes

See CHANGELOG.