feat(vModel): warn if v-model is used on file input (#295)

This commit is contained in:
Cr 2019-10-16 00:23:38 +08:00 committed by Evan You
parent 74d501829c
commit 8eba1aba08
3 changed files with 46 additions and 4 deletions

View File

@ -0,0 +1,28 @@
import { parse, transform, CompilerOptions } from '@vue/compiler-core'
import { transformModel } from '../../src/transforms/vModel'
import { transformElement } from '../../../compiler-core/src/transforms/transformElement'
import { DOMErrorCodes } from '../../src/errors'
function transformWithModel(template: string, options: CompilerOptions = {}) {
const ast = parse(template)
transform(ast, {
nodeTransforms: [transformElement],
directiveTransforms: {
model: transformModel
},
...options
})
return ast
}
describe('compiler: v-model transform', () => {
it('should raise error if used file input element', () => {
const onError = jest.fn()
transformWithModel(`<input type="file" v-model="test"></input>`, {
onError
})
expect(onError.mock.calls).toMatchObject([
[{ code: DOMErrorCodes.X_V_MODEL_ON_FILE_INPUT_ELEMENT }]
])
})
})

View File

@ -26,7 +26,8 @@ export const enum DOMErrorCodes {
X_V_TEXT_NO_EXPRESSION, X_V_TEXT_NO_EXPRESSION,
X_V_TEXT_WITH_CHILDREN, X_V_TEXT_WITH_CHILDREN,
X_V_MODEL_ON_INVALID_ELEMENT, X_V_MODEL_ON_INVALID_ELEMENT,
X_V_MODEL_ARG_ON_ELEMENT X_V_MODEL_ARG_ON_ELEMENT,
X_V_MODEL_ON_FILE_INPUT_ELEMENT
} }
export const DOMErrorMessages: { [code: number]: string } = { export const DOMErrorMessages: { [code: number]: string } = {
@ -35,5 +36,6 @@ export const DOMErrorMessages: { [code: number]: string } = {
[DOMErrorCodes.X_V_TEXT_NO_EXPRESSION]: `v-text is missing expression.`, [DOMErrorCodes.X_V_TEXT_NO_EXPRESSION]: `v-text is missing expression.`,
[DOMErrorCodes.X_V_TEXT_WITH_CHILDREN]: `v-text will override element children.`, [DOMErrorCodes.X_V_TEXT_WITH_CHILDREN]: `v-text will override element children.`,
[DOMErrorCodes.X_V_MODEL_ON_INVALID_ELEMENT]: `v-model can only be used on <input>, <textarea> and <select> elements.`, [DOMErrorCodes.X_V_MODEL_ON_INVALID_ELEMENT]: `v-model can only be used on <input>, <textarea> and <select> elements.`,
[DOMErrorCodes.X_V_MODEL_ARG_ON_ELEMENT]: `v-model argument is not supported on plain elements.` [DOMErrorCodes.X_V_MODEL_ARG_ON_ELEMENT]: `v-model argument is not supported on plain elements.`,
[DOMErrorCodes.X_V_MODEL_ON_FILE_INPUT_ELEMENT]: `v-model cannot used on file inputs since they are read-only. Use a v-on:change listener instead.`
} }

View File

@ -29,6 +29,7 @@ export const transformModel: DirectiveTransform = (dir, node, context) => {
if (tag === 'input' || tag === 'textarea' || tag === 'select') { if (tag === 'input' || tag === 'textarea' || tag === 'select') {
let directiveToUse = V_MODEL_TEXT let directiveToUse = V_MODEL_TEXT
let isInvalidType = false
if (tag === 'input') { if (tag === 'input') {
const type = findProp(node, `type`) const type = findProp(node, `type`)
if (type) { if (type) {
@ -43,6 +44,15 @@ export const transformModel: DirectiveTransform = (dir, node, context) => {
case 'checkbox': case 'checkbox':
directiveToUse = V_MODEL_CHECKBOX directiveToUse = V_MODEL_CHECKBOX
break break
case 'file':
isInvalidType = true
context.onError(
createDOMCompilerError(
DOMErrorCodes.X_V_MODEL_ON_FILE_INPUT_ELEMENT,
dir.loc
)
)
break
} }
} }
} }
@ -51,8 +61,10 @@ export const transformModel: DirectiveTransform = (dir, node, context) => {
} }
// inject runtime directive // inject runtime directive
// by returning the helper symbol via needRuntime // by returning the helper symbol via needRuntime
// the import will replace the resovleDirective call. // the import will replaced a resovleDirective call.
if (!isInvalidType) {
res.needRuntime = context.helper(directiveToUse) res.needRuntime = context.helper(directiveToUse)
}
} else { } else {
context.onError( context.onError(
createDOMCompilerError( createDOMCompilerError(