@unocss/eslint-plugin 0.49.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-PRESENT Anthony Fu <https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @unocss/eslint-plugin
+
+ESLint plugin for UnoCSS.
+
+**Currently working in progress, breaking changes may NOT follow semver.**
+
+## Installation
+
+Please refer to [@unocss/eslint-config](https://github.com/unocss/unocss/blob/main/packages/eslint-config) for installation.

package/dist/dirs.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const url = require('url');
+
+const distDir = url.fileURLToPath(new URL("../dist", (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('dirs.cjs', document.baseURI).href))));
+
+exports.distDir = distDir;

package/dist/dirs.d.ts

@@ -0,0 +1,3 @@
+declare const distDir: string;
+
+export { distDir };

package/dist/dirs.mjs

@@ -0,0 +1,5 @@
+import { fileURLToPath } from 'url';
+
+const distDir = fileURLToPath(new URL("../dist", import.meta.url));
+
+export { distDir };

package/dist/index.cjs

@@ -0,0 +1,148 @@
+'use strict';
+
+const path = require('path');
+const utils = require('@typescript-eslint/utils');
+const synckit = require('synckit');
+const dirs = require('./dirs.cjs');
+const MagicString = require('magic-string');
+require('url');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e["default"] : e; }
+
+const MagicString__default = /*#__PURE__*/_interopDefaultLegacy(MagicString);
+
+const CLASS_FIELDS = ["class", "classname"];
+
+const sortClasses$1 = synckit.createSyncFn(path.join(dirs.distDir, "worker-sort.cjs"));
+const order = utils.ESLintUtils.RuleCreator((name) => name)({
+  name: "order",
+  meta: {
+    type: "layout",
+    fixable: "code",
+    docs: {
+      description: "Order of UnoCSS utilities in class attribute",
+      recommended: "warn"
+    },
+    messages: {
+      "invalid-order": "UnoCSS utilities are not ordered"
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    function checkLiteral(node) {
+      if (typeof node.value !== "string")
+        return;
+      const input = node.value;
+      const sorted = sortClasses$1(input);
+      if (sorted !== input) {
+        context.report({
+          node,
+          messageId: "invalid-order",
+          fix(fixer) {
+            return fixer.replaceText(node, `"${sorted.trim()}"`);
+          }
+        });
+      }
+    }
+    const scriptVisitor = {
+      JSXAttribute(node) {
+        if (typeof node.name.name === "string" && CLASS_FIELDS.includes(node.name.name.toLowerCase()) && node.value) {
+          if (node.value.type === "Literal")
+            checkLiteral(node.value);
+        }
+      }
+    };
+    const templateBodyVisitor = {
+      VAttribute(node) {
+        if (node.key.name === "class") {
+          if (node.value.type === "VLiteral")
+            checkLiteral(node.value);
+        }
+      }
+    };
+    if (context.parserServices == null || context.parserServices.defineTemplateBodyVisitor == null) {
+      return scriptVisitor;
+    } else {
+      return context.parserServices?.defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor);
+    }
+  }
+});
+
+const sortClasses = synckit.createSyncFn(path.join(dirs.distDir, "worker-sort.cjs"));
+const INGORE_ATTRIBUTES = ["style", "class", "classname", "value"];
+const orderAttributify = utils.ESLintUtils.RuleCreator((name) => name)({
+  name: "order-attributify",
+  meta: {
+    type: "layout",
+    fixable: "code",
+    docs: {
+      description: "Order of UnoCSS attributes",
+      recommended: false
+    },
+    messages: {
+      "invalid-order": "UnoCSS attributes are not ordered"
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    const scriptVisitor = {};
+    const templateBodyVisitor = {
+      VStartTag(node) {
+        const valueless = node.attributes.filter((i) => !INGORE_ATTRIBUTES.includes(i.key?.name?.toLowerCase()) && i.value == null);
+        if (!valueless.length)
+          return;
+        const input = valueless.map((i) => i.key.name).join(" ").trim();
+        const sorted = sortClasses(input);
+        if (sorted !== input) {
+          context.report({
+            node,
+            messageId: "invalid-order",
+            fix(fixer) {
+              const codeFull = context.getSourceCode();
+              const offset = node.range[0];
+              const code = codeFull.getText().slice(node.range[0], node.range[1]);
+              const s = new MagicString__default(code);
+              const sortedNodes = valueless.map((i) => [i.range[0] - offset, i.range[1] - offset]).sort((a, b) => a[0] - b[0]);
+              for (let [start, end] of sortedNodes.slice(1)) {
+                if (code[start - 1] === " ")
+                  start--;
+                if (code[end] === " ")
+                  end++;
+                s.remove(start, end);
+              }
+              s.overwrite(sortedNodes[0][0], sortedNodes[0][1], ` ${sorted.trim()} `);
+              return fixer.replaceText(node, s.toString());
+            }
+          });
+        }
+      }
+    };
+    if (context.parserServices == null || context.parserServices.defineTemplateBodyVisitor == null) {
+      return scriptVisitor;
+    } else {
+      return context.parserServices?.defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor);
+    }
+  }
+});
+
+const configsRecommended = {
+  plugins: ["@unocss"],
+  rules: {
+    "@unocss/order": "warn",
+    "@unocss/order-attributify": "warn"
+  }
+};
+
+const index = {
+  rules: {
+    order,
+    "order-attributify": orderAttributify
+  },
+  configs: {
+    recommended: configsRecommended
+  }
+};
+
+module.exports = index;

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import * as _typescript_eslint_utils_dist_ts_eslint_Rule from '@typescript-eslint/utils/dist/ts-eslint/Rule';
+
+declare const _default: {
+    rules: {
+        order: _typescript_eslint_utils_dist_ts_eslint_Rule.RuleModule<"invalid-order", never[], any>;
+        'order-attributify': _typescript_eslint_utils_dist_ts_eslint_Rule.RuleModule<"invalid-order", never[], any>;
+    };
+    configs: {
+        recommended: {
+            plugins: string[];
+            rules: {
+                '@unocss/order': string;
+                '@unocss/order-attributify': string;
+            };
+        };
+    };
+};
+
+export { _default as default };

