convert to ts

Author: jay-es

.eslintrc.js

@@ -4,11 +4,24 @@ module.exports = {
     es2021: true,
     node: true,
   },
-  extends: ["eslint:recommended", "airbnb-base", "prettier"],
+  extends: [
+    "eslint:recommended",
+    "airbnb-base",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
   parserOptions: {
     ecmaVersion: "latest",
   },
   rules: {
-    strict: "off",
+    "import/extensions": "off",
+    "import/prefer-default-export": "off",
+  },
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".ts"],
+      },
+    },
   },
 };

package.json

@@ -9,7 +9,7 @@
   ],
   "scripts": {
     "prepare": "husky install",
-    "format": "prettier --check ./**/*.js",
+    "format": "prettier --check ./**/*.ts",
     "lint": "eslint .",
     "test": "mocha tests/**/*.js",
     "test:watch": "mocha --watch --reporter min tests/**/*.js"

lib/index.js renamed to src/index.ts

@@ -1,11 +1,8 @@
-// @ts-check
+import type { ESLint } from "eslint";
 
-"use strict";
+import { sortComponentsRule } from "./rules/vue-sort-components";
 
-const sortComponentsRule = require("./rules/vue-sort-components");
-
-/** @type {import('eslint').ESLint.Plugin} */
-module.exports = {
+const plugin: ESLint.Plugin = {
   rules: {
     "vue-sort-components": sortComponentsRule,
   },
@@ -18,3 +15,5 @@ module.exports = {
     },
   },
 };
+
+export default plugin;

lib/rules/vue-sort-components.js renamed to src/rules/vue-sort-components.ts

@@ -1,28 +1,17 @@
-// @ts-check
+import type { Rule } from "eslint";
+import type { Expression, Property, SpreadElement } from "estree";
+import naturalCompare from "natural-compare";
 
-"use strict";
-
-const naturalCompare = require("natural-compare");
-
-/**
- * @param {import('estree').Property} node
- * @returns {string}
- */
-const getKeyName = (node) =>
+const getKeyName = (node: Property): string =>
   node.key.type === "Identifier" ? node.key.name : "";
 
-/**
- * @param {import('estree').Expression} arg
- * @returns {string}
- */
-const getArgName = (arg) => (arg.type === "Identifier" ? arg.name : "");
+const getArgName = (arg: Expression): string =>
+  arg.type === "Identifier" ? arg.name : "";
 
-/**
- * @param {import('estree').Property | import('estree').SpreadElement} a
- * @param {import('estree').Property | import('estree').SpreadElement} b
- * @returns {-1 | 0 | 1}
- */
-const compareNodes = (a, b) => {
+const compareNodes = (
+  a: Property | SpreadElement,
+  b: Property | SpreadElement
+): -1 | 0 | 1 => {
   if (a.type === "Property" && b.type === "Property") {
     return naturalCompare(getKeyName(a), getKeyName(b));
   }
@@ -34,8 +23,7 @@ const compareNodes = (a, b) => {
   return a.type === "SpreadElement" ? -1 : 1;
 };
 
-/** @type {import('eslint').Rule.RuleModule} */
-module.exports = {
+export const sortComponentsRule: Rule.RuleModule = {
   meta: {
     type: "layout",
     fixable: "code",