Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support custom blocks in SFC parser #4157

Merged
merged 1 commit into from
Nov 20, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions flow/compiler.js
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,16 @@ declare type SFCDescriptor = {
template: ?SFCBlock;
script: ?SFCBlock;
styles: Array<SFCBlock>;
customBlocks: Array<SFCCustomBlock>;
}

declare type SFCCustomBlock = {
type: string;
content: string;
start?: number;
end?: number;
src?: string;
attrs: {[attribute:string]: string};
}

declare type SFCBlock = {
Expand Down
44 changes: 29 additions & 15 deletions src/sfc/parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,11 @@ export function parseComponent (
const sfc: SFCDescriptor = {
template: null,
script: null,
styles: []
styles: [],
customBlocks: []
}
let depth = 0
let currentBlock: ?SFCBlock = null
let currentBlock: ?(SFCBlock | SFCCustomBlock) = null

function start (
tag: string,
Expand All @@ -34,17 +35,30 @@ export function parseComponent (
start: number,
end: number
) {
if (isSpecialTag(tag) && depth === 0) {
currentBlock = {
type: tag,
content: '',
start: end
}
checkAttrs(currentBlock, attrs)
if (tag === 'style') {
sfc.styles.push(currentBlock)
} else {
sfc[tag] = currentBlock
if (depth === 0) {
if (isSpecialTag(tag)) {
currentBlock = {
type: tag,
content: '',
start: end
}
checkAttrs(currentBlock, attrs)
if (tag === 'style') {
sfc.styles.push(currentBlock)
} else {
sfc[tag] = currentBlock
}
} else { // custom blocks
currentBlock = {
type: tag,
content: '',
start: end,
attrs: attrs.reduce((cumulated, { name, value }) => {
cumulated[name] = value
return cumulated
}, Object.create(null))
}
sfc.customBlocks.push(currentBlock)
}
}
if (!unary) {
Expand All @@ -71,7 +85,7 @@ export function parseComponent (
}

function end (tag: string, start: number, end: number) {
if (isSpecialTag(tag) && depth === 1 && currentBlock) {
if (depth === 1 && currentBlock) {
currentBlock.end = start
let text = deindent(content.slice(currentBlock.start, currentBlock.end))
// pad content so that linters and pre-processors can output correct
Expand All @@ -85,7 +99,7 @@ export function parseComponent (
depth--
}

function padContent (block: SFCBlock) {
function padContent (block: SFCBlock | SFCCustomBlock) {
const offset = content.slice(0, block.start).split(splitRE).length
const padChar = block.type === 'script' && !block.lang
? '//\n'
Expand Down
46 changes: 46 additions & 0 deletions test/unit/modules/sfc/sfc-parser.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,50 @@ describe('Single File Component parser', () => {
`)
expect(res.template.content.trim()).toBe(`div\n h1(v-if='1 < 2') hello`)
})

it('should handle custom blocks without without parsing them', () => {
const res = parseComponent(`
<template>
<div></div>
</template>
<example name="simple">
<my-button ref="button">Hello</my-button>
</example>
<example name="with props">
<my-button color="red">Hello</my-button>
</example>
<test name="simple" foo="bar">
export default function simple (vm) {
describe('Hello', () => {
it('should display Hello', () => {
this.vm.$refs.button.$el.innerText.should.equal('Hello')
}))
}))
}
</test>
`)
expect(res.customBlocks.length).toBe(3)

const simpleExample = res.customBlocks[0]
expect(simpleExample.type).toBe('example')
expect(simpleExample.content.trim()).toBe('<my-button ref="button">Hello</my-button>')
expect(simpleExample.attrs.name).toBe('simple')

const withProps = res.customBlocks[1]
expect(withProps.type).toBe('example')
expect(withProps.content.trim()).toBe('<my-button color="red">Hello</my-button>')
expect(withProps.attrs.name).toBe('with props')

const simpleTest = res.customBlocks[2]
expect(simpleTest.type).toBe('test')
expect(simpleTest.content.trim()).toBe(`export default function simple (vm) {
describe('Hello', () => {
it('should display Hello', () => {
this.vm.$refs.button.$el.innerText.should.equal('Hello')
}))
}))
}`)
expect(simpleTest.attrs.name).toBe('simple')
expect(simpleTest.attrs.foo).toBe('bar')
})
})