@rotki/eslint-plugin 0.0.2 → 0.1.0

package/dist/index.mjs

@@ -0,0 +1,390 @@
+import { extname } from 'node:path';
+import * as compat from 'eslint-compat-utils';
+import createDebug from 'debug';
+import { pascalCase, snakeCase } from 'scule';
+
+const name = "@rotki/eslint-plugin";
+const version = "0.1.0";
+const packageManager = "pnpm@8.14.1";
+const type = "module";
+const license = "AGPL-3.0";
+const bugs = {
+	url: "https://github.com/rotki/eslint-plugin/issues"
+};
+const repository = {
+	type: "git",
+	url: "https://github.com/rotki/eslint-plugin.git"
+};
+const author = "Rotki Solutions GmbH <info@rotki.com>";
+const files = [
+	"dist"
+];
+const main = "./dist/index.mjs";
+const module = "./dist/index.mjs";
+const types = "./dist/index.d.ts";
+const exports = {
+	".": {
+		types: "./dist/index.d.ts",
+		require: "./dist/index.cjs",
+		"import": "./dist/index.mjs"
+	}
+};
+const sideEffects = false;
+const scripts = {
+	clean: "rimraf .nyc_output coverage dist docs/.vitepress/dist",
+	coverage: "nyc report --reporter lcov && opener coverage/lcov-report/index.html",
+	generate: "node --experimental-specifier-resolution=node --loader ts-node/esm scripts/update-rule-docs.ts",
+	lint: "eslint .",
+	"lint:fix": "eslint . --fix",
+	build: "unbuild",
+	dev: "unbuild --stub",
+	prepublishOnly: "pnpm run build",
+	test: "vitest",
+	"new": "node --experimental-specifier-resolution=node --loader ts-node/esm ./scripts/new-rule.ts",
+	docs: "vitepress dev docs",
+	"docs:build": "pnpm run generate && vitepress build docs",
+	prepare: "husky install",
+	typecheck: "tsc --noEmit",
+	release: "bumpp -r --no-push"
+};
+const peerDependencies = {
+	eslint: "^8.0.0 || ^9.0.0"
+};
+const dependencies = {
+	"@typescript-eslint/utils": "6.19.0",
+	debug: "4.3.4",
+	"eslint-compat-utils": "0.4.1",
+	"jsonc-eslint-parser": "2.4.0",
+	scule: "1.2.0",
+	"vue-eslint-parser": "9.4.1",
+	"yaml-eslint-parser": "1.2.2"
+};
+const devDependencies = {
+	"@commitlint/cli": "18.5.0",
+	"@commitlint/config-conventional": "18.5.0",
+	"@rotki/eslint-config": "2.3.0",
+	"@types/debug": "4.1.12",
+	"@types/eslint": "8.56.2",
+	"@types/node": "20",
+	"@typescript-eslint/eslint-plugin": "6.19.0",
+	"@typescript-eslint/parser": "6.19.0",
+	"@typescript-eslint/rule-tester": "6.19.0",
+	bumpp: "9.3.0",
+	eslint: "8.56.0",
+	husky: "8.0.3",
+	"lint-staged": "15.2.0",
+	rimraf: "5.0.5",
+	"ts-node": "10.9.2",
+	typescript: "5.3.3",
+	unbuild: "2.0.0",
+	vitepress: "1.0.0-rc.40",
+	vitest: "1.2.1"
+};
+const engines = {
+	node: ">=18.0.0",
+	pnpm: ">=8 <9"
+};
+const pkg = {
+	name: name,
+	version: version,
+	packageManager: packageManager,
+	type: type,
+	license: license,
+	bugs: bugs,
+	repository: repository,
+	author: author,
+	files: files,
+	main: main,
+	module: module,
+	types: types,
+	exports: exports,
+	sideEffects: sideEffects,
+	scripts: scripts,
+	peerDependencies: peerDependencies,
+	dependencies: dependencies,
+	devDependencies: devDependencies,
+	engines: engines,
+	"lint-staged": {
+	"*.{js,cjs,ts,vue,yml,json,md}": "eslint"
+}
+};
+
+function getFilename(context) {
+  return compat.getFilename(context);
+}
+function getSourceCode(context) {
+  return compat.getSourceCode(context);
+}
+
+const blobUrl = "https://rotki.github.io/eslint-plugin/rules/";
+function RuleCreator(urlCreator) {
+  return function createNamedRule({
+    meta,
+    name,
+    ...rule
+  }) {
+    return createRule({
+      meta: {
+        ...meta,
+        docs: {
+          ...meta.docs,
+          url: urlCreator(name)
+        }
+      },
+      ...rule
+    });
+  };
+}
+function createRule({
+  create,
+  defaultOptions,
+  meta
+}) {
+  return {
+    create: (context) => {
+      const optionsWithDefault = context.options.map((options, index) => ({
+        ...defaultOptions[index] || {},
+        ...options || {}
+      }));
+      return create(context, optionsWithDefault);
+    },
+    defaultOptions,
+    meta
+  };
+}
+const createEslintRule = RuleCreator(
+  (ruleName) => `${blobUrl}${ruleName}`
+);
+
+function defineTemplateBodyVisitor(context, templateBodyVisitor, scriptVisitor, options) {
+  const sourceCode = getSourceCode(context);
+  const parserServices = sourceCode.parserServices;
+  if (!("defineTemplateBodyVisitor" in parserServices) || parserServices.defineTemplateBodyVisitor == null) {
+    const filename = getFilename(context);
+    if (extname(filename) === ".vue") {
+      context.report({
+        loc: { column: 0, line: 1 },
+        message: "Use the latest vue-eslint-parser. See also https://github.com/vuejs/eslint-plugin-vue#what-is-the-use-the-latest-vue-eslint-parser-error"
+      });
+    }
+    return {};
+  }
+  return parserServices.defineTemplateBodyVisitor(
+    templateBodyVisitor,
+    scriptVisitor,
+    options
+  );
+}
+
+const RULE_NAME$1 = "no-deprecated-classes";
+const replacements$1 = [
+  ["d-block", "block"],
+  ["d-flex", "flex"],
+  ["flex-column", "flex-col"],
+  ["flex-grow-1", "grow"],
+  ["flex-grow-0", "grow-0"],
+  ["flex-shrink-1", "shrink"],
+  ["flex-shrink-0", "shrink-0"],
+  [
+    /^align-(start|end|center|baseline|stretch)$/,
+    ([align]) => `items-${align}`
+  ],
+  [/^justify-space-(between|around)$/, ([justify]) => `justify-${justify}`],
+  [
+    /^align-self-(start|end|center|baseline|auto|strech)$/,
+    ([align]) => `self-${align}`
+  ],
+  [
+    /^font-weight-(thin|extralight|light|normal|medium|semibold|bold|extrabold|black)$/,
+    ([weight]) => `font-${weight}`
+  ],
+  [/^text-(capitalize|uppercase|lowercase)$/, ([casing]) => casing]
+];
+function isString(replacement) {
+  return typeof replacement[0] === "string";
+}
+function isRegex(replacement) {
+  return replacement[0] instanceof RegExp;
+}
+const noDeprecatedClasses = createEslintRule({
+  create(context) {
+    return defineTemplateBodyVisitor(context, {
+      'VAttribute[key.name="class"]': function(node) {
+        if (!node.value || !node.value.value)
+          return;
+        const classes = node.value.value.split(/\s+/).filter((s) => !!s);
+        const source = getSourceCode(context);
+        const replaced = [];
+        classes.forEach((className) => {
+          for (const replacement of replacements$1) {
+            if (isString(replacement) && replacement[0] === className)
+              replaced.push([className, replacement[1]]);
+            if (isRegex(replacement)) {
+              const matches = (replacement[0].exec(className) || []).slice(1);
+              const replace = replacement[1];
+              if (matches.length > 0 && typeof replace === "function")
+                return replaced.push([className, replace(matches)]);
+            }
+          }
+        });
+        replaced.forEach((replacement) => {
+          if (!node.value)
+            return;
+          const idx = node.value.value.indexOf(replacement[0]) + 1;
+          const range = [
+            node.value.range[0] + idx,
+            node.value.range[0] + idx + replacement[0].length
+          ];
+          const loc = {
+            end: source.getLocFromIndex(range[1]),
+            start: source.getLocFromIndex(range[0])
+          };
+          context.report({
+            data: {
+              a: replacement[0],
+              b: replacement[1]
+            },
+            fix(fixer) {
+              return fixer.replaceTextRange(range, replacement[1]);
+            },
+            loc,
+            messageId: "replacedWith"
+          });
+        });
+      }
+    });
+  },
+  defaultOptions: [],
+  meta: {
+    docs: {
+      description: "disallow the usage of vuetify css classes since they are replaced with tailwindcss",
+      recommended: "recommended"
+    },
+    fixable: "code",
+    messages: {
+      replacedWith: `'{{ a }}' has been replaced with '{{ b }}'`
+    },
+    schema: [],
+    type: "problem"
+  },
+  name: RULE_NAME$1
+});
+
+const debug = createDebug("@rotki/eslint-plugin:no-deprecated-components");
+const RULE_NAME = "no-deprecated-components";
+const replacements = {
+  DataTable: true,
+  Fragment: false
+};
+const skipInLegacy = [
+  "Fragment"
+];
+function hasReplacement(tag) {
+  return Object.prototype.hasOwnProperty.call(replacements, tag);
+}
+const noDeprecatedComponents = createEslintRule({
+  create(context, optionsWithDefault) {
+    const options = optionsWithDefault[0] || {};
+    const legacy = options.legacy;
+    return defineTemplateBodyVisitor(context, {
+      VElement(element) {
+        const tag = pascalCase(element.rawName);
+        const sourceCode = getSourceCode(context);
+        if (!("getTemplateBodyTokenStore" in sourceCode.parserServices))
+          throw new Error("cannot find getTemplateBodyTokenStore in parserServices");
+        if (!hasReplacement(tag))
+          return;
+        const replacement = replacements[tag];
+        if (replacement || legacy && skipInLegacy.includes(tag)) {
+          debug(`${tag} has been deprecated`);
+          context.report({
+            data: {
+              name: snakeCase(tag)
+            },
+            messageId: "deprecated",
+            node: element
+          });
+        } else {
+          debug(`${tag} has will be removed`);
+          context.report({
+            data: {
+              name: snakeCase(tag)
+            },
+            fix(fixer) {
+              return [
+                fixer.remove(element.startTag),
+                ...element.endTag ? [fixer.remove(element.endTag)] : []
+              ];
+            },
+            messageId: "removed",
+            node: element
+          });
+        }
+      }
+    });
+  },
+  defaultOptions: [{ legacy: false }],
+  meta: {
+    docs: {
+      description: "Removes deprecated classes that do not exist anymore",
+      recommended: "recommended"
+    },
+    fixable: "code",
+    messages: {
+      deprecated: `'{{ name }}' has been deprecated`,
+      removed: `'{{ name }}' has been removed`,
+      replacedWith: `'{{ a }}' has been replaced with '{{ b }}'`
+    },
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          legacy: {
+            type: "boolean"
+          }
+        },
+        type: "object"
+      }
+    ],
+    type: "problem"
+  },
+  name: RULE_NAME
+});
+
+const plugin = {
+  meta: {
+    name: "@rotki/eslint-plugin",
+    version: pkg.version
+  },
+  rules: {
+    "no-deprecated-classes": noDeprecatedClasses,
+    "no-deprecated-components": noDeprecatedComponents
+  }
+};
+const plugin$1 = plugin;
+
+function createRecommended(plugin, name, flat) {
+  const rules = Object.fromEntries(Object.entries(plugin.rules).filter(([_key, rule]) => rule.meta.recommended === "recommended" && !rule.meta.deprecated).map(([key]) => [`${name}/${key}`, 2]));
+  if (flat) {
+    return {
+      plugins: {
+        [name]: plugin
+      },
+      rules
+    };
+  } else {
+    return {
+      plugins: [name],
+      rules
+    };
+  }
+}
+
+const configs = {
+  "recommended": createRecommended(plugin$1, "@rotki", false),
+  "recommended-flat": createRecommended(plugin$1, "@rotki", true)
+};
+
+const index = Object.assign(plugin$1, { configs });
+
+export { index as default };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@rotki/eslint-plugin",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "packageManager": "pnpm@8.14.1",
-  "type": "commonjs",
+  "type": "module",
   "license": "AGPL-3.0",
   "bugs": {
     "url": "https://github.com/rotki/eslint-plugin/issues"
@@ -15,36 +15,49 @@
   "files": [
     "dist"
   ],
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "sideEffects": false,
   "peerDependencies": {
-    "eslint": "^8.0.0"
+    "eslint": "^8.0.0 || ^9.0.0"
   },
   "dependencies": {
-    "@typescript-eslint/utils": "6.18.1",
+    "@typescript-eslint/utils": "6.19.0",
+    "debug": "4.3.4",
+    "eslint-compat-utils": "0.4.1",
     "jsonc-eslint-parser": "2.4.0",
-    "vue-eslint-parser": "9.4.0",
+    "scule": "1.2.0",
+    "vue-eslint-parser": "9.4.1",
     "yaml-eslint-parser": "1.2.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.4.4",
-    "@commitlint/config-conventional": "18.4.4",
-    "@rotki/eslint-config": "1.1.2",
-    "@types/eslint": "8.56.1",
-    "@types/node": "18",
-    "@typescript-eslint/eslint-plugin": "6.18.1",
-    "@typescript-eslint/parser": "6.18.1",
-    "@typescript-eslint/rule-tester": "6.18.1",
-    "bumpp": "9.2.1",
+    "@commitlint/cli": "18.5.0",
+    "@commitlint/config-conventional": "18.5.0",
+    "@rotki/eslint-config": "2.3.0",
+    "@types/debug": "4.1.12",
+    "@types/eslint": "8.56.2",
+    "@types/node": "20",
+    "@typescript-eslint/eslint-plugin": "6.19.0",
+    "@typescript-eslint/parser": "6.19.0",
+    "@typescript-eslint/rule-tester": "6.19.0",
+    "bumpp": "9.3.0",
     "eslint": "8.56.0",
     "husky": "8.0.3",
     "lint-staged": "15.2.0",
-    "mocha": "10.2.0",
-    "nyc": "15.1.0",
     "rimraf": "5.0.5",
     "ts-node": "10.9.2",
     "typescript": "5.3.3",
-    "vitepress": "1.0.0-rc.36"
+    "unbuild": "2.0.0",
+    "vitepress": "1.0.0-rc.40",
+    "vitest": "1.2.1"
   },
   "engines": {
     "node": ">=18.0.0",
@@ -56,16 +69,16 @@
   "scripts": {
     "clean": "rimraf .nyc_output coverage dist docs/.vitepress/dist",
     "coverage": "nyc report --reporter lcov && opener coverage/lcov-report/index.html",
-    "generate": "ts-node scripts/update.ts",
+    "generate": "node --experimental-specifier-resolution=node --loader ts-node/esm scripts/update-rule-docs.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "build": "tsc --project ./tsconfig.build.json",
-    "test": "mocha --require ts-node/register/transpile-only \"./tests/**/*.ts\"",
-    "test:debug": "mocha --require ts-node/register/transpile-only \"./tests/**/*.ts\"",
-    "test:coverage": "nyc mocha --require ts-node/register/transpile-only \"./tests/**/*.ts\" --timeout 60000",
-    "new": "ts-node ./scripts/new-rule.ts",
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "test": "vitest",
+    "new": "node --experimental-specifier-resolution=node --loader ts-node/esm ./scripts/new-rule.ts",
     "docs": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
+    "docs:build": "pnpm run generate && vitepress build docs",
+    "typecheck": "tsc --noEmit",
     "release": "bumpp -r --no-push"
   }
 }

package/dist/configs/base.d.ts

@@ -1,5 +0,0 @@
-declare const _default: {
-    parser: string;
-    plugins: string[];
-};
-export = _default;

package/dist/configs/base.js

@@ -1,5 +0,0 @@
-"use strict";
-module.exports = {
-    parser: require.resolve('vue-eslint-parser'),
-    plugins: ['@rotki'],
-};

package/dist/configs/recommended.d.ts

@@ -1,18 +0,0 @@
-declare const _default: {
-    extends: string[];
-    parserOptions: {
-        ecmaVersion: number;
-        sourceType: string;
-        ecmaFeatures: {
-            jsx: boolean;
-        };
-    };
-    env: {
-        browser: boolean;
-        es6: boolean;
-    };
-    rules: {
-        '@rotki/no-deprecated-classes': string;
-    };
-};
-export = _default;

package/dist/configs/recommended.js

@@ -1,18 +0,0 @@
-"use strict";
-module.exports = {
-    extends: [require.resolve('./base')],
-    parserOptions: {
-        ecmaVersion: 2018,
-        sourceType: 'module',
-        ecmaFeatures: {
-            jsx: true,
-        },
-    },
-    env: {
-        browser: true,
-        es6: true,
-    },
-    rules: {
-        '@rotki/no-deprecated-classes': 'warn',
-    },
-};

package/dist/configs.d.ts

@@ -1,24 +0,0 @@
-declare const _default: {
-    base: {
-        parser: string;
-        plugins: string[];
-    };
-    recommended: {
-        extends: string[];
-        parserOptions: {
-            ecmaVersion: number;
-            sourceType: string;
-            ecmaFeatures: {
-                jsx: boolean;
-            };
-        };
-        env: {
-            browser: boolean;
-            es6: boolean;
-        };
-        rules: {
-            '@rotki/no-deprecated-classes': string;
-        };
-    };
-};
-export = _default;

package/dist/configs.js

@@ -1,10 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const base_1 = __importDefault(require("./configs/base"));
-const recommended_1 = __importDefault(require("./configs/recommended"));
-module.exports = {
-    base: base_1.default,
-    recommended: recommended_1.default,
-};

package/dist/index.js

@@ -1,10 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const configs_1 = __importDefault(require("./configs"));
-const rules_1 = __importDefault(require("./rules"));
-module.exports = {
-    configs: configs_1.default,
-    rules: rules_1.default,
-};

package/dist/rules/no-deprecated-classes.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("../types").RuleModule;
-export = _default;

package/dist/rules/no-deprecated-classes.js

@@ -1,97 +0,0 @@
-"use strict";
-const index_1 = require("../utils/index");
-const rule_1 = require("../utils/rule");
-const replacements = [
-    ['d-block', 'block'],
-    ['d-flex', 'flex'],
-    ['flex-column', 'flex-col'],
-    ['flex-grow-1', 'grow'],
-    ['flex-grow-0', 'grow-0'],
-    ['flex-shrink-1', 'shrink'],
-    ['flex-shrink-0', 'shrink-0'],
-    [
-        /^align-(start|end|center|baseline|stretch)$/,
-        ([align]) => `items-${align}`,
-    ],
-    [/^justify-space-(between|around)$/, ([justify]) => `justify-${justify}`],
-    [
-        /^align-self-(start|end|center|baseline|auto|strech)$/,
-        ([align]) => `self-${align}`,
-    ],
-    [
-        /^font-weight-(thin|extralight|light|normal|medium|semibold|bold|extrabold|black)$/,
-        ([weight]) => `font-${weight}`,
-    ],
-    [/^text-(capitalize|uppercase|lowercase)$/, ([casing]) => casing],
-];
-function isString(replacement) {
-    return typeof replacement[0] === 'string';
-}
-function isRegex(replacement) {
-    return replacement[0] instanceof RegExp;
-}
-const create = (context) => (0, index_1.defineTemplateBodyVisitor)(context, {
-    'VAttribute[key.name="class"]': function (node) {
-        if (!node.value || !node.value.value) {
-            return;
-        }
-        const classes = node.value.value.split(/\s+/).filter((s) => !!s);
-        const source = context.getSourceCode();
-        const replaced = [];
-        classes.forEach((className) => {
-            for (const replacement of replacements) {
-                if (isString(replacement) && replacement[0] === className) {
-                    replaced.push([className, replacement[1]]);
-                }
-                if (isRegex(replacement)) {
-                    const matches = (replacement[0].exec(className) || []).slice(1);
-                    const replace = replacement[1];
-                    if (matches.length > 0 && typeof replace === 'function') {
-                        return replaced.push([className, replace(matches)]);
-                    }
-                }
-            }
-        });
-        replaced.forEach((replacement) => {
-            if (!node.value) {
-                return;
-            }
-            const idx = node.value.value.indexOf(replacement[0]) + 1;
-            const range = [
-                node.value.range[0] + idx,
-                node.value.range[0] + idx + replacement[0].length,
-            ];
-            const loc = {
-                start: source.getLocFromIndex(range[0]),
-                end: source.getLocFromIndex(range[1]),
-            };
-            context.report({
-                loc,
-                messageId: 'replacedWith',
-                data: {
-                    a: replacement[0],
-                    b: replacement[1],
-                },
-                fix(fixer) {
-                    return fixer.replaceTextRange(range, replacement[1]);
-                },
-            });
-        });
-    },
-});
-module.exports = (0, rule_1.createRule)({
-    meta: {
-        type: 'problem',
-        docs: {
-            description: 'disallow the usage of vuetify css classes since they are replaced with tailwindcss',
-            category: 'Recommended',
-            url: 'https://rotki.github.io/eslint-plugin/rules/no-deprecated-classes',
-            recommended: true,
-        },
-        messages: {
-            replacedWith: `'{{ a }}' has been replaced with '{{ b }}'`,
-        },
-        fixable: 'code',
-    },
-    create,
-});