Rule Options

With Vite+, configure lint.vize.ruleOptions in vite.config.ts and run vp run lint. The standalone compatibility config uses the same values under linter.ruleOptions.

linter.ruleOptions holds typed project-local settings for rules that accept options. Unknown option fields are rejected, and later matching config entries replace the full option object for the same rule. Set severity separately under linter.rules; options only describe how an enabled rule should behave unless noted below.

Use the native lint execution guide to select rules and their severity before adjusting the options below.

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({
  "lint": {
    "vize": {
      "rules": {
        "script/no-restricted-globals": "error",
        "vue/html-self-closing": "warn",
        "musea/prefer-design-tokens": "warn"
      },
      "ruleOptions": {
        "script/no-restricted-globals": {
          "globals": [
            {
              "name": "process",
              "message": "Read env via a typed helper."
            },
            {
              "name": "alert"
            }
          ]
        },
        "vue/html-self-closing": {
          "html": {
            "void": "always",
            "normal": "never",
            "component": "always"
          },
          "svg": "always",
          "math": "always"
        },
        "musea/prefer-design-tokens": {
          "tokens": [
            {
              "path": "color.primary",
              "value": "#3b82f6",
              "tier": "semantic"
            }
          ]
        }
      }
    }
  }
});

Rule	Option shape	Defaults and behavior
`html/no-empty-palpable-content`	`{ contentDirectives?: string[] }`	Defaults to an empty list. Exact bare names identify directives that supply visible content. Rule enablement remains separate.
`script/no-restricted-globals`	`{ globals?: Array<{ name: string; message?: string }> }`	Without options, the built-in deny list is `process`, `localStorage`, and `sessionStorage`. A non-empty `globals` list replaces that built-in list.
`script/no-restricted-members`	`{ members?: Array<{ object: string; property: string; message?: string }> }`	Off unless `members` is configured and the rule is enabled. A missing `message` uses the generic diagnostic help.
`vue/valid-v-on`	`{ modifiers?: string[] }`	Defaults to an empty list. Adds exact, case-sensitive custom names to the built-in modifiers; it does not enable the rule or permit a missing handler. Scoped entries replace the inherited list, and `[]` clears it. See the complete modifier example.
`vue/component-name-in-template-casing`	`{ casing?: "PascalCase" \| "kebab-case", registeredComponentsOnly?: boolean, globals?: string[] }`	Defaults to `PascalCase`, registered components only, and no literal globals.
`script/custom-event-name-casing`	`{ casing?: "camelCase" \| "kebab-case" }`	Defaults to `camelCase`.
`script/define-props-destructuring`	`{ destructure?: "only-when-assigned" \| "always" \| "never" }`	Defaults to `only-when-assigned`. `always` also checks bare calls; `never` requires props-object access. Vue 3.5 destructuring preserves reactivity.
`vue/no-mutating-props`	`{ shallowOnly?: boolean }`	Defaults to `false`; `true` allows nested mutation while still disallowing direct prop reassignment.
`vue/require-component-registration`	`{ globals?: string[] }`	Explicit application/preview component names; accepts PascalCase and kebab-case spellings. Options do not enable the rule.
`vue/sfc-element-order`	`{ order?: Array<string \| string[]> }`	Defaults to `[["script", "template"], "style"]`. A nested array means any of those block selectors may appear at that rank.
`vue/html-self-closing`	`{ html?: { void?: Style; normal?: Style; component?: Style }; svg?: Style; math?: Style }`, where `Style` is `"always"`, `"never"`, or `"any"`	Defaults are `html.void: "always"`, `html.normal: "any"`, `html.component: "always"`, `svg: "always"`, and `math: "always"`.
`vue/v-on-event-hyphenation`	`"always" \| "never"`	Configures whether event listener names should be hyphenated.
`vue/attribute-hyphenation`	`"always" \| "never"`	Configures whether component prop attributes should be hyphenated in templates.
`vue/valid-v-slot`	`{ allowModifiers?: boolean }`	Defaults to `false`. Permit static and dynamic named-slot modifiers with `true`; argless modifiers and references to the slot's own parameters remain invalid.
`musea/prefer-design-tokens`	`{ tokens?: Array<{ path: string; value: string; tier?: string }> }`	Off unless token data is configured and the rule is enabled or implicitly selected by a non-empty token list. `tier` defaults to `primitive`.
`type/strict-boolean-expressions`	`{ allowString?: boolean; allowNumber?: boolean; allowNullableObject?: boolean; allowNullableBoolean?: boolean; allowNullableString?: boolean; allowNullableNumber?: boolean; allowNullableEnum?: boolean; allowAny?: boolean }`	`allowString`, `allowNumber`, and `allowNullableObject` default to `true`; the other options default to `false`. Explicit rule enablement is required.

Detailed Examples

Type Rule Options: strict boolean conditions and nullable allowances.
Script Rule Options: restricted globals, restricted members, and custom event casing.
Vue Rule Options: component casing, prop mutation depth, SFC block order, self-closing tags, event names, and attribute casing.
Musea Rule Options: design-token inventory configuration.

`html/no-empty-palpable-content`

Custom directives may focus, style, or fill an element. List only the directives your project knows provide visible content. Use the exact template name without v-; arguments and modifiers do not change that name. Unlisted directives still leave an empty element reportable. An empty list restores the default behavior, and a matching scoped entry replaces the entire option object. This setting does not validate sanitization or enable the rule.

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({
  "lint": {
    "vize": {
      "rules": {
        "html/no-empty-palpable-content": "error"
      },
      "ruleOptions": {
        "html/no-empty-palpable-content": {
          "contentDirectives": [
            "safe-html"
          ]
        }
      }
    }
  }
});

Bad (unlisted content source):

<p v-sanitize="message" />

Good (configured provider):

<p v-safe-html="message" />

Scoped Entries

When entries match a file, their linter.ruleOptions overlay the root options for that file. Each configured rule option object replaces the same root object; arrays such as globals, members, order, and tokens are not concatenated across entries.

`vue/require-component-registration`

For components supplied by application plugins or Musea previewSetup, configure vue/require-component-registration with explicit global names:

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({
  lint: {
    vize: {
      "rules": {
        "vue/require-component-registration": "warn"
      },
      "ruleOptions": {
        "vue/require-component-registration": {
          "globals": [
            "MyButton",
            "MyIcon"
          ]
        }
      }
    },
  },
});

A name permits its PascalCase and kebab-case template spellings. The list uses component names; regular expressions are not interpreted. The same options apply to regular SFCs and Musea Art variants. Options alone do not enable the rule, and unknown components continue to be reported. A later config layer replaces the list; an empty list clears an inherited list.

Bad (unlisted component):

<MissingWidget />

Good (a configured global):

<MyButton />