eslint-plugin-sfmc 3.0.0 → 4.0.1

package/src/index.js

@@ -15,6 +15,7 @@ import * as handlebarsParser from './handlebars-parser.js';
 // ── AMPscript rules ───────────────────────────────────────────────────────────
 
 import ampNoUnknownFunction from './rules/amp/no-unknown-function.js';
+import ampNoMcnUnsupported from './rules/amp/no-mcn-unsupported.js';
 import ampNoVariableRedeclaration from './rules/amp/no-variable-redeclaration.js';
 import ampSetRequiresTarget from './rules/amp/set-requires-target.js';
 import ampNoEmptyBlock from './rules/amp/no-empty-block.js';
@@ -40,6 +41,7 @@ import ampNoNestedAmpscriptDelimiter from './rules/amp/no-nested-ampscript-delim
 import ssjsRequirePlatformLoad from './rules/ssjs/require-platform-load.js';
 import ssjsNoUnsupportedSyntax from './rules/ssjs/no-unsupported-syntax.js';
 import ssjsNoUnknownFunction from './rules/ssjs/no-unknown-function.js';
+import ssjsNoMcnUnsupported from './rules/ssjs/no-mcn-unsupported.js';
 import ssjsNoDeprecatedFunction from './rules/ssjs/no-deprecated-function.js';
 import ssjsNoPropertyCall from './rules/ssjs/no-property-call.js';
 import ssjsPlatformFunctionArity from './rules/ssjs/platform-function-arity.js';
@@ -58,7 +60,7 @@ import ssjsCoreMethodArity from './rules/ssjs/ssjs-core-method-arity.js';
 // ── Handlebars (MCN) rules ──────────────────────────────────────────────────────
 
 import hbsNoUnknownHelper from './rules/hbs/no-unknown-helper.js';
-import hbsHelperTooNewForTarget from './rules/hbs/helper-too-new-for-target.js';
+import hbsNoMcnUnsupported from './rules/hbs/no-mcn-unsupported.js';
 import hbsNoUnknownBinding from './rules/hbs/no-unknown-binding.js';
 import hbsHelperArity from './rules/hbs/helper-arity.js';
 import hbsNoUnsupportedConstruct from './rules/hbs/no-unsupported-construct.js';
