@byscripts/eslint-plugin 0.4.0 → 0.6.0

package/README.md

@@ -24,15 +24,20 @@ Custom order via rule options:
 }]
 ```
 
-## Dev
+## Install
 
 ```bash
-pnpm build        # compile src/ -> dist/index.mjs + dist/index.d.mts
-pnpm publish --access public   # publish to npm
+pnpm add -D @byscripts/eslint-plugin eslint
+```
+
+```js
+// eslint.config.js
+import vueBlockAttributeOrder from "@byscripts/eslint-plugin/vue-block-attribute-order";
+
+export default [...yourOtherRules, vueBlockAttributeOrder];
 ```
 
 ## Notes
 
-- Built with `tsdown --dts`
-- Peer dependency: `eslint ^9.22.0`
+- Peer dependency: `eslint ^9.22.0 || ^10.0.0`
 - Requires `vue-eslint-parser` in the consumer project (for `parserServices.getDocumentFragment()`)

package/dist/vue-block-attribute-order.d.mts

@@ -0,0 +1,18 @@
+import { Rule } from "eslint";
+
+//#region src/vue-block-attribute-order.d.ts
+declare const _default: {
+  plugins: {
+    byscripts: {
+      rules: {
+        "vue-block-attribute-order": Rule.RuleModule;
+      };
+    };
+  };
+  rules: {
+    "byscripts/vue-block-attribute-order": "error";
+  };
+};
+//#endregion
+export { _default as default };
+//# sourceMappingURL=vue-block-attribute-order.d.mts.map

package/dist/vue-block-attribute-order.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue-block-attribute-order.d.mts","names":[],"sources":["../src/vue-block-attribute-order.ts"],"mappings":";;;cAA2C,QAAA"}

package/dist/{index.mjs → vue-block-attribute-order.mjs}

@@ -1,9 +1,8 @@
-//#region src/block-attribute-order.ts
 const DEFAULT_ORDER = {
 	script: ["lang", "setup"],
 	style: ["lang", "scoped"]
 };
-const blockAttributeOrder = {
+const rule = {
 	meta: {
 		type: "layout",
 		fixable: "code",
@@ -57,10 +56,10 @@ const blockAttributeOrder = {
 		} };
 	}
 };
+var vue_block_attribute_order_default = {
+	plugins: { byscripts: { rules: { "vue-block-attribute-order": rule } } },
+	rules: { "byscripts/vue-block-attribute-order": "error" }
+};
+export { vue_block_attribute_order_default as default };
 
-//#endregion
-//#region src/index.ts
-var src_default = { blockAttributeOrder };
-
-//#endregion
-export { src_default as default };
+//# sourceMappingURL=vue-block-attribute-order.mjs.map

package/dist/vue-block-attribute-order.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"vue-block-attribute-order.mjs","names":[],"sources":["../src/vue-block-attribute-order.ts"],"sourcesContent":["import type { Linter, Rule } from \"eslint\";\n\ntype AttributeOrder = Record<string, string[]>;\n\nconst DEFAULT_ORDER: AttributeOrder = {\n  script: [\"lang\", \"setup\"],\n  style: [\"lang\", \"scoped\"],\n};\n\nconst rule: Rule.RuleModule = {\n  meta: {\n    type: \"layout\",\n    fixable: \"code\",\n    schema: [\n      {\n        type: \"object\",\n        additionalProperties: {\n          type: \"array\",\n          items: { type: \"string\" },\n        },\n      },\n    ],\n    messages: {\n      wrongOrder: \"Attributes on <{{tag}}> should follow order: {{expected}}.\",\n    },\n  },\n  create(context) {\n    if (!context.filename.endsWith(\".vue\")) {\n      return {};\n    }\n\n    const attributeOrder: AttributeOrder = {\n      ...DEFAULT_ORDER,\n      ...(context.options[0] as AttributeOrder),\n    };\n\n    const { parserServices } = context.sourceCode;\n\n    const documentFragment = parserServices.getDocumentFragment?.();\n\n    if (!documentFragment) {\n      return {};\n    }\n\n    return {\n      Program() {\n        for (const child of documentFragment.children) {\n          if (child.type !== \"VElement\") {\n            continue;\n          }\n\n          const expectedOrder = attributeOrder[child.name];\n\n          if (!expectedOrder) {\n            continue;\n          }\n\n          const attributes = child.startTag.attributes.filter(\n            (a: Record<string, unknown>) =>\n              a.type === \"VAttribute\" && !a.directive,\n          );\n\n          const attributeNames: string[] = attributes.map(\n            (a: Record<string, Record<string, unknown>>) => a.key.name,\n          );\n\n          const relevantNames = attributeNames.filter((n) =>\n            expectedOrder.includes(n),\n          );\n\n          const expectedNames = expectedOrder.filter((n) =>\n            relevantNames.includes(n),\n          );\n\n          if (relevantNames.every((name, i) => name === expectedNames[i])) {\n            continue;\n          }\n\n          const sourceCode = context.sourceCode;\n\n          context.report({\n            loc: child.startTag.loc,\n            messageId: \"wrongOrder\",\n            data: { tag: child.name, expected: expectedNames.join(\", \") },\n            fix(fixer) {\n              const sorted = [...attributes].sort((attributeA, attributeB) => {\n                const attributeAIndex = expectedOrder.indexOf(\n                  attributeA.key.name,\n                );\n\n                const attributeBIndex = expectedOrder.indexOf(\n                  attributeB.key.name,\n                );\n\n                return (\n                  (attributeAIndex === -1 ? 999 : attributeAIndex) -\n                  (attributeBIndex === -1 ? 999 : attributeBIndex)\n                );\n              });\n\n              const newText = sorted\n                .map((a) => sourceCode.getText(a))\n                .join(\" \");\n\n              const firstAttribute = attributes[0];\n\n              const lastAttribute = attributes[attributes.length - 1];\n\n              return fixer.replaceTextRange(\n                [firstAttribute.range[0], lastAttribute.range[1]],\n                newText,\n              );\n            },\n          });\n        }\n      },\n    };\n  },\n};\n\nexport default {\n  plugins: {\n    byscripts: {\n      rules: {\n        \"vue-block-attribute-order\": rule,\n      },\n    },\n  },\n  rules: {\n    \"byscripts/vue-block-attribute-order\": \"error\",\n  },\n} satisfies Linter.Config;\n"],"mappings":"AAIA,MAAM,gBAAgC;CACpC,QAAQ,CAAC,QAAQ,QAAQ;CACzB,OAAO,CAAC,QAAQ,SAAA;CACjB;AAED,MAAM,OAAwB;CAC5B,MAAM;EACJ,MAAM;EACN,SAAS;EACT,QAAQ,CACN;GACE,MAAM;GACN,sBAAsB;IACpB,MAAM;IACN,OAAO,EAAE,MAAM,UAAA;;GAElB,CACF;EACD,UAAU,EACR,YAAY,8DAAA;EAEf;CACD,OAAO,SAAS;AACd,MAAI,CAAC,QAAQ,SAAS,SAAS,OAAO,CACpC,QAAO,EAAE;EAGX,MAAM,iBAAiC;GACrC,GAAG;GACH,GAAI,QAAQ,QAAQ;GACrB;EAED,MAAM,EAAE,mBAAmB,QAAQ;EAEnC,MAAM,mBAAmB,eAAe,uBAAuB;AAE/D,MAAI,CAAC,iBACH,QAAO,EAAE;AAGX,SAAO,EACL,UAAU;AACR,QAAK,MAAM,SAAS,iBAAiB,UAAU;AAC7C,QAAI,MAAM,SAAS,WACjB;IAGF,MAAM,gBAAgB,eAAe,MAAM;AAE3C,QAAI,CAAC,cACH;IAGF,MAAM,aAAa,MAAM,SAAS,WAAW,QAC1C,MACC,EAAE,SAAS,gBAAgB,CAAC,EAAE,UACjC;IAMD,MAAM,gBAJ2B,WAAW,KACzC,MAA+C,EAAE,IAAI,KACvD,CAEoC,QAAQ,MAC3C,cAAc,SAAS,EAAE,CAC1B;IAED,MAAM,gBAAgB,cAAc,QAAQ,MAC1C,cAAc,SAAS,EAAE,CAC1B;AAED,QAAI,cAAc,OAAO,MAAM,MAAM,SAAS,cAAc,GAAG,CAC7D;IAGF,MAAM,aAAa,QAAQ;AAE3B,YAAQ,OAAO;KACb,KAAK,MAAM,SAAS;KACpB,WAAW;KACX,MAAM;MAAE,KAAK,MAAM;MAAM,UAAU,cAAc,KAAK,KAAA;MAAO;KAC7D,IAAI,OAAO;MAgBT,MAAM,UAfS,CAAC,GAAG,WAAW,CAAC,MAAM,YAAY,eAAe;OAC9D,MAAM,kBAAkB,cAAc,QACpC,WAAW,IAAI,KAChB;OAED,MAAM,kBAAkB,cAAc,QACpC,WAAW,IAAI,KAChB;AAED,eACG,oBAAoB,KAAK,MAAM,oBAC/B,oBAAoB,KAAK,MAAM;QAElC,CAGC,KAAK,MAAM,WAAW,QAAQ,EAAE,CAAC,CACjC,KAAK,IAAI;MAEZ,MAAM,iBAAiB,WAAW;MAElC,MAAM,gBAAgB,WAAW,WAAW,SAAS;AAErD,aAAO,MAAM,iBACX,CAAC,eAAe,MAAM,IAAI,cAAc,MAAM,GAAG,EACjD,QACD;;KAEJ,CAAC;;KAGP;;CAEJ;AAED,IAAA,oCAAe;CACb,SAAS,EACP,WAAW,EACT,OAAO,EACL,6BAA6B,MAC9B,EACF,EACF;CACD,OAAO,EACL,uCAAuC,SAAA;CAE1C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@byscripts/eslint-plugin",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "repository": {
     "url": "https://github.com/ByScripts/toolbox"
   },
@@ -9,20 +9,20 @@
     "dist"
   ],
   "exports": {
-    ".": {
-      "types": "./dist/index.d.mts",
-      "default": "./dist/index.mjs"
+    "./vue-block-attribute-order": {
+      "types": "./dist/vue-block-attribute-order.d.mts",
+      "default": "./dist/vue-block-attribute-order.mjs"
     }
   },
   "devDependencies": {
     "@tsconfig/node22": "^22.0.5",
-    "tsdown": "^0.20.3"
+    "obuild": "^0.4.31"
   },
   "peerDependencies": {
-    "eslint": "^9.22.0"
+    "eslint": "^9.22.0 || ^10.0.0"
   },
   "license": "MIT",
   "scripts": {
-    "build": "tsdown --dts"
+    "build": "obuild"
   }
 }

package/dist/index.d.mts

@@ -1,8 +0,0 @@
-import * as eslint from "eslint";
-
-//#region src/index.d.ts
-declare const _default: {
-  blockAttributeOrder: eslint.Rule.RuleModule;
-};
-//#endregion
-export { _default as default };