@brandlab-digital/eslint-plugin 0.1.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+type ReportDescriptor = {
+    node: unknown;
+    messageId?: string;
+    message?: string;
+};
+type RuleContext = {
+    getFilename?: () => string;
+    report: (descriptor: ReportDescriptor) => void;
+};
+type Visitor = Record<string, (node: unknown) => void>;
+type RuleModule = {
+    meta: {
+        type: 'problem';
+        docs: {
+            description: string;
+            recommended: boolean;
+        };
+        messages: Record<string, string>;
+        schema: [];
+    };
+    create: (context: RuleContext) => Visitor;
+};
+export declare const rules: {
+    'no-legacy-analytics-events': RuleModule;
+    'no-raw-json-ld': RuleModule;
+    'no-allow-indexing-true': RuleModule;
+    'no-unsafe-rich-text-sinks': RuleModule;
+};
+type BrandlabPlugin = {
+    rules: typeof rules;
+    configs: {
+        recommended: {
+            plugins: {
+                brandlab: unknown;
+            };
+            rules: Record<string, 'error'>;
+        };
+    };
+};
+declare const plugin: BrandlabPlugin;
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE,MAAM,MAAM,CAAA;IAC1B,MAAM,EAAE,CAAC,UAAU,EAAE,gBAAgB,KAAK,IAAI,CAAA;CAC/C,CAAA;AAED,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC,CAAA;AAEtD,KAAK,UAAU,GAAG;IAChB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS,CAAA;QACf,IAAI,EAAE;YACJ,WAAW,EAAE,MAAM,CAAA;YACnB,WAAW,EAAE,OAAO,CAAA;SACrB,CAAA;QACD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAChC,MAAM,EAAE,EAAE,CAAA;KACX,CAAA;IACD,MAAM,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,OAAO,CAAA;CAC1C,CAAA;AA+DD,eAAO,MAAM,KAAK;;;;;CA4BoB,CAAA;AAEtC,KAAK,cAAc,GAAG;IACpB,KAAK,EAAE,OAAO,KAAK,CAAA;IACnB,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,QAAQ,EAAE,OAAO,CAAA;aAClB,CAAA;YACD,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAC/B,CAAA;KACF,CAAA;CACF,CAAA;AAED,QAAA,MAAM,MAAM,EAAE,cAeb,CAAA;AAID,eAAe,MAAM,CAAA"}

package/dist/index.js

