@2digits/eslint-plugin 3.3.0 → 3.4.0

package/dist/index.d.mts

@@ -1,12 +1,7 @@
-import { Linter, Rule } from "eslint";
+import * as _typescript_eslint_utils_ts_eslint0 from "@typescript-eslint/utils/ts-eslint";
 import { FlatConfig } from "@typescript-eslint/utils/ts-eslint";
+import { Linter } from "eslint";
 
-//#region src/utils/index.d.ts
-/** @public */
-interface RuleModule<T extends ReadonlyArray<unknown>> extends Rule.RuleModule {
-  defaultOptions: T;
-}
-//#endregion
 //#region src/index.d.ts
 declare const plugin: {
   meta: {
@@ -14,8 +9,9 @@ declare const plugin: {
     version: string;
   };
   rules: {
-    'if-curly': RuleModule<[]>;
-    'type-param-names': RuleModule<[]>;
+    'if-curly': _typescript_eslint_utils_ts_eslint0.RuleModule<"missingCurly", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
+    'prefer-inline-handlers': _typescript_eslint_utils_ts_eslint0.RuleModule<"preferInlineHandler", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
+    'type-param-names': _typescript_eslint_utils_ts_eslint0.RuleModule<"prefix" | "initial" | "remainder" | "suggestRename", [], unknown, _typescript_eslint_utils_ts_eslint0.RuleListener>;
   };
   configs: {
     recommended: {
@@ -24,6 +20,7 @@ declare const plugin: {
       };
       rules: {
         '@2digits/if-curly': "error";
+        '@2digits/prefer-inline-handlers': "error";
         '@2digits/type-param-names': "error";
       };
     };

package/dist/index.mjs

@@ -1 +1 @@
-import{AST_NODE_TYPES as e,AST_TOKEN_TYPES as t}from"@typescript-eslint/utils";import{P as n,match as r}from"ts-pattern";var i=`3.3.0`,a={type:`git`,url:`git+https://github.com/2digits-agency/configs.git`,directory:`packages/eslint-plugin`};const o={rules:{"@2digits/if-curly":`error`,"@2digits/type-param-names":`error`}},s=`${a.url.replace(`.git`,``).replace(`git+`,``)}/tree/main/${a.directory}/src/rules`;function c(e){return function({name:t,meta:n,...r}){return l({meta:{...n,docs:{...n.docs,url:e(t)}},...r})}}function l({create:e,defaultOptions:t,meta:n}){return{create:(n=>e(n,n.options.map((e,n)=>({...t[n],...e})))),defaultOptions:t,meta:n}}const u=c(e=>`${s}/${e}.ts`),d=u({name:`if-curly`,meta:{type:`layout`,docs:{description:`Require curly braces around if statement bodies`},fixable:`code`,schema:[],messages:{missingCurly:`Expected curly braces around if statement body`}},defaultOptions:[],create(n){let r=n.sourceCode;function i(e){return(r.lines[e.loc.start.line-1]??``).match(/^(\s*)/)?.[1]??``}function a(a,o,s=!1){if(a.type===e.BlockStatement)return;let c=s?r.getTokenBefore(a,e=>e.type===t.Keyword&&e.value===`else`):r.getFirstToken(o);n.report({node:a,loc:c?.loc??a.loc,messageId:`missingCurly`,fix(e){let t=r.getText(a),n=i(a);return e.replaceText(a,`{\n${n}  ${t}\n${n}}`)}})}return{IfStatement(t){a(t.consequent,t,!1),t.alternate&&t.alternate.type!==e.IfStatement&&a(t.alternate,t,!0)}}}}),f=/^(?:\(.*\)|\\?.)$/;function p(e){let t=e.toString();return f.test(t)?t:`(?:${t})`}const m=/^(?:\(\?:(.+)\)|(.+))$/,h=/^(?:\(\?:(.+)\)([?+*]|\{[\d,]+\})?|(.+))$/;function g(e){let t=t=>g(`(?<${t}>${`${e}`.replace(m,`$1$2`)})`);return{toString:()=>e.toString(),and:Object.assign((...t)=>g(`${e}${C(...t)}`),{referenceTo:t=>g(`${e}\\k<${t}>`)}),or:(...t)=>g(`(?:${e}|${t.map(e=>C(e)).join(`|`)})`),after:(...t)=>g(`(?<=${C(...t)})${e}`),before:(...t)=>g(`${e}(?=${C(...t)})`),notAfter:(...t)=>g(`(?<!${C(...t)})${e}`),notBefore:(...t)=>g(`${e}(?!${C(...t)})`),times:Object.assign(t=>g(`${p(e)}{${t}}`),{any:()=>g(`${p(e)}*`),atLeast:t=>g(`${p(e)}{${t},}`),atMost:t=>g(`${p(e)}{0,${t}}`),between:(t,n)=>g(`${p(e)}{${t},${n}}`)}),optionally:()=>g(`${p(e)}?`),as:t,groupedAs:t,grouped:()=>g(`${e}`.replace(h,`($1$3)$2`)),at:{lineStart:()=>g(`^${e}`),lineEnd:()=>g(`${e}$`)}}}const _=/[.*+?^${}()|[\]\\/]/g;function v(e){let t=g(`[${e}]`),n=(t,n)=>v(`${e}${y(t)}-${y(n)}`),r=Object.assign(t=>v(`${e}${y(t)}`),{from:n});return Object.assign(t,{orChar:r,from:n})}function y(e){return e.replace(/[-\\^\]]/g,`\\$&`)}Object.assign(e=>v(y(e)),v(``)),Object.assign(e=>v(`^${y(e)}`),v(`^`));function b(...e){return g(`(?:${e.map(e=>C(e)).join(`|`)})`)}g(`.`),g(`\\b\\w+\\b`),g(`\\w`),g(`\\b`);const x=g(`\\d`);g(`\\s`);const S=Object.assign(g(`[a-zA-Z]`),{lowercase:g(`[a-z]`),uppercase:g(`[A-Z]`)});g(`\\t`),g(`\\n`),g(`\\r`),g(`\\W+`),g(`\\W`),g(`\\B`),g(`\\D`),g(`\\S`),Object.assign(g(`[^a-zA-Z]`),{lowercase:g(`[^a-z]`),uppercase:g(`[^A-Z]`)}),g(`[^\\t]`),g(`[^\\n]`),g(`[^\\r]`);function C(...e){return g(e.map(e=>typeof e==`string`?e.replace(_,`\\$&`):e).join(``))}function w(...e){return g(`${p(C(...e))}+`)}const T=(...e)=>{let t=e.length>1&&(Array.isArray(e[e.length-1])||e[e.length-1]instanceof Set)?e.pop():void 0;return new RegExp(C(...e).toString(),[...t||``].join(``))},E=T(b(`T`,`$`).at.lineStart()),D=T(b(`T`,`$`).at.lineStart(),S.uppercase),O=T(b(`T`,`$`).at.lineStart(),S.uppercase,w(S)),k=T(b(`T`,`$`).at.lineStart(),S.uppercase,w(S),x.times.any().at.lineEnd()),A={prefix:`prefix`,initial:`initial`,remainder:`remainder`,regex:`regex`},j=u({name:`type-param-names`,meta:{type:`suggestion`,docs:{description:`Enforce giving proper names to type parameters when there are two or more`},schema:[],messages:{prefix:`Type parameter {{name}} should have a prefix of "T" or "$"`,initial:`Type parameter {{name}}'s name should start with an uppercase letter`,remainder:`Type parameter {{name}}'s name should contain at least one lowercase letter`,regex:`Type parameter {{name}} should match the regex {{regex}}`}},defaultOptions:[],create(e){return{TSTypeParameterDeclaration(t){let{params:n}=t;if(!(n.length===1&&n.at(0)?.name.name===`T`))for(let t of n){let{name:n}=t.name,r=I(n);r&&e.report({node:t,messageId:r,data:{name:n}})}}}}}),M=n.string.regex(k),N=n.not(n.string.regex(E)),P=n.not(n.string.regex(D)),F=n.not(n.string.regex(O));function I(e){return r(e).with(M,()=>!1).with(N,()=>A.prefix).with(P,()=>A.initial).with(F,()=>A.remainder).otherwise(()=>!1)}const L={meta:{name:`@2digits`,version:i},rules:{"if-curly":d,"type-param-names":j},configs:{recommended:{plugins:{"@2digits":{}},rules:o.rules}}};L.configs.recommended.plugins[`@2digits`]=L;var R=L;export{R as default};
+import{AST_NODE_TYPES as e,AST_TOKEN_TYPES as t,ESLintUtils as n}from"@typescript-eslint/utils";var r=`3.4.0`;const i={rules:{"@2digits/if-curly":`error`,"@2digits/prefer-inline-handlers":`error`,"@2digits/type-param-names":`error`}},a=n.RuleCreator(e=>`https://github.com/2digits-agency/configs/tree/main/packages/eslint-plugin/src/rules/${e}.ts`),o=a({name:`if-curly`,meta:{type:`suggestion`,docs:{description:`Require curly braces around if statement bodies`},fixable:`code`,schema:[],messages:{missingCurly:`Expected curly braces around if statement body`}},defaultOptions:[],create(n){let r=n.sourceCode;function i(e){return(r.lines[e.loc.start.line-1]??``).match(/^(\s*)/)?.[1]??``}function a(a,o,s=!1){if(a.type===e.BlockStatement)return;let c=s?r.getTokenBefore(a,e=>e.type===t.Keyword&&e.value===`else`):r.getFirstToken(o);n.report({node:a,loc:c?.loc??a.loc,messageId:`missingCurly`,fix(e){let t=r.getText(a),n=i(a);return e.replaceText(a,`{\n${n}  ${t}\n${n}}`)}})}return{IfStatement(t){a(t.consequent,t,!1),t.alternate&&t.alternate.type!==e.IfStatement&&a(t.alternate,t,!0)}}}}),s=new Set([`useCallback`,`useMemo`]),c=new WeakMap;function l(t){let n=c.get(t);if(n!==void 0)return n;let r=t.parent,i;for(;r;){if(r.type===e.FunctionDeclaration||r.type===e.FunctionExpression||r.type===e.ArrowFunctionExpression){i=r;break}r=r.parent}return c.set(t,i),i}function u(t){if(t.type!==e.CallExpression)return!1;let{callee:n}=t;return n.type===e.Identifier?s.has(n.name):!1}function d(e,t){let n=e;for(;n;){let e=n.set.get(t);if(e)return e;n=n.upper}}function f(t,n){if(n.type===e.FunctionDeclaration){let e=n.params.map(e=>t.getText(e)).join(`, `),r=t.getText(n.body);return`${n.async?`async `:``}(${e}) => ${r}`}return t.getText(n)}function p(t){if(t.type===e.FunctionDeclaration)return t;if(t.type===e.VariableDeclarator&&t.parent.declarations.length===1)return t.parent}const m=a({name:`prefer-inline-handlers`,meta:{type:`suggestion`,docs:{description:`Discourage hoisting event handlers only used once in JSX; prefer inlining`},fixable:`code`,schema:[],messages:{preferInlineHandler:`Handler '{{name}}' is only used once as a JSX prop. Inline it where it's used.`}},defaultOptions:[],create(t){let n=t.sourceCode;function r(r,i,a){let o=d(n.getScope(i),r.name);if(!o)return;let s=o.references.filter(e=>e.isRead()&&e.identifier!==r);if(s.length!==1)return;let c=s[0];if(!c)return;let l=c.identifier,{parent:u}=l;u.type===e.JSXExpressionContainer&&u.parent.type===e.JSXAttribute&&t.report({node:r,messageId:`preferInlineHandler`,data:{name:r.name},fix(e){let t=f(n,a),r=p(i),o=[e.replaceText(l,t)];return r&&o.push(e.remove(r)),o}})}return{"VariableDeclarator[init.type=ArrowFunctionExpression], VariableDeclarator[init.type=FunctionExpression]":function(t){if(t.id.type!==e.Identifier||!t.init||!l(t)||u(t.init))return;let n=t.init;r(t.id,t,n)},"VariableDeclarator[init.type=CallExpression]":function(t){t.id.type===e.Identifier&&(!t.init||t.init.type!==e.CallExpression||l(t)&&u(t.init))},FunctionDeclaration(e){e.id&&l(e)&&r(e.id,e,e)}}}}),h=/^[T$][A-Z][a-z]+\d*$/,g=/^[T$]/,_=/^[T$][A-Z]/,v=/^[T$][A-Z][a-z]/,y={prefix:`prefix`,initial:`initial`,remainder:`remainder`,suggestRename:`suggestRename`},b=a({name:`type-param-names`,meta:{type:`suggestion`,docs:{description:`Enforce giving proper names to type parameters when there are two or more`},hasSuggestions:!0,schema:[],messages:{prefix:`Type parameter {{name}} should have a prefix of "T" or "$"`,initial:`Type parameter {{name}}'s name should start with an uppercase letter`,remainder:`Type parameter {{name}}'s name should contain at least one lowercase letter`,suggestRename:`Rename to {{suggestion}}`}},defaultOptions:[],create(e){return{TSTypeParameterDeclaration(t){let{params:n}=t;if(!(n.length===1&&n.at(0)?.name.name===`T`))for(let t of n){let{name:n}=t.name,r=x(n);if(r){let i=S(n);e.report({node:t,messageId:r,data:{name:n},suggest:[{messageId:`suggestRename`,data:{suggestion:i},fix(e){return e.replaceText(t.name,i)}}]})}}}}}});function x(e){if(!h.test(e)){if(!g.test(e))return y.prefix;if(!_.test(e))return y.initial;if(!v.test(e))return y.remainder}}function S(e){if(!g.test(e))return`T${e.charAt(0).toUpperCase()+e.slice(1).toLowerCase()}`;let t=e.charAt(0),n=e.slice(1);return n.length===0?`${t}Value`:`${t}${n.charAt(0).toUpperCase()+(n.length>1?n.slice(1).toLowerCase():`a`)}`}const C={meta:{name:`@2digits`,version:r},rules:{"if-curly":o,"prefer-inline-handlers":m,"type-param-names":b},configs:{recommended:{plugins:{"@2digits":{}},rules:i.rules}}};C.configs.recommended.plugins[`@2digits`]=C;var w=C;export{w as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@2digits/eslint-plugin",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "description": "An eslint plugin that provides a set of rules to enforce best practices for 2digits projects",
   "repository": {
     "type": "git",
@@ -27,15 +27,14 @@
   "license": "MIT",
   "public": true,
   "dependencies": {
+    "@typescript-eslint/scope-manager": "8.50.1",
     "@typescript-eslint/utils": "8.50.1",
-    "eslint": "9.39.2",
-    "ts-pattern": "5.9.0"
+    "eslint": "9.39.2"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "0.18.2",
     "@typescript-eslint/parser": "8.50.1",
     "eslint-vitest-rule-tester": "3.0.1",
-    "magic-regexp": "0.10.0",
     "publint": "0.3.16",
     "tsdown": "0.18.3",
     "typescript": "5.9.3",