script-type.md

suitescript/script-type

Enforces valid @NScriptType tag values in the header block comment of every SuiteScript file.

Does not report missing @NScriptType tags.

Rule Details

Valid tag values are found below.

✅ Using one of these values, the following pattern is correct:

/* eslint suitescript/script-type: "error" */

/**
 * @NScriptType [value]
 */

❌ The following patterns are incorrect:

/* eslint suitescript/script-type: "error" */

/**
 * @NScriptType
 */

/* eslint suitescript/script-type: "error" */

/**
 * @NScriptTypeSuitelet
 */

/* eslint suitescript/script-type: "error" */

/**
 * @NScriptType Client
 */

Script Types

• BundleInstallationScript
• ClientScript
• MapReduceScript
• MassUpdateScript
• Portlet
• Restlet
• ScheduledScript
• SDFInstallationScript
• Suitelet
• UserEventScript
• WorkflowActionScript
• bankConnectivityPlugin
• datasetbuilderplugin
• fiConnectivityPlugin
• fiParserPlugin
• workbookbuilderplugin
• plugintypeimpl

Version

This rule was introduced in version 1.0.0.

Source

• Rule source