package/dist/index.mjs

@@ -0,0 +1,142 @@
+import { join } from 'path';
+import { ESLintUtils } from '@typescript-eslint/utils';
+import { createSyncFn } from 'synckit';
+import { distDir } from './dirs.mjs';
+import MagicString from 'magic-string';
+import 'url';
+
+const CLASS_FIELDS = ["class", "classname"];
+
+const sortClasses$1 = createSyncFn(join(distDir, "worker-sort.cjs"));
+const order = ESLintUtils.RuleCreator((name) => name)({
+  name: "order",
+  meta: {
+    type: "layout",
+    fixable: "code",
+    docs: {
+      description: "Order of UnoCSS utilities in class attribute",
+      recommended: "warn"
+    },
+    messages: {
+      "invalid-order": "UnoCSS utilities are not ordered"
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    function checkLiteral(node) {
+      if (typeof node.value !== "string")
+        return;
+      const input = node.value;
+      const sorted = sortClasses$1(input);
+      if (sorted !== input) {
+        context.report({
+          node,
+          messageId: "invalid-order",
+          fix(fixer) {
+            return fixer.replaceText(node, `"${sorted.trim()}"`);
+          }
+        });
+      }
+    }
+    const scriptVisitor = {
+      JSXAttribute(node) {
+        if (typeof node.name.name === "string" && CLASS_FIELDS.includes(node.name.name.toLowerCase()) && node.value) {
+          if (node.value.type === "Literal")
+            checkLiteral(node.value);
+        }
+      }
+    };
+    const templateBodyVisitor = {
+      VAttribute(node) {
+        if (node.key.name === "class") {
+          if (node.value.type === "VLiteral")
+            checkLiteral(node.value);
+        }
+      }
+    };
+    if (context.parserServices == null || context.parserServices.defineTemplateBodyVisitor == null) {
+      return scriptVisitor;
+    } else {
+      return context.parserServices?.defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor);
+    }
+  }
+});
+
+const sortClasses = createSyncFn(join(distDir, "worker-sort.cjs"));
+const INGORE_ATTRIBUTES = ["style", "class", "classname", "value"];
+const orderAttributify = ESLintUtils.RuleCreator((name) => name)({
+  name: "order-attributify",
+  meta: {
+    type: "layout",
+    fixable: "code",
+    docs: {
+      description: "Order of UnoCSS attributes",
+      recommended: false
+    },
+    messages: {
+      "invalid-order": "UnoCSS attributes are not ordered"
+    },
+    schema: []
+  },
+  defaultOptions: [],
+  create(context) {
+    const scriptVisitor = {};
+    const templateBodyVisitor = {
+      VStartTag(node) {
+        const valueless = node.attributes.filter((i) => !INGORE_ATTRIBUTES.includes(i.key?.name?.toLowerCase()) && i.value == null);
+        if (!valueless.length)
+          return;
+        const input = valueless.map((i) => i.key.name).join(" ").trim();
+        const sorted = sortClasses(input);
+        if (sorted !== input) {
+          context.report({
+            node,
+            messageId: "invalid-order",
+            fix(fixer) {
+              const codeFull = context.getSourceCode();
+              const offset = node.range[0];
+              const code = codeFull.getText().slice(node.range[0], node.range[1]);
+              const s = new MagicString(code);
+              const sortedNodes = valueless.map((i) => [i.range[0] - offset, i.range[1] - offset]).sort((a, b) => a[0] - b[0]);
+              for (let [start, end] of sortedNodes.slice(1)) {
+                if (code[start - 1] === " ")
+                  start--;
+                if (code[end] === " ")
+                  end++;
+                s.remove(start, end);
+              }
+              s.overwrite(sortedNodes[0][0], sortedNodes[0][1], ` ${sorted.trim()} `);
+              return fixer.replaceText(node, s.toString());
+            }
+          });
+        }
+      }
+    };
+    if (context.parserServices == null || context.parserServices.defineTemplateBodyVisitor == null) {
+      return scriptVisitor;
+    } else {
+      return context.parserServices?.defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor);
+    }
+  }
+});
+
+const configsRecommended = {
+  plugins: ["@unocss"],
+  rules: {
+    "@unocss/order": "warn",
+    "@unocss/order-attributify": "warn"
+  }
+};
+
+const index = {
+  rules: {
+    order,
+    "order-attributify": orderAttributify
+  },
+  configs: {
+    recommended: configsRecommended
+  }
+};
+
+export { index as default };

