eslint-plugin-perfectionist 0.1.0 → 0.3.0

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";const x=require("@typescript-eslint/types"),R=require("@typescript-eslint/utils"),j=require("natural-compare-lite"),C="eslint-plugin-perfectionist",D="azat-io/eslint-plugin-perfectionist";let E=R.ESLintUtils.RuleCreator(t=>`https://github.com/${D}/blob/main/docs/rules/${t}.md`),S=t=>{let[s,a]=t;return a-s};var d=(t=>(t.natural="natural",t["line-length"]="line-length",t))(d||{}),c=(t=>(t.asc="asc",t.desc="desc",t))(c||{});let I=(t,s,a)=>(a.order==="asc"?1:-1)*(a.type===d.natural?j(t.name,s.name):t.size-s.size)>0,O=(t,s,a,l)=>{let e=[...a].sort((r,o)=>Number(I(r,o,l))||-1),n=r=>[r.range.at(0),r.range.at(1)];return a.map(({node:r},o)=>t.replaceTextRange(n(r),s.slice(...n(e[o].node))))},N=(t={},s)=>Object.assign(s,t);const T="sort-interfaces",z=E({name:T,meta:{type:"suggestion",docs:{description:"Enforce sorted interface properties",recommended:!1},messages:{unexpectedInterfacePropertiesOrder:'Expected "{{second}}" to come before "{{first}}"'},fixable:"code",schema:[{type:"object",properties:{type:{enum:[d.natural,d["line-length"]]},order:{enum:[c.asc,c.desc]}},additionalProperties:!1}]},defaultOptions:[{type:d.natural,order:c.asc}],create:t=>({TSInterfaceBody:s=>{let a=N(t.options.at(0),{type:d.natural,order:c.asc}),l=s.body.map(e=>{let n="",r=0,o=i=>{r+=i},p=i=>{o(S(i.key.range))},g=i=>{let{length:f}="[]";o(i.parameters.reduce((h,{range:A})=>h+S(A),f))},m=i=>{if(i.optional){let{length:f}="?";o(f)}},y=i=>{var h;let f=(h=i.typeAnnotation)==null?void 0:h.range;f&&o(S(f))},u=i=>{if(i.type===x.AST_NODE_TYPES.Identifier)({name:n}=i);else if(i.type===x.AST_NODE_TYPES.TSIndexSignature){let f=i.parameters.at(0);f&&u(f)}};return e.type===x.AST_NODE_TYPES.TSPropertySignature?(u(e.key),p(e),m(e),y(e)):e.type===x.AST_NODE_TYPES.TSIndexSignature&&(u(e),g(e),y(e)),{node:e,name:n,size:r}});for(let e=1;e<l.length;e++){let n=e-1,r=e,o=l.at(n),p=l.at(r);if(I(o,p,a)){let g=s.body[r];t.report({messageId:"unexpectedInterfacePropertiesOrder",data:{first:o.name,second:p.name},node:g,fix:m=>{let y=t.getSourceCode(),{text:u}=y;return O(m,u,l,a)}})}}}})}),b="sort-jsx-props",J=E({name:b,meta:{type:"suggestion",docs:{description:"Enforce sorted interface properties",recommended:!1},messages:{unexpectedJSXPropsOrder:'Expected "{{second}}" to come before "{{first}}"'},fixable:"code",schema:[{type:"object",properties:{type:{enum:[d.natural,d["line-length"]]},order:{enum:[c.asc,c.desc]}},additionalProperties:!1}]},defaultOptions:[{type:d.natural,order:c.asc}],create:t=>({JSXElement:s=>{let a=N(t.options.at(0),{type:d.natural,order:c.asc});s.openingElement.attributes.reduce((e,n)=>(n.type==="JSXAttribute"?e.at(-1).push(n):e.push([]),e),[[]]).forEach(e=>{let n=e.map(r=>({name:r.name.type===x.AST_NODE_TYPES.JSXNamespacedName?`${r.name.namespace.name}:${r.name.name.name}`:r.name.name,size:S(r.range),node:r}));for(let r=1;r<n.length;r++){let o=r-1,p=r,g=n.at(o),m=n.at(p);I(g,m,a)&&t.report({messageId:"unexpectedJSXPropsOrder",data:{first:g.name,second:m.name},node:m.node,fix:y=>{let u=t.getSourceCode(),{text:i}=u;return O(y,i,n,a)}})}})}})}),P="sort-named-imports",$=E({name:P,meta:{type:"suggestion",docs:{description:"Enforce sorted interface properties",recommended:!1},messages:{unexpectedNamedImportsOrder:'Expected "{{second}}" to come before "{{first}}"'},fixable:"code",schema:[{type:"object",properties:{type:{enum:[d.natural,d["line-length"]]},order:{enum:[c.asc,c.desc]}},additionalProperties:!1}]},defaultOptions:[{type:d.natural,order:c.asc}],create:t=>({ImportDeclaration:s=>{let a=N(t.options.at(0),{type:d.natural,order:c.asc});if(s.specifiers.length>1){let l=s.specifiers.map(e=>{let{range:n,local:{name:r}}=e;return{size:S(n),node:e,name:r}});for(let e=1;e<l.length;e++){let n=e-1,r=e,o=l.at(n),p=l.at(r);if(I(o,p,a)){let g=s.specifiers[r];t.report({messageId:"unexpectedNamedImportsOrder",data:{first:o.name,second:p.name},node:g,fix:m=>{let y=t.getSourceCode(),{text:u}=y;return O(m,u,l,a)}})}}}}})});let _=t=>{let s={[T]:["error"],[b]:["error"],[P]:["error"]};return Object.fromEntries(Object.entries(s).map(([a,[l,e]])=>[a,[l,Object.assign(e,t)]]))};const v={name:C,rules:{[T]:z,[b]:J,[P]:$},configs:{"recommended-natural":_({type:"natural",order:"asc"}),"recommended-line-length":_({type:"line-length",order:"desc"})}};module.exports=v;