@@ -83,6 +85,7 @@ const plugin = {
     rules: {
         // AMPscript rules (amp- prefix)
         'amp-no-unknown-function': ampNoUnknownFunction,
+        'amp-no-mcn-unsupported': ampNoMcnUnsupported,
         'amp-no-var-redeclaration': ampNoVariableRedeclaration,
         'amp-set-requires-target': ampSetRequiresTarget,
         'amp-no-empty-block': ampNoEmptyBlock,
@@ -107,6 +110,7 @@ const plugin = {
         'ssjs-require-platform-load': ssjsRequirePlatformLoad,
         'ssjs-no-unsupported-syntax': ssjsNoUnsupportedSyntax,
         'ssjs-no-unknown-function': ssjsNoUnknownFunction,
+        'ssjs-no-mcn-unsupported': ssjsNoMcnUnsupported,
         'ssjs-no-deprecated-function': ssjsNoDeprecatedFunction,
         'ssjs-no-property-call': ssjsNoPropertyCall,
         'ssjs-platform-function-arity': ssjsPlatformFunctionArity,
@@ -124,7 +128,7 @@ const plugin = {
 
         // Handlebars (MCN) rules (hbs- prefix)
         'hbs-no-unknown-helper': hbsNoUnknownHelper,
-        'hbs-helper-too-new-for-target': hbsHelperTooNewForTarget,
+        'hbs-no-mcn-unsupported': hbsNoMcnUnsupported,
         'hbs-no-unknown-binding': hbsNoUnknownBinding,
         'hbs-helper-arity': hbsHelperArity,
         'hbs-no-unsupported-construct': hbsNoUnsupportedConstruct,
@@ -141,11 +145,13 @@ const plugin = {
 
 /**
  * SSJS rules for MCN targets.
- * All quality rules are disabled — only the presence of SSJS is flagged,
- * because SSJS as a whole must be deleted when targeting Marketing Cloud Next.
+ * All quality rules are disabled — only the presence of SSJS is flagged, via the
+ * dedicated `ssjs-no-mcn-unsupported` rule, because SSJS as a whole must be
+ * deleted when targeting Marketing Cloud Next.
  */
 const ssjsMcnRules = {
-    'sfmc/ssjs-no-unknown-function': ['error', { target: 'next' }],
+    'sfmc/ssjs-no-mcn-unsupported': 'error',
+    'sfmc/ssjs-no-unknown-function': 'off',
     'sfmc/ssjs-require-platform-load': 'off',
     'sfmc/ssjs-no-unsupported-syntax': 'off',
     'sfmc/ssjs-no-deprecated-function': 'off',
@@ -191,7 +197,7 @@ const ampStrictRules = {
     'sfmc/amp-no-unknown-function': 'error',
     'sfmc/amp-no-var-redeclaration': 'error',
     'sfmc/amp-set-requires-target': 'error',
-    'sfmc/amp-no-empty-block': 'error',
+    'sfmc/amp-no-empty-block': 'warn',
     'sfmc/amp-no-smart-quotes': 'error',
     'sfmc/amp-prefer-attribute-value': 'warn',
     'sfmc/amp-no-loop-counter-assign': 'error',
@@ -199,8 +205,8 @@ const ampStrictRules = {
     'sfmc/amp-require-variable-declaration': 'warn',
     'sfmc/amp-function-arity': 'error',
     'sfmc/amp-arg-types': 'error',
-    'sfmc/amp-no-email-excluded-function': ['error', { context: 'email' }],
-    'sfmc/amp-no-deprecated-function': 'error',
+    'sfmc/amp-no-email-excluded-function': 'off',
+    'sfmc/amp-no-deprecated-function': 'warn',
     'sfmc/amp-naming-convention': ['error', { format: 'camelCase' }],
     'sfmc/amp-no-empty-then': 'error',
     'sfmc/amp-require-rowcount-check': 'error',
@@ -244,7 +250,7 @@ const ssjsStrictRules = {
     'sfmc/ssjs-require-hasownproperty': 'error',
     'sfmc/ssjs-require-platform-load-order': 'error',
     'sfmc/ssjs-no-hardcoded-credentials': 'error',
-    'sfmc/ssjs-prefer-platform-load-version': 'error',
+    'sfmc/ssjs-prefer-platform-load-version': 'warn',
     'sfmc/ssjs-no-unavailable-method': 'warn',
     'sfmc/ssjs-prefer-parsejson-safe-arg': 'error',
     'sfmc/ssjs-no-switch-default': 'error',
@@ -266,7 +272,7 @@ const hbsNextRules = {
     'sfmc/hbs-no-unknown-binding': 'error',
     'sfmc/hbs-helper-arity': 'error',
     'sfmc/hbs-no-unsupported-construct': 'error',
-    'sfmc/hbs-helper-too-new-for-target': 'off',
+    'sfmc/hbs-no-mcn-unsupported': 'error',
 };
 
 /**
@@ -279,7 +285,7 @@ const hbsOffRules = {
     'sfmc/hbs-no-unknown-binding': 'off',
     'sfmc/hbs-helper-arity': 'off',
     'sfmc/hbs-no-unsupported-construct': 'off',
-    'sfmc/hbs-helper-too-new-for-target': 'off',
+    'sfmc/hbs-no-mcn-unsupported': 'off',
 };
 
 /** Shared languageOptions for linting virtual `.hbs` files. */
@@ -449,7 +455,7 @@ plugin.configs = {
         files: ['**/*.ampscript', '**/*.amp'],
         rules: {
             ...ampRecommendedRules,
-            'sfmc/amp-no-unknown-function': ['error', { target: 'next' }],
+            'sfmc/amp-no-mcn-unsupported': 'error',
         },
     },
 
@@ -480,7 +486,7 @@ plugin.configs = {
             files: ['**/*.ampscript', '**/*.amp'],
             rules: {
                 ...ampRecommendedRules,
-                'sfmc/amp-no-unknown-function': ['error', { target: 'next' }],
+                'sfmc/amp-no-mcn-unsupported': 'error',
             },
         },
         {
@@ -513,7 +519,7 @@ plugin.configs = {
             files: ['**/*.html/*.amp'],
             rules: {
                 ...ampRecommendedRules,
-                'sfmc/amp-no-unknown-function': ['error', { target: 'next' }],
+                'sfmc/amp-no-mcn-unsupported': 'error',
             },
         },
         {
@@ -548,7 +554,7 @@ plugin.configs = {
             files: ['**/*.ampscript', '**/*.amp'],
             rules: {
                 ...ampStrictRules,
-                'sfmc/amp-no-unknown-function': ['error', { target: 'next' }],
+                'sfmc/amp-no-mcn-unsupported': 'error',
             },
         },
         {
@@ -575,7 +581,7 @@ plugin.configs = {
             files: ['**/*.html/*.amp'],
             rules: {
                 ...ampStrictRules,
-                'sfmc/amp-no-unknown-function': ['error', { target: 'next' }],
+                'sfmc/amp-no-mcn-unsupported': 'error',
             },
         },
         {

package/src/rules/amp/no-mcn-unsupported.js

@@ -0,0 +1,102 @@
+import { functionNames, functionLookup, getMcnApiVersion } from 'ampscript-data';
+
+/**
+ * Flags AMPscript functions that cannot be used when targeting Marketing Cloud
+ * Next, and functions that work in MCN AMPscript but have no Handlebars
+ * equivalent (so they block a Handlebars migration).
+ *
+ * Each function carries an `mcnSince` value = the MCN API version it first
+ * became available in, or `null`/unset when it was never supported in MCN.
+ *
+ * `apiVersion` semantics (shared with the SSJS and Handlebars MCN rules):
+ *   - Not set / null: flag every function whose `mcnSince` is null/unset. Any
+ *     function supported at some point in MCN (numeric `mcnSince`) passes.
+ *   - Set to N: flag everything the null case flags, PLUS everything whose
+ *     `mcnSince` is greater than N (too new for the target). Pass iff
+ *     `mcnSince != null && mcnSince <= N`.
+ *
+ * Unknown-function reporting stays in `amp-no-unknown-function`; this rule only
+ * evaluates functions that exist in the AMPscript catalog.
+ */
+export default {
+    meta: {
+        type: 'problem',
+        docs: {
+            description:
+                'Disallow AMPscript functions that are not available in the targeted Marketing Cloud Next API version',
+            recommended: true,
+        },
+        messages: {
+            notSupportedInMcn: "'{{name}}' is not supported in Marketing Cloud Next.",
+            tooNewForTarget:
+                "'{{name}}' was introduced in Marketing Cloud Next API version {{since}}, which is newer than the targeted version {{target}}.",
+            noHandlebarsEquivalent:
+                "'{{name}}' is supported by Marketing Cloud Next AMPscript but has no Handlebars for Marketing Cloud Next equivalent. It cannot be migrated to a Handlebars helper.",
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    apiVersion: {
+                        type: 'number',
+                        description:
+                            'The targeted Marketing Cloud Next API version (e.g. 65 = Winter \u{2019}26, 67 = Summer \u{2019}26). Functions newer than this are flagged.',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+
+    create(context) {
+        const options = context.options[0] ?? {};
+        const apiVersion = typeof options.apiVersion === 'number' ? options.apiVersion : null;
+
+        return {
+            FunctionCall(node) {
+                const lower = node.name.toLowerCase();
+
+                // Unknown functions are handled by amp-no-unknown-function.
+                if (!functionNames.has(lower)) {
+                    return;
+                }
+
+                const since = getMcnApiVersion(lower);
+
+                // Never supported in MCN → always flag.
+                if (since === null) {
+                    context.report({
+                        node,
+                        messageId: 'notSupportedInMcn',
+                        data: { name: node.name },
+                    });
+                    return;
+                }
+
+                // Supported in MCN but newer than the targeted API version.
+                if (apiVersion !== null && since > apiVersion) {
+                    context.report({
+                        node,
+                        messageId: 'tooNewForTarget',
+                        data: {
+                            name: node.name,
+                            since: String(since),
+                            target: String(apiVersion),
+                        },
+                    });
+                    return;
+                }
+
+                // Works in MCN AMPscript but has no Handlebars counterpart, so it
+                // cannot be migrated to a Handlebars helper.
+                if (functionLookup.get(lower)?.mcnHandlebarsGap === true) {
+                    context.report({
+                        node,
+                        messageId: 'noHandlebarsEquivalent',
+                        data: { name: node.name },
+                    });
+                }
+            },
+        };
+    },
+};

package/src/rules/amp/no-nested-ampscript-delimiter.js

@@ -1,12 +1,16 @@
 // The processor extracts each AMPscript region into its own virtual .amp file,
 // including the outer delimiters (%%[...]/%%] or <script>...</script>).
-// Any %%[ or %%= found INSIDE the outer delimiters is nested and invalid.
-const DELIMITER_RE = /%%\[|%%=/g;
+// Any %%[ or %%= found INSIDE an already-open block is nested and invalid.
+//
+// A raw .amp file may contain several *sibling* blocks (e.g. one %%[...]%% block
+// followed by another). Those are not nested. To distinguish nesting from
+// siblings we scan every open/close token in document order and track depth:
+// an opener is only nested when depth > 0.
+const TOKEN_RE = /%%\[|%%=|\]%%|=%%/g;
 const SCRIPT_TAG_RE = /^[\n]*<script\b/i;
-const BLOCK_OPEN_RE = /^[\n]*(%%\[)/;
-const INLINE_OPEN_RE = /^[\n]*(%%=)/;
-const BLOCK_CLOSE_SUFFIX = ']%%';
-const INLINE_CLOSE_SUFFIX = '=%%';
+
+const OPEN_TOKENS = new Set(['%%[', '%%=']);
+const CLOSE_FOR_OPEN = { '%%[': ']%%', '%%=': '=%%' };
 
 export default {
     meta: {
@@ -25,76 +29,64 @@ export default {
     },
 
     create(context) {
+        const sourceCode = context.sourceCode;
+
+        const reportNested = (text, match, isScriptBlock) => {
+            const delimiter = match[0];
+            const start = match.index;
+            const end = start + delimiter.length;
+            const closeToken = CLOSE_FOR_OPEN[delimiter];
+            const closeIndex = text.indexOf(closeToken, end);
+
+            context.report({
+                loc: {
+                    start: sourceCode.getLocFromIndex(start),
+                    end: sourceCode.getLocFromIndex(end),
+                },
+                messageId: isScriptBlock ? 'nestedDelimiterInScript' : 'nestedDelimiter',
+                data: { delimiter },
+                fix:
+                    closeIndex === -1
+                        ? (fixer) => fixer.removeRange([start, end])
+                        : (fixer) => [
+                              fixer.removeRange([closeIndex, closeIndex + closeToken.length]),
+                              fixer.removeRange([start, end]),
+                          ],
+            });
+        };
+
         return {
             Program() {
-                const sourceCode = context.sourceCode;
                 const text = sourceCode.getText();
                 const isScriptBlock = SCRIPT_TAG_RE.test(text);
 
-                // For %%[...]%% and %%=...=%% blocks the processor includes the outer
-                // delimiters. Record their positions so we can skip the outermost ones.
-                let outerOpenStart = -1;
-                let outerCloseStart = -1;
-                let outerCloseSuffix = BLOCK_CLOSE_SUFFIX;
-
-                if (!isScriptBlock) {
-                    const blockOpenMatch = BLOCK_OPEN_RE.exec(text);
-                    const inlineOpenMatch = INLINE_OPEN_RE.exec(text);
-
-                    if (blockOpenMatch) {
-                        outerOpenStart = blockOpenMatch.index + blockOpenMatch[0].length - 3;
-                        outerCloseSuffix = BLOCK_CLOSE_SUFFIX;
-                    } else if (inlineOpenMatch) {
-                        outerOpenStart = inlineOpenMatch.index + inlineOpenMatch[0].length - 3;
-                        outerCloseSuffix = INLINE_CLOSE_SUFFIX;
-                    }
-
-                    // The outer close is the last occurrence of the matching close token
-                    const lastClose = text.lastIndexOf(outerCloseSuffix);
-                    if (lastClose !== -1) {
-                        outerCloseStart = lastClose;
+                if (isScriptBlock) {
+                    // Inside a <script language="ampscript"> block the whole body is
+                    // already AMPscript; every %%[ / %%= delimiter is redundant.
+                    TOKEN_RE.lastIndex = 0;
+                    let match;
+                    while ((match = TOKEN_RE.exec(text)) !== null) {
+                        if (OPEN_TOKENS.has(match[0])) {
+                            reportNested(text, match, true);
+                        }
                     }
+                    return;
                 }
 
-                DELIMITER_RE.lastIndex = 0;
+                // Depth-based scan for raw %%[...]%% / %%=...=%% content. Sibling blocks
+                // return depth to 0 between them, so their openers are not flagged.
+                let depth = 0;
+                TOKEN_RE.lastIndex = 0;
                 let match;
-                while ((match = DELIMITER_RE.exec(text)) !== null) {
-                    const delimiter = match[0];
-                    const start = match.index;
-
-                    // Skip the outermost %%[ opener (it is the block wrapper, not nested)
-                    if (!isScriptBlock && start === outerOpenStart) {
-                        continue;
+                while ((match = TOKEN_RE.exec(text)) !== null) {
+                    if (OPEN_TOKENS.has(match[0])) {
+                        if (depth > 0) {
+                            reportNested(text, match, false);
+                        }
+                        depth++;
+                    } else {
+                        depth = Math.max(0, depth - 1);
                     }
-
-                    const end = start + delimiter.length;
-                    const closeToken = delimiter === '%%[' ? ']%%' : '=%%';
-
-                    // Find the matching close token for the fix (first occurrence after this open)
-                    let closeIndex = text.indexOf(closeToken, end);
-                    // Don't use the outer ]%% as the fix target for an inner %%[
-                    if (!isScriptBlock && closeIndex === outerCloseStart) {
-                        closeIndex = -1;
-                    }
-
-                    context.report({
-                        loc: {
-                            start: sourceCode.getLocFromIndex(start),
-                            end: sourceCode.getLocFromIndex(end),
-                        },
-                        messageId: isScriptBlock ? 'nestedDelimiterInScript' : 'nestedDelimiter',
-                        data: { delimiter },
-                        fix:
-                            closeIndex === -1
-                                ? (fixer) => fixer.removeRange([start, end])
-                                : (fixer) => [
-                                      fixer.removeRange([
-                                          closeIndex,
-                                          closeIndex + closeToken.length,
-                                      ]),
-                                      fixer.removeRange([start, end]),
-                                  ],
-                    });
                 }
             },
         };

package/src/rules/amp/no-smart-quotes.js

@@ -1,4 +1,4 @@
-const SMART_QUOTE_RE = /[\u{2018}\u{2019}\u{201C}\u{201D}\u{201A}\u{201E}\u{2039}\u{203A}]/u;
+const SMART_QUOTE_RE = /[\u{2018}\u{2019}\u{201C}\u{201D}\u{201A}\u{201E}\u{2039}\u{203A}]/gu;
 
 const SMART_QUOTES = {
     '\u{2018}': 'left single curly quote \u{2018}',
@@ -30,7 +30,7 @@ export default {
         fixable: 'code',
         docs: {
             description:
-                'Disallow smart/curly quotes in string literals (AMPscript requires ASCII quotes)',
+                'Disallow smart/curly quotes in AMPscript (AMPscript requires ASCII quotes)',
             recommended: true,
         },
         messages: {
@@ -41,36 +41,30 @@ export default {
     },
 
     create(context) {
+        const sourceCode = context.sourceCode;
+
         return {
-            StringLiteral(node) {
-                if (SMART_QUOTE_RE.test(node.value)) {
-                    for (const [char, kind] of Object.entries(SMART_QUOTES)) {
-                        if (node.value.includes(char)) {
-                            context.report({
-                                node,
-                                messageId: 'smartQuote',
-                                data: { kind },
-                                fix(fixer) {
-                                    const fixed = node.value.replaceAll(
-                                        /[\u{2018}\u{2019}\u{201C}\u{201D}\u{201A}\u{201E}\u{2039}\u{203A}]/gu,
-                                        (c) => SMART_TO_ASCII[c],
-                                    );
-                                    const q = node.quote;
-                                    // If the replacement introduces the outer delimiter, try switching quotes.
-                                    if (fixed.includes(q)) {
-                                        const other = q === '"' ? "'" : '"';
-                                        if (!fixed.includes(other)) {
-                                            return fixer.replaceText(node, other + fixed + other);
-                                        }
-                                        // Both quote chars present — cannot safely auto-fix.
-                                        return null;
-                                    }
-                                    return fixer.replaceText(node, q + fixed + q);
-                                },
-                            });
-                            return;
-                        }
-                    }
+            // The AMPscript parser tokenizes string literals as RAW + IDENTIFIER
+            // tokens rather than a StringLiteral node, so a node listener never
+            // matches. Scan the virtual .amp region's raw text instead — the whole
+            // extracted file is AMPscript, mirroring the LSP smart-quote check.
+            Program() {
+                const text = sourceCode.getText();
+                SMART_QUOTE_RE.lastIndex = 0;
+                let match;
+                while ((match = SMART_QUOTE_RE.exec(text)) !== null) {
+                    const char = match[0];
+                    const start = match.index;
+                    const end = start + char.length;
+                    context.report({
+                        loc: {
+                            start: sourceCode.getLocFromIndex(start),
+                            end: sourceCode.getLocFromIndex(end),
+                        },
+                        messageId: 'smartQuote',
+                        data: { kind: SMART_QUOTES[char] },
+                        fix: (fixer) => fixer.replaceTextRange([start, end], SMART_TO_ASCII[char]),
+                    });
                 }
             },
         };

package/src/rules/amp/no-unknown-function.js

@@ -1,4 +1,4 @@
-import { functionNames, functionLookup, isMcnSupported } from 'ampscript-data';
+import { functionNames } from 'ampscript-data';
 
 export default {
     meta: {
@@ -11,30 +11,11 @@ export default {
         messages: {
             unknownFunction:
                 "'{{name}}' is not a recognized AMPscript function. AMPscript does not support custom functions.",
-            notSupportedInMcn: "'{{name}}' is not supported in Marketing Cloud Next.",
-            noHandlebarsEquivalent:
-                "'{{name}}' is supported by Marketing Cloud Next AMPscript but has no Handlebars for Marketing Cloud Next equivalent. It cannot be migrated to a Handlebars helper.",
         },
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    target: {
-                        type: 'string',
-                        enum: ['engagement', 'next'],
-                        description:
-                            "Target platform. Set to 'next' to additionally flag functions not available in Marketing Cloud Next.",
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
+        schema: [],
     },
 
     create(context) {
-        const options = context.options[0] ?? {};
-        const isTargetNext = options.target === 'next';
-
         return {
             FunctionCall(node) {
                 const lower = node.name.toLowerCase();
@@ -45,26 +26,6 @@ export default {
                         messageId: 'unknownFunction',
                         data: { name: node.name },
                     });
-                    return;
-                }
-
-                if (isTargetNext && !isMcnSupported(lower)) {
-                    context.report({
-                        node,
-                        messageId: 'notSupportedInMcn',
-                        data: { name: node.name },
-                    });
-                    return;
-                }
-
-                // Category C: the function works in MCN AMPscript but has no
-                // Handlebars counterpart, so it cannot be migrated to Handlebars.
-                if (isTargetNext && functionLookup.get(lower)?.mcnHandlebarsGap === true) {
-                    context.report({
-                        node,
-                        messageId: 'noHandlebarsEquivalent',
-                        data: { name: node.name },
-                    });
                 }
             },
         };