no-invalid-vue-prop-keys.md

Require valid keys in Vue props options (no-invalid-vue-prop-keys)

Invalid keys are often a result of misspelling. For example, require ought to be required.

Options

This rule has an object option:

• "allows" allows specified keys

Fail

export default {
  props: {
    foo: {
      type: Object,
      require: true,
    },
  },
}

export default {
  props: {
    foo: {
      type: Object,
      validate(value) {
        return !value.disabled
      },
    },
  },
}

Pass

export default {
  props: {
    foo: {
      type: String,
      default: '',
    },
  },
}

export default {
  props: {
    foo: {
      type: Object,
      required: true,
    },
  },
}

export default {
  props: ['foo'],
}

/* eslint galaxy/no-invalid-vue-prop-keys: ["error", { "allows": ["comment"] }] */
export default {
  props: {
    foo: {
      type: Object,
      required: true,
      comment: 'Foo from parent',
    },
  },
}