fix: add tests

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eufemia/eslint-plugin",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "ESLint rules for DNB Eufemia",
   "keywords": [
     "eslint",
@@ -13,7 +13,9 @@
   "module": "dist/eufemia-eslint-plugin.esm.js",
   "scripts": {
     "release": "yarn build && npm publish",
-    "build": "preconstruct build"
+    "build": "preconstruct build",
+    "test": "vitest",
+    "test:watch": "vitest --watch"
   },
   "prepublish": "yarn build",
   "exports": {
@@ -34,12 +36,16 @@
   "devDependencies": {
     "@babel/preset-typescript": "^7.18.6",
     "@preconstruct/cli": "^2.2.2",
-    "@typescript-eslint/utils": "^5.48.0",
-    "eslint": "^7.10.0",
-    "typescript": "^4.9.4"
+    "@types/eslint": "^8.4.10",
+    "eslint": "^8.31.0",
+    "typescript": "^4.9.4",
+    "vitest": "^0.26.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "packageManager": "yarn@3.3.0"
+  "packageManager": "yarn@3.3.0",
+  "dependencies": {
+    "@typescript-eslint/utils": "^5.48.0"
+  }
 }

src/__test__/calc-arguments.test.ts

@@ -0,0 +1,40 @@
+import { it } from 'vitest'
+import { RuleTester } from 'eslint'
+import { rule } from '../rules/calc-arguments'
+
+const ruleTester = new RuleTester()
+
+it('calc-arguments', () => {
+  // @ts-ignore
+  ruleTester.run('calc-arguments', rule, {
+    valid: [
+      {
+        code: `calc('large', 'small')`,
+      },
+      {
+        code: `calc('2rem', '1rem')`,
+      },
+    ],
+
+    invalid: [
+      {
+        code: `calc('small', 'large')`,
+        errors: [
+          {
+            message: '"large" should come before "small".',
+            type: 'Literal',
+          },
+        ],
+      },
+      {
+        code: `calc('large small')`,
+        errors: [
+          {
+            message: 'Use function arguments instead of whitespaces.',
+            type: 'Literal',
+          },
+        ],
+      },
+    ],
+  })
+})

src/index.ts

@@ -1,5 +1,5 @@
-import calcArguments from './rules/calc-arguments'
+import { rule as calcArguments } from './rules/calc-arguments'
 
-export let rules = {
+export const rules = {
   'calc-arguments': calcArguments,
 }

src/rules/calc-arguments.ts

@@ -1,20 +1,21 @@
-import type { TSESTree, TSESLint } from '@typescript-eslint/utils'
+import type { TSESTree } from '@typescript-eslint/utils'
+import { createRule } from '../utils/RuleCreator'
 
-type MessageIds = 'order' | 'whitespaces'
-
-export default {
+export const rule = createRule({
+  defaultOptions: [],
+  name: 'calc-arguments',
   meta: {
     type: 'suggestion',
     docs: {
       description: 'Helps to keep consistent code.',
-      url: 'https://github.com/dnbexperience/eslint-plugin-eufemia/blob/main/docs/rules/calc-arguments.md',
       recommended: false,
     },
     fixable: 'code',
     messages: {
       order: '"{{type}}" should come before "{{prev}}".',
       whitespaces: 'Use function arguments instead of whitespaces.',
     },
+    schema: [],
   },
   create(context) {
     const correctOrder = [
@@ -27,7 +28,7 @@ export default {
     ]
 
     return {
-      CallExpression(node: TSESTree.CallExpression) {
+      CallExpression(node) {
         const callee = node.callee as TSESTree.Identifier
 
         if (callee.name === 'calc') {
@@ -60,10 +61,4 @@ export default {
       },
     }
   },
-} as TSESLint.RuleModule<MessageIds, Options>
-
-type Options = [
-  {
-    // someOption?: '' | ''
-  }
-]
+})

src/utils/RuleCreator.ts

@@ -0,0 +1,8 @@
+import { ESLintUtils } from '@typescript-eslint/utils'
+
+const getDocsUrl = (name: string): string =>
+  `https://github.com/dnbexperience/eslint-plugin-eufemia/blob/main/docs/rules/${name}.md`
+
+export const createRule: ReturnType<typeof ESLintUtils.RuleCreator> = (
+  ...args
+) => ESLintUtils.RuleCreator(getDocsUrl)(...args)

tsconfig.json

@@ -10,6 +10,6 @@
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true
   },
-  "include": ["src/**/*"],
+  "include": ["src/**/*", "src/__test__"],
   "exclude": ["dist"]
 }