package/dist/worker-sort.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+const config = require('@unocss/config');
+const core = require('@unocss/core');
+const synckit = require('synckit');
+
+async function sortRules(rules, uno) {
+  const unknown = [];
+  if (!uno.config.details)
+    uno.config.details = true;
+  const expandedResult = core.parseVariantGroup(rules);
+  rules = expandedResult.expanded;
+  const result = await Promise.all(rules.split(/\s+/g).map(async (i) => {
+    const token = await uno.parseToken(i);
+    if (token == null) {
+      unknown.push(i);
+      return void 0;
+    }
+    const variantRank = (token[0][5]?.variantHandlers?.length || 0) * 1e3;
+    const order = token[0][0] + variantRank;
+    return [order, i];
+  }));
+  let sorted = result.filter(core.notNull).sort((a, b) => {
+    let result2 = a[0] - b[0];
+    if (result2 === 0)
+      result2 = a[1].localeCompare(b[1]);
+    return result2;
+  }).map((i) => i[1]).join(" ");
+  if (expandedResult?.prefixes.length)
+    sorted = core.collapseVariantGroup(sorted, expandedResult.prefixes);
+  return [...unknown, sorted].join(" ").trim();
+}
+
+async function getGenerator() {
+  const { config: config$1 } = await config.loadConfig();
+  return core.createGenerator(config$1);
+}
+let promise;
+synckit.runAsWorker(async (classes) => {
+  promise = promise || getGenerator();
+  const uno = await promise;
+  return await sortRules(classes, uno);
+});

package/dist/worker-sort.d.ts

@@ -0,0 +1 @@
+

package/dist/worker-sort.mjs

@@ -0,0 +1,41 @@
+import { loadConfig } from '@unocss/config';
+import { parseVariantGroup, notNull, collapseVariantGroup, createGenerator } from '@unocss/core';
+import { runAsWorker } from 'synckit';
+
+async function sortRules(rules, uno) {
+  const unknown = [];
+  if (!uno.config.details)
+    uno.config.details = true;
+  const expandedResult = parseVariantGroup(rules);
+  rules = expandedResult.expanded;
+  const result = await Promise.all(rules.split(/\s+/g).map(async (i) => {
+    const token = await uno.parseToken(i);
+    if (token == null) {
+      unknown.push(i);
+      return void 0;
+    }
+    const variantRank = (token[0][5]?.variantHandlers?.length || 0) * 1e3;
+    const order = token[0][0] + variantRank;
+    return [order, i];
+  }));
+  let sorted = result.filter(notNull).sort((a, b) => {
+    let result2 = a[0] - b[0];
+    if (result2 === 0)
+      result2 = a[1].localeCompare(b[1]);
+    return result2;
+  }).map((i) => i[1]).join(" ");
+  if (expandedResult?.prefixes.length)
+    sorted = collapseVariantGroup(sorted, expandedResult.prefixes);
+  return [...unknown, sorted].join(" ").trim();
+}
+
+async function getGenerator() {
+  const { config } = await loadConfig();
+  return createGenerator(config);
+}
+let promise;
+runAsWorker(async (classes) => {
+  promise = promise || getGenerator();
+  const uno = await promise;
+  return await sortRules(classes, uno);
+});

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@unocss/eslint-plugin",
+  "version": "0.49.3",
+  "description": "ESLint plugin for UnoCSS",
+  "author": "Anthony Fu <anthonyfu117@hotmail.com>",
+  "license": "MIT",
+  "funding": "https://github.com/sponsors/antfu",
+  "homepage": "https://github.com/unocss/unocss/tree/main/packages/esling-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unocss/unocss.git",
+    "directory": "packages/esling-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/unocss/unocss/issues"
+  },
+  "keywords": [
+    "eslint-plugin",
+    "eslint"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=14"
+  },
+  "dependencies": {
+    "@typescript-eslint/utils": "^5.50.0",
+    "@unocss/config": "^0.49.2",
+    "@unocss/core": "0.49.3",
+    "magic-string": "^0.27.0",
+    "synckit": "^0.8.5"
+  },
+  "devDependencies": {
+    "@unocss/eslint-plugin": "0.49.3"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "lint": "nr build && cd ./fixtures && eslint ./src"
+  }
+}