package/dist/index.mjs

@@ -0,0 +1,273 @@
+import { AST_NODE_TYPES as y } from "@typescript-eslint/types";
+import { ESLintUtils as C } from "@typescript-eslint/utils";
+import T from "natural-compare-lite";
+const z = "eslint-plugin-perfectionist", J = "azat-io/eslint-plugin-perfectionist";
+let O = C.RuleCreator(
+  (t) => `https://github.com/${J}/blob/main/docs/rules/${t}.md`
+), h = (t) => {
+  let [s, a] = t;
+  return a - s;
+};
+var d = /* @__PURE__ */ ((t) => (t.natural = "natural", t["line-length"] = "line-length", t))(d || {}), c = /* @__PURE__ */ ((t) => (t.asc = "asc", t.desc = "desc", t))(c || {});
+let S = (t, s, a) => (a.order === "asc" ? 1 : -1) * (a.type === d.natural ? T(t.name, s.name) : t.size - s.size) > 0, b = (t, s, a, l) => {
+  let e = [...a].sort((r, o) => Number(S(r, o, l)) || -1), n = (r) => [r.range.at(0), r.range.at(1)];
+  return a.map(
+    ({ node: r }, o) => t.replaceTextRange(n(r), s.slice(...n(e[o].node)))
+  );
+}, N = (t = {}, s) => Object.assign(s, t);
+const E = "sort-interfaces", $ = O({
+  name: E,
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Enforce sorted interface properties",
+      recommended: !1
+    },
+    messages: {
+      unexpectedInterfacePropertiesOrder: 'Expected "{{second}}" to come before "{{first}}"'
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
+  },
+  defaultOptions: [
+    {
+      type: d.natural,
+      order: c.asc
+    }
+  ],
+  create: (t) => ({
+    TSInterfaceBody: (s) => {
+      let a = N(t.options.at(0), {
+        type: d.natural,
+        order: c.asc
+      }), l = s.body.map((e) => {
+        let n = "", r = 0, o = (i) => {
+          r += i;
+        }, p = (i) => {
+          o(h(i.key.range));
+        }, g = (i) => {
+          let { length: u } = "[]";
+          o(i.parameters.reduce((I, { range: A }) => I + h(A), u));
+        }, m = (i) => {
+          if (i.optional) {
+            let { length: u } = "?";
+            o(u);
+          }
+        }, x = (i) => {
+          var I;
+          let u = (I = i.typeAnnotation) == null ? void 0 : I.range;
+          u && o(h(u));
+        }, f = (i) => {
+          if (i.type === y.Identifier)
+            ({ name: n } = i);
+          else if (i.type === y.TSIndexSignature) {
+            let u = i.parameters.at(0);
+            u && f(u);
+          }
+        };
+        return e.type === y.TSPropertySignature ? (f(e.key), p(e), m(e), x(e)) : e.type === y.TSIndexSignature && (f(e), g(e), x(e)), {
+          node: e,
+          name: n,
+          size: r
+        };
+      });
+      for (let e = 1; e < l.length; e++) {
+        let n = e - 1, r = e, o = l.at(n), p = l.at(r);
+        if (S(o, p, a)) {
+          let g = s.body[r];
+          t.report({
+            messageId: "unexpectedInterfacePropertiesOrder",
+            data: {
+              first: o.name,
+              second: p.name
+            },
+            node: g,
+            fix: (m) => {
+              let x = t.getSourceCode(), { text: f } = x;
+              return b(m, f, l, a);
+            }
+          });
+        }
+      }
+    }
+  })
+}), R = "sort-jsx-props", v = O({
+  name: R,
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Enforce sorted interface properties",
+      recommended: !1
+    },
+    messages: {
+      unexpectedJSXPropsOrder: 'Expected "{{second}}" to come before "{{first}}"'
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
+  },
+  defaultOptions: [
+    {
+      type: d.natural,
+      order: c.asc
+    }
+  ],
+  create: (t) => ({
+    JSXElement: (s) => {
+      let a = N(t.options.at(0), {
+        type: d.natural,
+        order: c.asc
+      });
+      s.openingElement.attributes.reduce(
+        (e, n) => (n.type === "JSXAttribute" ? e.at(-1).push(n) : e.push([]), e),
+        [[]]
+      ).forEach((e) => {
+        let n = e.map((r) => ({
+          name: r.name.type === y.JSXNamespacedName ? `${r.name.namespace.name}:${r.name.name.name}` : r.name.name,
+          size: h(r.range),
+          node: r
+        }));
+        for (let r = 1; r < n.length; r++) {
+          let o = r - 1, p = r, g = n.at(o), m = n.at(p);
+          S(g, m, a) && t.report({
+            messageId: "unexpectedJSXPropsOrder",
+            data: {
+              first: g.name,
+              second: m.name
+            },
+            node: m.node,
+            fix: (x) => {
+              let f = t.getSourceCode(), { text: i } = f;
+              return b(x, i, n, a);
+            }
+          });
+        }
+      });
+    }
+  })
+}), P = "sort-named-imports", X = O({
+  name: P,
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Enforce sorted interface properties",
+      recommended: !1
+    },
+    messages: {
+      unexpectedNamedImportsOrder: 'Expected "{{second}}" to come before "{{first}}"'
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
+  },
+  defaultOptions: [
+    {
+      type: d.natural,
+      order: c.asc
+    }
+  ],
+  create: (t) => ({
+    ImportDeclaration: (s) => {
+      let a = N(t.options.at(0), {
+        type: d.natural,
+        order: c.asc
+      });
+      if (s.specifiers.length > 1) {
+        let l = s.specifiers.map((e) => {
+          let {
+            range: n,
+            local: { name: r }
+          } = e;
+          return {
+            size: h(n),
+            node: e,
+            name: r
+          };
+        });
+        for (let e = 1; e < l.length; e++) {
+          let n = e - 1, r = e, o = l.at(n), p = l.at(r);
+          if (S(o, p, a)) {
+            let g = s.specifiers[r];
+            t.report({
+              messageId: "unexpectedNamedImportsOrder",
+              data: {
+                first: o.name,
+                second: p.name
+              },
+              node: g,
+              fix: (m) => {
+                let x = t.getSourceCode(), { text: f } = x;
+                return b(m, f, l, a);
+              }
+            });
+          }
+        }
+      }
+    }
+  })
+});
+let j = (t) => {
+  let s = {
+    [E]: ["error"],
+    [R]: ["error"],
+    [P]: ["error"]
+  };
+  return Object.fromEntries(
+    Object.entries(s).map(([a, [l, e]]) => [
+      a,
+      [l, Object.assign(e, t)]
+    ])
+  );
+};
+const D = {
+  name: z,
+  rules: {
+    [E]: $,
+    [R]: v,
+    [P]: X
+  },
+  configs: {
+    "recommended-natural": j({ type: "natural", order: "asc" }),
+    "recommended-line-length": j({ type: "line-length", order: "desc" })
+  }
+};
+export {
+  D as default
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "eslint-plugin-perfectionist",
   "description": "ESLint plugin for code formatting in perfectionist style",
-  "version": "0.1.0",
-  "type": "module",
+  "version": "0.3.0",
+  "homepage": "https://eslint-plugin-perfectionist.azat.io",
   "repository": "azat-io/eslint-plugin-perfectionist",
   "author": "Azat S. <to@azat.io>",
   "license": "MIT",
@@ -19,8 +19,8 @@
   ],
   "exports": {
     ".": {
-      "require": "./dist/index.cjs.js",
-      "import": "./dist/index.es.js"
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
     },
     "./package.json": "./package.json"
   },
