Registry / testing / eslint-plugin-vue-types

eslint-plugin-vue-types

library2.1.0jsnpmunverified

eslint-plugin-vue-types integrates `vue-types` with `eslint-plugin-vue`, specifically addressing the `vue/require-default-prop` rule. It prevents ESLint from reporting errors for props defined using `vue-types` validators (e.g., `VueTypes.string` or `string().isRequired`). The plugin's current stable version is 2.1.0. It primarily serves environments using `eslint-plugin-vue` versions older than 7.0.0. For `eslint-plugin-vue@7` and later, this plugin is generally not needed as the upstream `vue/require-default-prop` rule inherently ignores call expressions and object properties, negating the problem this plugin solves. Its release cadence is sporadic, reacting to changes in its peer dependencies, especially `eslint-plugin-vue` and `vue-types`. A key differentiator is its focused scope on a single `vue-types`-specific rule extension.

testing

npm install eslint-plugin-vue-types

github ↗package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-VUE-

eslint-plugin-vue-types

testingjavascriptv2.1.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin configuration

✓ { "extends": ["plugin:vue/recommended", "plugin:vue-types/recommended"] }

✗ { "plugins": ["vue-types"] }

The plugin is typically applied via an `extends` configuration preset, not directly via the `plugins` array. Ensure it's placed AFTER `plugin:vue/*` presets.

settings.vue-types/namespace

✓ { "settings": { "vue-types/namespace": ["AppTypes"] } }

✗ { "rules": { "vue-types/require-default-prop": ["error", { "namespace": ["AppTypes"] }] } }

Custom namespaces for `vue-types` validators are configured via the `settings` object in `.eslintrc.json`, not directly in the rule configuration.

settings.vue-types/sources

✓ { "settings": { "vue-types/sources": ["~/utils/prop-types"] } }

✗ { "rules": { "vue-types/require-default-prop": ["error", { "sources": ["~/utils/prop-types"] }] } }

Custom import sources for individual `vue-types` validators are configured via the `settings` object in `.eslintrc.json`.

Demonstrates the `.eslintrc.json` configuration for `eslint-plugin-vue-types` and a Vue component showcasing how the plugin prevents `vue/require-default-prop` errors for `vue-types` definitions, including custom namespaces and import sources.

{ "root": true, "env": { "node": true }, "extends": [ "plugin:vue/recommended", "plugin:vue-types/recommended" ], "parserOptions": { "ecmaVersion": 2020 }, "rules": { "vue/require-default-prop": "error" // Ensure the base rule is active }, "settings": { "vue-types/namespace": ["AppTypes"], "vue-types/sources": ["./src/prop-validators"] } } // src/App.vue <template> <div>{{ msg1 }} {{ msg2 }}</div> </template> <script> import VueTypes, { string } from 'vue-types'; import { customProp } from './prop-validators'; const AppTypes = { theme: VueTypes.oneOf(['dark', 'light']) }; export default { props: { msg1: string().isRequired, // No error with plugin msg2: VueTypes.string, // No error with plugin msg3: AppTypes.theme, // No error with custom namespace msg4: customProp().isRequired // No error with custom source } }; </script> // src/prop-validators.js import VueTypes from 'vue-types'; export const customProp = () => VueTypes.bool;

Debug

Known issues

breakingVersion 1.0.0 dropped support for Node.js 4. Users on older Node.js versions must remain on `eslint-plugin-vue-types` < 1.0.0.

fix

Upgrade Node.js to version 10 or higher, or downgrade `eslint-plugin-vue-types` to a version prior to 1.0.0.

affects: >=1.0.0

deprecatedThis plugin is largely obsolete for users running `eslint-plugin-vue@7` or higher. The upstream `vue/require-default-prop` rule in newer `eslint-plugin-vue` versions inherently ignores prop assignments by call expressions or object properties, making this plugin's functionality redundant.

fix

Consider upgrading `eslint-plugin-vue` to version 7 or later. If you do, you can likely remove `eslint-plugin-vue-types` from your project as it will no longer be necessary.

affects: >=2.0.0

gotchaThe `.isRequired` flag must always be the last call in the chain of `vue-types` validators for this plugin to correctly suppress `vue/require-default-prop` errors. Incorrect ordering, such as `.isRequired` followed by other modifiers (e.g., `.loose`), will result in an ESLint error.

fix

Always place `.isRequired` at the very end of your `vue-types` validator chain, e.g., `shape({}).loose.isRequired` is correct, while `shape({}).isRequired.loose` is incorrect.

affects: >=1.0.0

gotchaIf using custom `vue-types` namespaces (e.g., `AppTypes.theme`), you must explicitly configure these namespaces in the plugin's `settings` via `vue-types/namespace` in your `.eslintrc.json` file. Without this, the plugin will not recognize them and will report `vue/require-default-prop` errors.

fix

Add `"vue-types/namespace": ["MyCustomNamespace"]` to the `settings` object in your ESLint configuration.

affects: >=1.0.0

gotchaWhen importing individual `vue-types` validators from a custom module (not `vue-types` itself), you need to specify these custom import sources in the plugin's `settings` via `vue-types/sources` in your `.eslintrc.json`. Otherwise, `vue/require-default-prop` errors will be reported.

fix

Add `"vue-types/sources": ["~/utils/prop-types"]` to the `settings` object in your ESLint configuration, pointing to your custom validator modules.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Failed to load parser '@typescript-eslint/parser' declared in '.eslintrc.js'.

Early versions (prior to 1.0.1) of `eslint-plugin-vue-types` had compatibility issues when used alongside `@typescript-eslint/parser`.

fix

Upgrade `eslint-plugin-vue-types` to version 1.0.1 or newer to resolve the `@typescript-eslint/parser` compatibility bug.

Missing required prop: "myProp" vue/require-default-prop

The `vue/require-default-prop` rule from `eslint-plugin-vue` is active and not correctly suppressed by `eslint-plugin-vue-types` for `vue-types` definitions, often due to incorrect configuration or a too-old `eslint-plugin-vue` version.

fix

Ensure `plugin:vue-types/recommended` is included in your `extends` array *after* any `plugin:vue/*` presets. Verify that `eslint-plugin-vue` is at least version `^6.0.0` as required by peer dependencies. Also, check `.isRequired` placement and custom settings.

Upgrade

Version history

2.1.0latest on npm

Audit

Dependencies

eslintrequiredPeer dependency for ESLint functionality

eslint-plugin-vuerequiredPeer dependency for extending Vue-specific ESLint rules

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/dwightjack/eslint-plugin-vue-types ↗

packagehttps://www.npmjs.com/package/eslint-plugin-vue-types ↗