eslint-plugin-conventions 4.2.8 → 4.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-conventions",
-  "version": "4.2.8",
+  "version": "4.2.9",
   "description": "ESLint plugin for team code conventions — enforces filename case, magic-number bans, commented-out code, expiring TODOs, and deprecated-API usage.",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -50,7 +50,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@interlace/eslint-devkit": "^1.11.0"
+    "@interlace/eslint-devkit": "^1.12.0"
   },
   "repository": {
     "type": "git",

package/src/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.configs=exports.plugin=exports.rules=void 0;exports.rules={get"no-commented-code"(){return require("./rules/conventions/no-commented-code").noCommentedCode},get"expiring-todo-comments"(){return require("./rules/conventions/expiring-todo-comments").expiringTodoComments},get"prefer-code-point"(){return require("./rules/conventions/prefer-code-point").preferCodePoint},get"prefer-dom-node-text-content"(){return require("./rules/conventions/prefer-dom-node-text-content").preferDomNodeTextContent},get"no-console-spaces"(){return require("./rules/conventions/no-console-spaces").noConsoleSpaces},get"no-deprecated-api"(){return require("./rules/deprecation/no-deprecated-api").noDeprecatedApi},get"prefer-dependency-version-strategy"(){return require("./rules/conventions/prefer-dependency-version-strategy").preferDependencyVersionStrategy},get"filename-case"(){return require("./rules/conventions/filename-case").filenameCase},get"consistent-existence-index-check"(){return require("./rules/conventions/consistent-existence-index-check").consistentExistenceIndexCheck},get"no-json-schema-tags"(){return require("./rules/conventions/no-json-schema-tags").noJsonSchemaTags},get"require-data-testid"(){return require("./rules/conventions/require-data-testid").requireDataTestId},get"utm-taxonomy"(){return require("./rules/conventions/utm-taxonomy").utmTaxonomy},get"no-raw-cross-property-href"(){return require("./rules/conventions/no-raw-cross-property-href").noRawCrossPropertyHref},get"analytics-event-naming"(){return require("./rules/conventions/analytics-event-naming").analyticsEventNaming},get"no-magic-numbers"(){return require("./rules/conventions/no-magic-numbers").noMagicNumbers}};exports.plugin={meta:{name:"eslint-plugin-conventions",version:"4.2.8"},rules:exports.rules};exports.configs={recommended:{plugins:{conventions:exports.plugin},rules:{"conventions/no-commented-code":"warn","conventions/expiring-todo-comments":"warn","conventions/no-deprecated-api":"warn","conventions/utm-taxonomy":"error","conventions/no-raw-cross-property-href":"error","conventions/analytics-event-naming":"error","conventions/no-magic-numbers":"warn"}}};exports.default=exports.plugin;
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.configs=exports.plugin=exports.rules=void 0;exports.rules={get"no-commented-code"(){return require("./rules/conventions/no-commented-code").noCommentedCode},get"expiring-todo-comments"(){return require("./rules/conventions/expiring-todo-comments").expiringTodoComments},get"prefer-code-point"(){return require("./rules/conventions/prefer-code-point").preferCodePoint},get"prefer-dom-node-text-content"(){return require("./rules/conventions/prefer-dom-node-text-content").preferDomNodeTextContent},get"no-console-spaces"(){return require("./rules/conventions/no-console-spaces").noConsoleSpaces},get"no-deprecated-api"(){return require("./rules/deprecation/no-deprecated-api").noDeprecatedApi},get"prefer-dependency-version-strategy"(){return require("./rules/conventions/prefer-dependency-version-strategy").preferDependencyVersionStrategy},get"filename-case"(){return require("./rules/conventions/filename-case").filenameCase},get"consistent-existence-index-check"(){return require("./rules/conventions/consistent-existence-index-check").consistentExistenceIndexCheck},get"no-json-schema-tags"(){return require("./rules/conventions/no-json-schema-tags").noJsonSchemaTags},get"require-data-testid"(){return require("./rules/conventions/require-data-testid").requireDataTestId},get"utm-taxonomy"(){return require("./rules/conventions/utm-taxonomy").utmTaxonomy},get"no-raw-cross-property-href"(){return require("./rules/conventions/no-raw-cross-property-href").noRawCrossPropertyHref},get"analytics-event-naming"(){return require("./rules/conventions/analytics-event-naming").analyticsEventNaming},get"no-magic-numbers"(){return require("./rules/conventions/no-magic-numbers").noMagicNumbers}};exports.plugin={meta:{name:"eslint-plugin-conventions",version:"4.2.9"},rules:exports.rules};exports.configs={recommended:{plugins:{conventions:exports.plugin},rules:{"conventions/no-commented-code":"warn","conventions/expiring-todo-comments":"warn","conventions/no-deprecated-api":"warn","conventions/utm-taxonomy":"error","conventions/no-raw-cross-property-href":"error","conventions/analytics-event-naming":"error","conventions/no-magic-numbers":"warn"}}};exports.default=exports.plugin;

package/src/rules/conventions/analytics-event-naming.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.analyticsEventNaming=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const ACTION_VERBS=["click","submit","view","add","remove","start","end","generate","send","cancel","fail","create","delete","update","invite"].join("|");const EVENT_NAME_RE=new RegExp(`^[a-z][a-z0-9_]*:[a-z][a-z0-9_]*_(${ACTION_VERBS})$|^\\$[a-z_]+$`);exports.analyticsEventNaming=(0,eslint_devkit_1.createRule)({name:"analytics-event-naming",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/analytics-event-naming.md",description:"Analytics event names (track/capture) must follow ANALYTICS_PHILOSOPHY.md principle 4: lowercase snake_case, category:object_action, fixed verb list"},fixable:void 0,hasSuggestions:false,messages:{invalidEventName:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid analytics event name",description:'Event "{{name}}" does not match category:object_action grammar (lowercase snake_case, action from fixed verb list).',severity:"HIGH",fix:"Rename to match `<category>:<object>_<verb>` where verb \u2208 {click, submit, view, add, remove, start, end, generate, send, cancel, fail, create, delete, update, invite}. Vendor reserved events ($pageview, $set, \u2026) are exempt.",documentationLink:"https://github.com/ofri-peretz/eslint/blob/main/ANALYTICS_PHILOSOPHY.md"}),interpolatedEventName:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Interpolated analytics event name",description:"Event names must be static string literals. Template literals create an unbounded catalog (ANALYTICS_PHILOSOPHY.md principle 3).",severity:"HIGH",fix:"Move the dynamic part into an event property: track('category:object_view', { slug }).",documentationLink:"https://github.com/ofri-peretz/eslint/blob/main/ANALYTICS_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function isCaptureLike(node){if(node.callee.type==="MemberExpression"&&node.callee.property.type==="Identifier"&&(node.callee.property.name==="capture"||node.callee.property.name==="track")){return true}if(node.callee.type==="Identifier"&&node.callee.name==="track"){return true}return false}return{CallExpression(node){if(!isCaptureLike(node)||node.arguments.length===0)return;const first=node.arguments[0];if(first.type==="Literal"&&typeof first.value==="string"){if(!EVENT_NAME_RE.test(first.value)){context.report({node:first,messageId:"invalidEventName",data:{name:first.value}})}return}if(first.type==="TemplateLiteral"&&first.expressions.length>0){context.report({node:first,messageId:"interpolatedEventName"})}}}}});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.analyticsEventNaming=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const ACTION_VERBS=["click","submit","view","add","remove","start","end","generate","send","cancel","fail","create","delete","update","invite"].join("|");const EVENT_NAME_RE=new RegExp(`^[a-z][a-z0-9_]*:[a-z][a-z0-9_]*_(${ACTION_VERBS})$|^\\$[a-z_]+$`);exports.analyticsEventNaming=(0,eslint_devkit_1.createRule)({name:"analytics-event-naming",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/analytics-event-naming.md",description:"Analytics event names (track/capture) must follow ANALYTICS_PHILOSOPHY.md principle 4: lowercase snake_case, category:object_action, fixed verb list"},fixable:void 0,hasSuggestions:false,messages:{invalidEventName:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid analytics event name",description:'Event "{{name}}" does not match category:object_action grammar (lowercase snake_case, action from fixed verb list).',severity:"HIGH",fix:"Rename to match `<category>:<object>_<verb>` where verb \u2208 {click, submit, view, add, remove, start, end, generate, send, cancel, fail, create, delete, update, invite}. Vendor reserved events ($pageview, $set, \u2026) are exempt.",documentationLink:"https://github.com/ofri-peretz/interlace/blob/main/docs/philosophies/ANALYTICS_PHILOSOPHY.md"}),interpolatedEventName:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Interpolated analytics event name",description:"Event names must be static string literals. Template literals create an unbounded catalog (ANALYTICS_PHILOSOPHY.md principle 3).",severity:"HIGH",fix:"Move the dynamic part into an event property: track('category:object_view', { slug }).",documentationLink:"https://github.com/ofri-peretz/interlace/blob/main/docs/philosophies/ANALYTICS_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function isCaptureLike(node){if(node.callee.type==="MemberExpression"&&node.callee.property.type==="Identifier"&&(node.callee.property.name==="capture"||node.callee.property.name==="track")){return true}if(node.callee.type==="Identifier"&&node.callee.name==="track"){return true}return false}return{CallExpression(node){if(!isCaptureLike(node)||node.arguments.length===0)return;const first=node.arguments[0];if(first.type==="Literal"&&typeof first.value==="string"){if(!EVENT_NAME_RE.test(first.value)){context.report({node:first,messageId:"invalidEventName",data:{name:first.value}})}return}if(first.type==="TemplateLiteral"&&first.expressions.length>0){context.report({node:first,messageId:"interpolatedEventName"})}}}}});

package/src/rules/conventions/no-raw-cross-property-href.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noRawCrossPropertyHref=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const CROSS_PROPERTY_HOSTS=new Set(["ofriperetz.dev","interlace.tools","eslint.interlace.tools","serverless.interlace.tools","ds.interlace.tools","storybook.interlace.tools"]);exports.noRawCrossPropertyHref=(0,eslint_devkit_1.createRule)({name:"no-raw-cross-property-href",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-raw-cross-property-href.md",description:"Forbid hand-written cross-property hrefs; use buildUtmHref() from lib/utm.ts"},fixable:void 0,hasSuggestions:false,messages:{rawCrossPropertyHref:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Raw cross-property href",description:'href "{{href}}" points to a cross-property surface ({{host}}). Use buildUtmHref() from lib/utm.ts so the link carries UTM and ph_distinct_id.',severity:"HIGH",fix:"Replace with buildUtmHref('{{href}}', { source, medium, campaign, content }).",documentationLink:"https://github.com/ofri-peretz/eslint/blob/main/UTM_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function parseHost(value){if(!/^https?:\/\//i.test(value))return null;try{return new URL(value).hostname.toLowerCase()}catch{return null}}function isCrossPropertyHref(href){const host=parseHost(href);if(!host)return null;if(!CROSS_PROPERTY_HOSTS.has(host))return null;return{host}}return{JSXAttribute(node){if(node.name.type!=="JSXIdentifier"||node.name.name!=="href"||!node.value||node.value.type!=="Literal"||typeof node.value.value!=="string"){return}const result=isCrossPropertyHref(node.value.value);if(!result)return;context.report({node:node.value,messageId:"rawCrossPropertyHref",data:{href:node.value.value,host:result.host}})}}}});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.noRawCrossPropertyHref=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const CROSS_PROPERTY_HOSTS=new Set(["ofriperetz.dev","interlace.tools","eslint.interlace.tools","serverless.interlace.tools","ds.interlace.tools","storybook.interlace.tools"]);exports.noRawCrossPropertyHref=(0,eslint_devkit_1.createRule)({name:"no-raw-cross-property-href",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/no-raw-cross-property-href.md",description:"Forbid hand-written cross-property hrefs; use buildUtmHref() from lib/utm.ts"},fixable:void 0,hasSuggestions:false,messages:{rawCrossPropertyHref:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Raw cross-property href",description:'href "{{href}}" points to a cross-property surface ({{host}}). Use buildUtmHref() from lib/utm.ts so the link carries UTM and ph_distinct_id.',severity:"HIGH",fix:"Replace with buildUtmHref('{{href}}', { source, medium, campaign, content }).",documentationLink:"https://github.com/ofri-peretz/interlace/blob/main/docs/philosophies/UTM_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function parseHost(value){if(!/^https?:\/\//i.test(value))return null;try{return new URL(value).hostname.toLowerCase()}catch{return null}}function isCrossPropertyHref(href){const host=parseHost(href);if(!host)return null;if(!CROSS_PROPERTY_HOSTS.has(host))return null;return{host}}return{JSXAttribute(node){if(node.name.type!=="JSXIdentifier"||node.name.name!=="href"||!node.value||node.value.type!=="Literal"||typeof node.value.value!=="string"){return}const result=isCrossPropertyHref(node.value.value);if(!result)return;context.report({node:node.value,messageId:"rawCrossPropertyHref",data:{href:node.value.value,host:result.host}})}}}});

package/src/rules/conventions/utm-taxonomy.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.utmTaxonomy=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const VALID_UTM_SOURCES=new Set(["ofriperetz_dev","interlace","eslint_docs","serverless_docs","ds","storybook","devto","github","npm","x","linkedin","email"]);const VALID_UTM_MEDIUMS=new Set(["article","blog","docs","landing","social","email","referral","cli"]);const UTM_PARAM_RE=/[?&](utm_source|utm_medium)=([^&#]+)/g;exports.utmTaxonomy=(0,eslint_devkit_1.createRule)({name:"utm-taxonomy",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/utm-taxonomy.md",description:"Validate utm_source and utm_medium values against the fixed taxonomy in UTM_PHILOSOPHY.md"},fixable:void 0,hasSuggestions:false,messages:{invalidUtmSource:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid utm_source",description:'utm_source="{{value}}" is not in the fixed taxonomy. Allowed: {{allowed}}',severity:"HIGH",fix:"Use one of the allowed values, or extend the taxonomy in UTM_PHILOSOPHY.md and this rule together.",documentationLink:"https://github.com/ofri-peretz/eslint/blob/main/UTM_PHILOSOPHY.md"}),invalidUtmMedium:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid utm_medium",description:'utm_medium="{{value}}" is not in the fixed taxonomy. Allowed: {{allowed}}',severity:"HIGH",fix:"Use one of the allowed values, or extend the taxonomy in UTM_PHILOSOPHY.md and this rule together.",documentationLink:"https://github.com/ofri-peretz/eslint/blob/main/UTM_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function checkString(node,value){UTM_PARAM_RE.lastIndex=0;let match;while((match=UTM_PARAM_RE.exec(value))!==null){const[,key,raw]=match;const decoded=decodeURIComponent(raw);if(key==="utm_source"&&!VALID_UTM_SOURCES.has(decoded)){context.report({node,messageId:"invalidUtmSource",data:{value:decoded,allowed:[...VALID_UTM_SOURCES].join(", ")}})}else if(key==="utm_medium"&&!VALID_UTM_MEDIUMS.has(decoded)){context.report({node,messageId:"invalidUtmMedium",data:{value:decoded,allowed:[...VALID_UTM_MEDIUMS].join(", ")}})}}}return{Literal(node){if(typeof node.value==="string"&&node.value.includes("utm_")){checkString(node,node.value)}},TemplateLiteral(node){for(const quasi of node.quasis){if(quasi.value.cooked&&quasi.value.cooked.includes("utm_")){checkString(quasi,quasi.value.cooked)}}}}}});
+"use strict";Object.defineProperty(exports,"__esModule",{value:true});exports.utmTaxonomy=void 0;const eslint_devkit_1=require("@interlace/eslint-devkit");const eslint_devkit_2=require("@interlace/eslint-devkit");const VALID_UTM_SOURCES=new Set(["ofriperetz_dev","interlace","eslint_docs","serverless_docs","ds","storybook","devto","github","npm","x","linkedin","email"]);const VALID_UTM_MEDIUMS=new Set(["article","blog","docs","landing","social","email","referral","cli"]);const UTM_PARAM_RE=/[?&](utm_source|utm_medium)=([^&#]+)/g;exports.utmTaxonomy=(0,eslint_devkit_1.createRule)({name:"utm-taxonomy",meta:{type:"problem",docs:{url:"https://github.com/ofri-peretz/eslint/blob/main/packages/eslint-plugin-conventions/docs/rules/utm-taxonomy.md",description:"Validate utm_source and utm_medium values against the fixed taxonomy in UTM_PHILOSOPHY.md"},fixable:void 0,hasSuggestions:false,messages:{invalidUtmSource:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid utm_source",description:'utm_source="{{value}}" is not in the fixed taxonomy. Allowed: {{allowed}}',severity:"HIGH",fix:"Use one of the allowed values, or extend the taxonomy in UTM_PHILOSOPHY.md and this rule together.",documentationLink:"https://github.com/ofri-peretz/interlace/blob/main/docs/philosophies/UTM_PHILOSOPHY.md"}),invalidUtmMedium:(0,eslint_devkit_2.formatLLMMessage)({icon:eslint_devkit_2.MessageIcons.WARNING,issueName:"Invalid utm_medium",description:'utm_medium="{{value}}" is not in the fixed taxonomy. Allowed: {{allowed}}',severity:"HIGH",fix:"Use one of the allowed values, or extend the taxonomy in UTM_PHILOSOPHY.md and this rule together.",documentationLink:"https://github.com/ofri-peretz/interlace/blob/main/docs/philosophies/UTM_PHILOSOPHY.md"})},schema:[]},defaultOptions:[],create(context){function checkString(node,value){UTM_PARAM_RE.lastIndex=0;let match;while((match=UTM_PARAM_RE.exec(value))!==null){const[,key,raw]=match;const decoded=decodeURIComponent(raw);if(key==="utm_source"&&!VALID_UTM_SOURCES.has(decoded)){context.report({node,messageId:"invalidUtmSource",data:{value:decoded,allowed:[...VALID_UTM_SOURCES].join(", ")}})}else if(key==="utm_medium"&&!VALID_UTM_MEDIUMS.has(decoded)){context.report({node,messageId:"invalidUtmMedium",data:{value:decoded,allowed:[...VALID_UTM_MEDIUMS].join(", ")}})}}}return{Literal(node){if(typeof node.value==="string"&&node.value.includes("utm_")){checkString(node,node.value)}},TemplateLiteral(node){for(const quasi of node.quasis){if(quasi.value.cooked&&quasi.value.cooked.includes("utm_")){checkString(quasi,quasi.value.cooked)}}}}}});