eslint-import-resolver-vite-ts

Vite resolver for eslint-plugin-import

This plugin will resolve the resolve.alias option.

support .ts and .js vite config file.

support write in both __dirname and import.meta.url to solve the path.

---

Attention!this plugin could not instead of eslint-import-resolver-node! You should use that beside this plugin to avoid errors for insurance purposes

Installation

1npm install --save-dev eslint-import-resolver-vite-ts
2yarn add eslint-import-resolver-vite-ts -D
3pnpm eslint-import-resolver-vite-ts -D

How to use

1/**
2 * vite config file
3 */
4import eslintPlugin from "vite-plugin-eslint";
5
6export default {
7    resolve: {
8        alias: {
9
10            // you could use the traditional way as before
11            _: path.resolve(__dirname, "src")
12            // OR this!this way in esm is also support here!
13            '@': fileURLToPath(new URL('./src', import.meta.url))
14
15        }
16    },
17    plugins: [
18        eslintPlugin()
19    ]
20};
21
22/**
23 * eslint config file
24 */
25module.exports = {
26    settings: {
27        // use default config path to 'vite.config.*' ends with either js or ts:
28        "import/resolver":{
29            node:{
30            },
31            'eslint-import-resolver-vite-ts': {
32            }
33        }
34        // OR use custom config:
35        "import/resolver": {
36            node:{
37            },
38            'eslint-import-resolver-vite-ts': {
39                configPath: "./app1/vite.config.dev"
40            }
41        }
42    }
43}

Config Options

• configPath: vite config file path.
  • Required: No
  • Type: string
  • Default: "vite.config",the plugin will auto detect the extname and import it in right way if you omit it.
  • By default, the plugin assumes the vite config file and eslintrc file are in the same directory.
• namedExport: named export of vite config object.
  • Required: No
  • Type: string
  • Default: [No Default]
  • If you use a function as vite config, you must export a named vite config object.

  1/**
  2 * vite config file
  3 */
  4export const viteConfig = {};
  5
  6export default ({ command, mode }) => {
  7    // conditional config
  8    return viteConfig;
  9}
  10
  11/**
  12 * eslintrc file
  13 */
  14module.exports = {
  15    settings: {
  16        "import/resolver": {
  17            node:{},
  18            'eslint-import-resolver-vite-ts': {
  19                namedExport: "viteConfig"
  20            }
  21        }
  22    }
  23}

Thanks and the copyright

This project is forked form pzmosquito/eslint-import-resolver-vite in 4/18/2022,the author Peter Zhang own the copyright of the origin code.Thanks for his contribution. the details please read LICENSE-origin.

I refactor it in typescript with keeping the commit history and own the other codes' copyright.the details please read LICENSE.