Skip to content

Latest commit

 

History

History
103 lines (88 loc) · 2.47 KB

script-indent.md

File metadata and controls

103 lines (88 loc) · 2.47 KB

enforce consistent indentation in <script> (vue/script-indent)

  • 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

This rule is similar to core indent rule, but it has an option for inside of <script> tag.

Rule Details

This rule has some options.

{
  "script-indent": ["error", TYPE, {
    "baseIndent": 0,
    "switchCase": 0,
    "ignores": []
  }]
}
  • TYPE (number | "tab") ... The type of indentation. Default is 2. If this is a number, it's the number of spaces for one indent. If this is "tab", it uses one tab for one indent.
  • baseIndent (integer) ... The multiplier of indentation for top-level statements. Default is 0.
  • switchCase (integer) ... The multiplier of indentation for case/default clauses. Default is 0.
  • ignores (string[]) ... The selector to ignore nodes. The AST spec is here. You can use esquery to select nodes. Default is an empty array.

👍 Examples of correct code for this rule:

/*eslint script-indent: "error"*/
<script>
let a = {
  foo: 1,
  bar: 2
}
let b = {
      foo: 1,
      bar: 2
    },
    c = {
      foo: 1,
      bar: 2
    }
const d = {
        foo: 1,
        bar: 2
      },
      e = {
        foo: 1,
        bar: 2
      }
</script>

👍 Examples of correct code for this rule:

/*eslint script-indent: ["error", 2, {"baseIndent": 1}]*/
<script>
  let a = {
    foo: 1,
    bar: 2
  }
  let b = {
        foo: 1,
        bar: 2
      },
      c = {
        foo: 1,
        bar: 2
      }
  const d = {
          foo: 1,
          bar: 2
        },
        e = {
          foo: 1,
          bar: 2
        }
</script>

Important note

This rule only checks .vue files and does not interfere with other .js files. Unfortunately the default indent rule when turned on will try to lint both, so in order to make them complementary you can use overrides setting and disable indent rule on .vue files:

"rules": {
  "vue/script-indent": ["error", 4, { "baseIndent": 1 }]
},
"overrides": [
  {
    "files": ["*.vue"],
    "rules": {
      "indent": "off"
    }
  }
]

Related rules