Newborn Programming Monsters

    @vue/eslint-config-standard

    8.0.1 • Public • Published

    @vue/eslint-config-standard

    eslint-config-standard for Vue

    This config is specifically designed to be used by @vue/cli & create-vue setups and is not meant for outside use (it can be used but some adaptations on the user side might be needed - for details see the config file).

    A part of its design is that this config may implicitly depend on other parts of @vue/cli/create-vue setups, such as eslint-plugin-vue being extended in the same resulting config.

    Installation

    In order to work around a known limitation in ESLint, we recommend you to use this package alongside @rushstack/eslint-patch, so that you don't have to install too many dependencies:

    npm add --dev @vue/eslint-config-standard @rushstack/eslint-patch

    Usage

    An example .eslintrc.cjs:

    require("@rushstack/eslint-patch/modern-module-resolution")
    
    module.exports = {
      root: true,
      extends: [
        'plugin:vue/vue3-essential',
        '@vue/eslint-config-standard'
      ]
    }

    Aliases

    By default, none of the built-in rules require you to configure aliases in ESLint.

    But if you want to enable some additional rules that need to actually resolve the imported module on the filesystem (e.g. import/no-unresolved) by yourself, you should configure it. In that case, we provided a helper function to simplify the task.

    For example, it is a widely accepted convention to use @ as an alias to the src folder in the Vue ecosystem. To enable this, you can use the following config:

    require('@rushstack/eslint-patch/modern-module-resolution')
    
    const path = require('node:path')
    const createAliasSetting = require('@vue/eslint-config-standard/createAliasSetting')
    
    module.exports = {
      root: true,
      extends: [
        'plugin:vue/vue3-essential',
        '@vue/eslint-config-standard'
      ],
      rules: {
        'import/no-unresolved': 'error'
      }
      settings: {
        ...createAliasSetting({
          '@': `${path.resolve(__dirname, './src')}`
        })
      }
    }

    createAliasSetting accepts a map of aliases and their corresponding paths, and returns a settings object to be spread in to the settings field of the ESLint config.

    Install

    npm i @vue/eslint-config-standard

    DownloadsWeekly Downloads

    150,365

    Version

    8.0.1

    License

    MIT

    Unpacked Size

    6.81 kB

    Total Files

    7

    Last publish

    Collaborators

    • akryum
    • yyx990803
    • soda
    • michalsnik
    • mysticatea