refactor: better typescript integration (#26)

* fix: disable `no-unused-vars` rule in typescript config

The `no-unused-vars` rule was causing false positives for variables in type declarations.

* style: add no-multi-spaces rule

* refactor: update module paths for eslint-config-vuetify

fix: explicitly define exports

refactor: reorganize type declarations and exports

build: add tsconfig.json for TypeScript project configuration

build: add missing type declaration files to package.json

build: add tsconfig.json to package.json

chore: remove tsconfig for distribution

* chore: lockfile

* style: add maxBOF option to no-multiple-empty-lines rule

* chore: add global ignore for dist folder in eslint config

Author: AndreyYolkin

index.js.mjs

@@ -4,10 +4,12 @@ import eslint from '@eslint/js'
 import stylistic from '@stylistic/eslint-plugin'
 import { defu } from 'defu'
 import { loadAutoImports } from './utils/autoimports.mjs'
+import { globalIgnores } from 'eslint/config'
 
 const autoImports = loadAutoImports()
 
 export default [
+  globalIgnores(['dist/**'], 'ignore dist folder'),
   eslint.configs.recommended,
   ...pluginVue.configs['flat/recommended'],
   {
@@ -57,7 +59,8 @@ export default [
       '@stylistic/eol-last': ['error', 'always'],
       '@stylistic/multiline-ternary': 'off',
       '@stylistic/no-extra-semi': 'error',
-      '@stylistic/no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 0 }],
+      '@stylistic/no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 0, 'maxBOF': 0 }],
+      '@stylistic/no-multi-spaces': 'error',
       '@stylistic/no-trailing-spaces': 'error',
       '@stylistic/object-curly-spacing': ['error', 'always'],
       '@stylistic/quotes': ['error', 'single', {

index.js.mjs.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;

index.ts.mjs

@@ -7,4 +7,10 @@ import {
 export default defineConfigWithVueTs([
   vueTsConfigs.recommended,
   ...config,
+  {
+    // False positive for variables in type declarations
+    rules: {
+      'no-unused-vars': 'off',
+    },
+  },
 ])

index.ts.mjs.d.ts

@@ -0,0 +1,3 @@
+import type { Linter } from 'eslint';
+declare const config: Linter.Config[];
+export default config;

package.json

@@ -6,7 +6,23 @@
   "module": "index.ts.mjs",
   "types": "types.d.ts",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./types.d.ts",
+      "import": "./index.js.mjs"
+    },
+    "./index.js.mjs": {
+      "types": "./types.d.ts",
+      "import": "./index.js.mjs"
+    },
+    "./index.ts.mjs": {
+      "types": "./types.d.ts",
+      "import": "./index.ts.mjs"
+    }
+  },
   "files": [
+    "index.js.mjs.d.ts",
+    "index.ts.mjs.d.ts",
     "index.js.mjs",
     "index.ts.mjs",
     "types.d.ts",

tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "Node16",
+    "moduleResolution": "Node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": "./",
+    "paths": {
+      "*": ["types.d.ts", "index.js.mjs", "index.ts.mjs"]
+    }
+  },
+  "include": ["**/*.ts", "**/*.d.ts"]
+}

types.d.ts

@@ -1,14 +1,5 @@
-import type { Linter } from 'eslint';
-
 declare module 'eslint-config-vuetify' {
+  import type { Linter } from 'eslint';
   const config: Linter.Config[];
   export default config;
 }
-
-declare module './index.js.mjs' {
-  const config: Linter.Config[];
-}
-
-declare module './index.ts.mjs' {
-  const config: Linter.Config[];
-}