@jsenv/importmap-eslint-resolver

importmap eslint resolver

importmap resolution for eslint.

Table of contents

• Presentation
• Installation
  • Step 1 - Install eslint-plugin-import
  • Step 2 - Install importmap-eslint-resolver
  • Step 3 - Configure eslint

Presentation

@jsenv/importmap-eslint-resolver enables importMap resolution for eslint.

— see importmap spec on github

Installation

Follow the steps below to install @jsenv/importmap-eslint-resolver in your project.

Step 1 - Install eslint-plugin-import

npm install --save-dev eslint-plugin-import@2.18.2

— see eslint-plugin-import on github

Step 2 - Install importmap-eslint-resolver

If you never installed a jsenv package, read Installing a jsenv package before going further.

This documentation is up-to-date with a specific version so prefer any of the following commands

npm install --save-dev @jsenv/importmap-eslint-resolver@1.0.0

yarn add --dev @jsenv/importmap-eslint-resolver@1.0.0

Step 3 - Configure eslint

• Your eslint config must enable eslint-plugin-import
• Your eslint config must use @jsenv/importmap-eslint-resolver resolver

It means your minimal .eslintrc.js file looks like this:

module.exports = {
  plugins: ["import"],
  settings: {
    "import/resolver": {
      [`${__dirname}/node_modules/@jsenv/importmap-eslint-resolver/dist/commonjs/main.js`]: {
        projectDirectoryUrl: __dirname,
      },
    },
  },
}