import { BindingTypes } from '@vue/compiler-core' import { SFCScriptCompileOptions } from '../src' import { compileSFCScript, assertCode } from './utils' describe('sfc props transform', () => { function compile(src: string, options?: Partial) { return compileSFCScript(src, { inlineTemplate: true, reactivityTransform: true, ...options }) } test('basic usage', () => { const { content, bindings } = compile(` `) expect(content).not.toMatch(`const { foo } =`) expect(content).toMatch(`console.log(__props.foo)`) expect(content).toMatch(`_toDisplayString(__props.foo)`) assertCode(content) expect(bindings).toStrictEqual({ foo: BindingTypes.PROPS }) }) test('nested scope', () => { const { content, bindings } = compile(` `) expect(content).not.toMatch(`const { foo, bar } =`) expect(content).toMatch(`console.log(foo)`) expect(content).toMatch(`console.log(__props.bar)`) assertCode(content) expect(bindings).toStrictEqual({ foo: BindingTypes.PROPS, bar: BindingTypes.PROPS, test: BindingTypes.SETUP_CONST }) }) test('default values w/ runtime declaration', () => { const { content } = compile(` `) // literals can be used as-is, non-literals are always returned from a // function expect(content).toMatch(`props: _mergeDefaults(['foo', 'bar'], { foo: 1, bar: () => ({}) })`) assertCode(content) }) test('default values w/ type declaration', () => { const { content } = compile(` `) // literals can be used as-is, non-literals are always returned from a // function expect(content).toMatch(`props: { foo: { type: Number, required: false, default: 1 }, bar: { type: Object, required: false, default: () => ({}) } }`) assertCode(content) }) test('default values w/ type declaration, prod mode', () => { const { content } = compile( ` `, { isProd: true } ) // literals can be used as-is, non-literals are always returned from a // function expect(content).toMatch(`props: { foo: { default: 1 }, bar: { default: () => ({}) }, baz: null, boola: { type: Boolean }, boolb: { type: [Boolean, Number] }, func: { type: Function, default: () => (() => {}) } }`) assertCode(content) }) test('aliasing', () => { const { content, bindings } = compile(` `) expect(content).not.toMatch(`const { foo: bar } =`) expect(content).toMatch(`let x = foo`) // should not process expect(content).toMatch(`let y = __props.foo`) // should convert bar to __props.foo in template expressions expect(content).toMatch(`_toDisplayString(__props.foo + __props.foo)`) assertCode(content) expect(bindings).toStrictEqual({ x: BindingTypes.SETUP_LET, y: BindingTypes.SETUP_LET, foo: BindingTypes.PROPS, bar: BindingTypes.PROPS_ALIASED, __propsAliases: { bar: 'foo' } }) }) // #5425 test('non-identifier prop names', () => { const { content, bindings } = compile(` `) expect(content).toMatch(`x = __props["foo.bar"]`) expect(content).toMatch(`toDisplayString(__props["foo.bar"])`) assertCode(content) expect(bindings).toStrictEqual({ x: BindingTypes.SETUP_LET, 'foo.bar': BindingTypes.PROPS, fooBar: BindingTypes.PROPS_ALIASED, __propsAliases: { fooBar: 'foo.bar' } }) }) test('rest spread', () => { const { content, bindings } = compile(` `) expect(content).toMatch( `const rest = _createPropsRestProxy(__props, ["foo","bar"])` ) assertCode(content) expect(bindings).toStrictEqual({ foo: BindingTypes.PROPS, bar: BindingTypes.PROPS, baz: BindingTypes.PROPS, rest: BindingTypes.SETUP_REACTIVE_CONST }) }) test('$$() escape', () => { const { content } = compile(` `) expect(content).toMatch(`const __props_foo = _toRef(__props, 'foo')`) expect(content).toMatch(`const __props_bar = _toRef(__props, 'bar')`) expect(content).toMatch(`console.log((__props_foo))`) expect(content).toMatch(`console.log((__props_bar))`) expect(content).toMatch(`({ foo: __props_foo, baz: __props_bar })`) assertCode(content) }) describe('errors', () => { test('should error on deep destructure', () => { expect(() => compile( `` ) ).toThrow(`destructure does not support nested patterns`) expect(() => compile( `` ) ).toThrow(`destructure does not support nested patterns`) }) test('should error on computed key', () => { expect(() => compile( `` ) ).toThrow(`destructure cannot use computed key`) }) test('should error when used with withDefaults', () => { expect(() => compile( `` ) ).toThrow(`withDefaults() is unnecessary when using destructure`) }) test('should error if destructure reference local vars', () => { expect(() => compile( `` ) ).toThrow(`cannot reference locally declared variables`) }) }) })