@@ -28,7 +28,8 @@
     "eslint": "^8.39.0"
   },
   "dependencies": {
-    "@typescript-eslint/types": "^5.59.2",
-    "@typescript-eslint/utils": "^5.59.2"
+    "@typescript-eslint/types": "^5.59.6",
+    "@typescript-eslint/utils": "^5.59.6",
+    "natural-compare-lite": "^1.4.0"
   }
 }

package/readme.md

@@ -1,6 +1,6 @@
 # ESLint Plugin Perfectionist
 
-<img src="https://user-images.githubusercontent.com/5698350/234571772-9e0cf164-d6bd-46fa-91d3-9c6f2a83932c.svg" alt="ESLint" align="right" width="120" height="120" />
+<img src="https://raw.githubusercontent.com/azat-io/eslint-plugin-perfectionist/main/docs/public/logo.svg" alt="ESLint" align="right" width="120" height="120" />
 
 ![Version](https://img.shields.io/npm/v/eslint-plugin-perfectionist.svg?color=brightgreen)
 
@@ -22,9 +22,12 @@ npm install --save-dev eslint-plugin-perfectionist
 
 ## Rules
 
-| Name            | Description                         | 💼  | 🔧  |
-| :-------------- | :---------------------------------- | :-- | :-- |
-| sort-interfaces | Enforce sorted interface properties | 💼  | 🔧  |
+| Name                                                                                       | Description                         | 💼  | 🛠   |
+| :----------------------------------------------------------------------------------------- | :---------------------------------- | :-- | :-- |
+| [sort-interfaces](https://eslint-plugin-perfectionist.azat.io/rules/sort-interfaces)       | Enforce sorted interface properties | ✅  | 🔧  |
+| [sort-jsx-props](https://eslint-plugin-perfectionist.azat.io/rules/sort-jsx-props)         | Enforce sorted JSX props            | ✅  | 🔧  |
+| [sort-named-imports](https://eslint-plugin-perfectionist.azat.io/rules/sort-named-imports) | Enforce sorted named imports        | ✅  | 🔧  |
+| [sort-union-types](https://eslint-plugin-perfectionist.azat.io/rules/sort-union-types)     | Enforce sorted union types          | ✅  | 🔧  |
 
 ## See also
 

package/dist/index.cjs.js

@@ -1 +0,0 @@
-"use strict";const g=require("@typescript-eslint/types"),y=require("@typescript-eslint/utils"),I="eslint-plugin-perfectionist",_="azat-io/eslint-plugin-perfectionist";let b=y.ESLintUtils.RuleCreator(f=>`https://github.com/${_}/blob/main/docs/rules/${f}.md`);const T="sort-interfaces",A=b({name:T,meta:{type:"suggestion",docs:{description:"Enforce sorted interface properties",recommended:!1},messages:{unexpectedInterfacePropertiesOrder:'Expected "{{second}}" to come before "{{first}}"'},fixable:"code",schema:[]},defaultOptions:[],create:f=>({TSInterfaceBody:S=>{let x=S.body.map(t=>{let a="",l=0,n=e=>{l+=e},i=e=>{let[r,o]=e;return o-r},u=e=>{n(i(e.key.range))},p=e=>{let{length:r}="[]";n(e.parameters.reduce((o,{range:m})=>o+i(m),r))},c=e=>{if(e.optional){let{length:r}="?";n(r)}},d=e=>{var o;let r=(o=e.typeAnnotation)==null?void 0:o.range;r&&n(i(r))},s=e=>{if(e.type===g.AST_NODE_TYPES.Identifier)({name:a}=e);else if(e.type===g.AST_NODE_TYPES.TSIndexSignature){let r=e.parameters.at(0);r&&s(r)}};return t.type===g.AST_NODE_TYPES.TSPropertySignature?(s(t.key),u(t),c(t),d(t)):t.type===g.AST_NODE_TYPES.TSIndexSignature&&(s(t),p(t),d(t)),{name:a,size:l}});for(let t=1;t<x.length;t++){let a=t-1,l=t,n=x.at(a),i=x.at(l);if(n.size<i.size){let u=f.getSourceCode(),p=S.body[a],c=S.body[l];f.report({messageId:"unexpectedInterfacePropertiesOrder",data:{first:n.name,second:i.name},node:c,fix:d=>{let s=r=>[r.range.at(0),r.range.at(1)];return[d.replaceTextRange(s(p),u.text.slice(...s(c))),d.replaceTextRange(s(c),u.text.slice(...s(p)))]}})}}}})}),O={name:I,rules:{[T]:A}};module.exports=O;

package/dist/index.es.js

@@ -1,102 +0,0 @@
-import { AST_NODE_TYPES as u } from "@typescript-eslint/types";
-import { ESLintUtils as y } from "@typescript-eslint/utils";
-const T = "eslint-plugin-perfectionist", b = "azat-io/eslint-plugin-perfectionist";
-let R = y.RuleCreator(
-  (f) => `https://github.com/${b}/blob/main/docs/rules/${f}.md`
-);
-const S = "sort-interfaces", h = R({
-  name: S,
-  meta: {
-    type: "suggestion",
-    docs: {
-      description: "Enforce sorted interface properties",
-      recommended: !1
-    },
-    messages: {
-      unexpectedInterfacePropertiesOrder: 'Expected "{{second}}" to come before "{{first}}"'
-    },
-    fixable: "code",
-    schema: []
-  },
-  defaultOptions: [],
-  create: (f) => ({
-    TSInterfaceBody: (m) => {
-      let x = m.body.map((t) => {
-        let i = "", l = 0, n = (e) => {
-          l += e;
-        }, o = (e) => {
-          let [r, a] = e;
-          return a - r;
-        }, p = (e) => {
-          n(o(e.key.range));
-        }, g = (e) => {
-          let { length: r } = "[]";
-          n(
-            e.parameters.reduce(
-              (a, { range: I }) => a + o(I),
-              r
-            )
-          );
-        }, c = (e) => {
-          if (e.optional) {
-            let { length: r } = "?";
-            n(r);
-          }
-        }, d = (e) => {
-          var a;
-          let r = (a = e.typeAnnotation) == null ? void 0 : a.range;
-          r && n(o(r));
-        }, s = (e) => {
-          if (e.type === u.Identifier)
-            ({ name: i } = e);
-          else if (e.type === u.TSIndexSignature) {
-            let r = e.parameters.at(0);
-            r && s(r);
-          }
-        };
-        return t.type === u.TSPropertySignature ? (s(t.key), p(t), c(t), d(t)) : t.type === u.TSIndexSignature && (s(t), g(t), d(t)), {
-          name: i,
-          size: l
-        };
-      });
-      for (let t = 1; t < x.length; t++) {
-        let i = t - 1, l = t, n = x.at(i), o = x.at(l);
-        if (n.size < o.size) {
-          let p = f.getSourceCode(), g = m.body[i], c = m.body[l];
-          f.report({
-            messageId: "unexpectedInterfacePropertiesOrder",
-            data: {
-              first: n.name,
-              second: o.name
-            },
-            node: c,
-            fix: (d) => {
-              let s = (r) => [
-                r.range.at(0),
-                r.range.at(1)
-              ];
-              return [
-                d.replaceTextRange(
-                  s(g),
-                  p.text.slice(...s(c))
-                ),
-                d.replaceTextRange(
-                  s(c),
-                  p.text.slice(...s(g))
-                )
-              ];
-            }
-          });
-        }
-      }
-    }
-  })
-}), z = {
-  name: T,
-  rules: {
-    [S]: h
-  }
-};
-export {
-  z as default
-};