eslint-plugin-perfectionist 0.2.0 → 0.3.0

package/dist/index.js

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

@@ -1,25 +1,22 @@
-import { AST_NODE_TYPES as g } from "@typescript-eslint/types";
-import { ESLintUtils as O } from "@typescript-eslint/utils";
-const E = "eslint-plugin-perfectionist", R = "azat-io/eslint-plugin-perfectionist";
-let I = O.RuleCreator(
-  (a) => `https://github.com/${R}/blob/main/docs/rules/${a}.md`
-), u = (a) => {
-  let [i, n] = a;
-  return n - i;
-}, S = (a, i, n) => {
-  let e = [...n].sort((t, r) => r.size - t.size), s = (t) => [
-    t.range.at(0),
-    t.range.at(1)
-  ];
-  return n.map(
-    ({ node: t }, r) => a.replaceTextRange(
-      s(t),
-      i.slice(...s(e[r].node))
-    )
-  );
+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;
 };
-const h = "sort-interfaces", T = I({
-  name: h,
+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: {
@@ -30,64 +27,85 @@ const h = "sort-interfaces", T = I({
       unexpectedInterfacePropertiesOrder: 'Expected "{{second}}" to come before "{{first}}"'
     },
     fixable: "code",
-    schema: []
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
   },
-  defaultOptions: [],
-  create: (a) => ({
-    TSInterfaceBody: (i) => {
-      let n = i.body.map((e) => {
-        let s = "", t = 0, r = (o) => {
-          t += o;
-        }, d = (o) => {
-          r(u(o.key.range));
-        }, f = (o) => {
-          let { length: p } = "[]";
-          r(o.parameters.reduce((x, { range: N }) => x + u(N), p));
-        }, c = (o) => {
-          if (o.optional) {
-            let { length: p } = "?";
-            r(p);
+  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);
           }
-        }, m = (o) => {
-          var x;
-          let p = (x = o.typeAnnotation) == null ? void 0 : x.range;
-          p && r(u(p));
-        }, l = (o) => {
-          if (o.type === g.Identifier)
-            ({ name: s } = o);
-          else if (o.type === g.TSIndexSignature) {
-            let p = o.parameters.at(0);
-            p && l(p);
+        }, 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 === g.TSPropertySignature ? (l(e.key), d(e), c(e), m(e)) : e.type === g.TSIndexSignature && (l(e), f(e), m(e)), {
+        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: s,
-          size: t
+          name: n,
+          size: r
         };
       });
-      for (let e = 1; e < n.length; e++) {
-        let s = e - 1, t = e, r = n.at(s), d = n.at(t);
-        if (r.size < d.size) {
-          let f = i.body[t];
-          a.report({
+      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: r.name,
-              second: d.name
+              first: o.name,
+              second: p.name
             },
-            node: f,
-            fix: (c) => {
-              let m = a.getSourceCode(), { text: l } = m;
-              return S(c, l, n);
+            node: g,
+            fix: (m) => {
+              let x = t.getSourceCode(), { text: f } = x;
+              return b(m, f, l, a);
             }
           });
         }
       }
     }
   })
-}), y = "sort-jsx-props", A = I({
-  name: y,
+}), R = "sort-jsx-props", v = O({
+  name: R,
   meta: {
     type: "suggestion",
     docs: {
@@ -98,40 +116,62 @@ const h = "sort-interfaces", T = I({
       unexpectedJSXPropsOrder: 'Expected "{{second}}" to come before "{{first}}"'
     },
     fixable: "code",
-    schema: []
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
   },
-  defaultOptions: [],
-  create: (a) => ({
-    JSXElement: (i) => {
-      i.openingElement.attributes.reduce(
-        (e, s) => (s.type === "JSXAttribute" ? e.at(-1).push(s) : e.push([]), e),
+  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 s = e.map((t) => ({
-          name: t.name.type === g.JSXNamespacedName ? `${t.name.namespace.name}:${t.name.name.name}` : t.name.name,
-          size: u(t.range),
-          node: t
+        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 t = 1; t < s.length; t++) {
-          let r = t - 1, d = t, f = s.at(r), c = s.at(d);
-          f.size < c.size && a.report({
+        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: f.name,
-              second: c.name
+              first: g.name,
+              second: m.name
             },
-            node: c.node,
-            fix: (m) => {
-              let l = a.getSourceCode(), { text: o } = l;
-              return S(m, o, s);
+            node: m.node,
+            fix: (x) => {
+              let f = t.getSourceCode(), { text: i } = f;
+              return b(x, i, n, a);
             }
           });
         }
       });
     }
   })
-}), z = "sort-named-imports", b = I({
-  name: z,
+}), P = "sort-named-imports", X = O({
+  name: P,
   meta: {
     type: "suggestion",
     docs: {
@@ -142,37 +182,59 @@ const h = "sort-interfaces", T = I({
       unexpectedNamedImportsOrder: 'Expected "{{second}}" to come before "{{first}}"'
     },
     fixable: "code",
-    schema: []
+    schema: [
+      {
+        type: "object",
+        properties: {
+          type: {
+            enum: [d.natural, d["line-length"]]
+          },
+          order: {
+            enum: [c.asc, c.desc]
+          }
+        },
+        additionalProperties: !1
+      }
+    ]
   },
-  defaultOptions: [],
-  create: (a) => ({
-    ImportDeclaration: (i) => {
-      if (i.specifiers.length > 1) {
-        let n = i.specifiers.map((e) => {
+  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: s,
-            local: { name: t }
+            range: n,
+            local: { name: r }
           } = e;
           return {
-            size: u(s),
+            size: h(n),
             node: e,
-            name: t
+            name: r
           };
         });
-        for (let e = 1; e < n.length; e++) {
-          let s = e - 1, t = e, r = n.at(s), d = n.at(t);
-          if (r.size < d.size) {
-            let f = i.specifiers[t];
-            a.report({
+        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: r.name,
-                second: d.name
+                first: o.name,
+                second: p.name
               },
-              node: f,
-              fix: (c) => {
-                let m = a.getSourceCode(), { text: l } = m;
-                return S(c, l, n);
+              node: g,
+              fix: (m) => {
+                let x = t.getSourceCode(), { text: f } = x;
+                return b(m, f, l, a);
               }
             });
           }
@@ -180,14 +242,32 @@ const h = "sort-interfaces", T = I({
       }
     }
   })
-}), J = {
-  name: E,
+});
+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: {
-    [h]: T,
-    [y]: A,
-    [z]: b
+    [E]: $,
+    [R]: v,
+    [P]: X
+  },
+  configs: {
+    "recommended-natural": j({ type: "natural", order: "asc" }),
+    "recommended-line-length": j({ type: "line-length", order: "desc" })
   }
 };
 export {
-  J as default
+  D as default
 };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "eslint-plugin-perfectionist",
   "description": "ESLint plugin for code formatting in perfectionist style",
-  "version": "0.2.0",
+  "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",
@@ -18,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"
   },
@@ -27,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

@@ -27,6 +27,7 @@ npm install --save-dev eslint-plugin-perfectionist
 | [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