@@ -0,0 +1,97 @@
+function getNodeText(node) {
+    if (!node || typeof node !== 'object')
+        return null;
+    const record = node;
+    if (record.type === 'Literal' && typeof record.value === 'string') {
+        return record.value;
+    }
+    if (record.type === 'TemplateElement') {
+        const value = record.value;
+        if (value && typeof value === 'object') {
+            const raw = value.raw;
+            return typeof raw === 'string' ? raw : null;
+        }
+    }
+    return null;
+}
+function createTextRule(options) {
+    return {
+        meta: {
+            type: 'problem',
+            docs: {
+                description: options.description,
+                recommended: true,
+            },
+            messages: {
+                [options.messageId]: options.message,
+            },
+            schema: [],
+        },
+        create(context) {
+            function inspect(node) {
+                const text = getNodeText(node);
+                if (text && options.matcher(text, context)) {
+                    context.report({ node, messageId: options.messageId });
+                }
+            }
+            return {
+                Literal: inspect,
+                TemplateElement: inspect,
+            };
+        },
+    };
+}
+const legacyAnalyticsEvents = new Set([
+    'contact_form_submission',
+    'phone_calls',
+    'form_start',
+    'cta_click',
+]);
+export const rules = {
+    'no-legacy-analytics-events': createTextRule({
+        description: 'Disallow retired Brandlab analytics event names.',
+        messageId: 'legacyAnalyticsEvent',
+        message: 'Use the canonical Brandlab lead events: phone_call or contact_form.',
+        matcher: (text) => legacyAnalyticsEvents.has(text),
+    }),
+    'no-raw-json-ld': createTextRule({
+        description: 'Disallow raw JSON-LD scripts outside the shared schema adapter.',
+        messageId: 'rawJsonLd',
+        message: 'Render JSON-LD through the Brandlab SchemaScript adapter.',
+        matcher: (text, context) => {
+            const filename = context.getFilename?.() ?? '';
+            return text === 'application/ld+json' && !filename.endsWith('SchemaScript.tsx');
+        },
+    }),
+    'no-allow-indexing-true': createTextRule({
+        description: 'Disallow ALLOW_INDEXING=true; only ALLOW_INDEXING=1 is supported.',
+        messageId: 'allowIndexingTrue',
+        message: 'Use ALLOW_INDEXING=1 as the only explicit indexing override.',
+        matcher: (text) => text.includes('ALLOW_INDEXING=true') || text === 'true',
+    }),
+    'no-unsafe-rich-text-sinks': createTextRule({
+        description: 'Disallow visible rich text sinks that bypass a sanitizer.',
+        messageId: 'unsafeRichTextSink',
+        message: 'Visible rich text must be sanitizer-backed and tested.',
+        matcher: (text) => text.includes('dangerouslySetInnerHTML') && !text.includes('sanitize'),
+    }),
+};
+const plugin = {
+    rules,
+    configs: {
+        recommended: {
+            plugins: {
+                brandlab: undefined,
+            },
+            rules: {
+                'brandlab/no-legacy-analytics-events': 'error',
+                'brandlab/no-raw-json-ld': 'error',
+                'brandlab/no-allow-indexing-true': 'error',
+                'brandlab/no-unsafe-rich-text-sinks': 'error',
+            },
+        },
+    },
+};
+plugin.configs.recommended.plugins.brandlab = plugin;
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA0BA,SAAS,WAAW,CAAC,IAAa;IAChC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAA;IAClD,MAAM,MAAM,GAAG,IAA+B,CAAA;IAE9C,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAClE,OAAO,MAAM,CAAC,KAAK,CAAA;IACrB,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAC1B,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvC,MAAM,GAAG,GAAI,KAAiC,CAAC,GAAG,CAAA;YAClD,OAAO,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;QAC7C,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,cAAc,CAAC,OAKvB;IACC,OAAO;QACL,IAAI,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,IAAI,EAAE;gBACJ,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,WAAW,EAAE,IAAI;aAClB;YACD,QAAQ,EAAE;gBACR,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO;aACrC;YACD,MAAM,EAAE,EAAE;SACX;QACD,MAAM,CAAC,OAAO;YACZ,SAAS,OAAO,CAAC,IAAa;gBAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAA;gBAE9B,IAAI,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC;oBAC3C,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;gBACxD,CAAC;YACH,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,OAAO;gBAChB,eAAe,EAAE,OAAO;aACzB,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAED,MAAM,qBAAqB,GAAG,IAAI,GAAG,CAAC;IACpC,yBAAyB;IACzB,aAAa;IACb,YAAY;IACZ,WAAW;CACZ,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,4BAA4B,EAAE,cAAc,CAAC;QAC3C,WAAW,EAAE,kDAAkD;QAC/D,SAAS,EAAE,sBAAsB;QACjC,OAAO,EAAE,qEAAqE;QAC9E,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC;KACnD,CAAC;IACF,gBAAgB,EAAE,cAAc,CAAC;QAC/B,WAAW,EAAE,iEAAiE;QAC9E,SAAS,EAAE,WAAW;QACtB,OAAO,EAAE,2DAA2D;QACpE,OAAO,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YACzB,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAA;YAC9C,OAAO,IAAI,KAAK,qBAAqB,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAA;QACjF,CAAC;KACF,CAAC;IACF,wBAAwB,EAAE,cAAc,CAAC;QACvC,WAAW,EAAE,mEAAmE;QAChF,SAAS,EAAE,mBAAmB;QAC9B,OAAO,EAAE,8DAA8D;QACvE,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,IAAI,KAAK,MAAM;KAC3E,CAAC;IACF,2BAA2B,EAAE,cAAc,CAAC;QAC1C,WAAW,EAAE,2DAA2D;QACxE,SAAS,EAAE,oBAAoB;QAC/B,OAAO,EAAE,wDAAwD;QACjE,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC;KAC1F,CAAC;CACkC,CAAA;AActC,MAAM,MAAM,GAAmB;IAC7B,KAAK;IACL,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE;gBACP,QAAQ,EAAE,SAAS;aACpB;YACD,KAAK,EAAE;gBACL,qCAAqC,EAAE,OAAO;gBAC9C,yBAAyB,EAAE,OAAO;gBAClC,iCAAiC,EAAE,OAAO;gBAC1C,oCAAoC,EAAE,OAAO;aAC9C;SACF;KACF;CACF,CAAA;AAED,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAA;AAEpD,eAAe,MAAM,CAAA"}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@brandlab-digital/eslint-plugin",
+  "version": "0.1.0-alpha.0",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  }
+}