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.

Sign up for GitHub

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

Jump to bottom

feat(compiler): take the comments option to fully control whether to keep comment nodes #3395

Closed
wants to merge 5 commits into from
Closed

feat(compiler): take the comments option to fully control whether to keep comment nodes #3395

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
aa498e9
feat(compiler): take the comments option to fully control whether to …
HcySunYang Mar 9, 2021
71c878f
chore: fit comments
HcySunYang Mar 9, 2021
8c801f1
fix: types
HcySunYang Mar 9, 2021
8d68a9e
chore: adjust the if branch
HcySunYang Mar 22, 2021
f246ea8
chore: tweak comments
HcySunYang Mar 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 3 additions & 9 deletions packages/compiler-core/__tests__/parse.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,23 +377,17 @@ describe('compiler: parse', () => {
})

test('comments option', () => {
__DEV__ = false
const astDefaultComment = baseParse('<!--abc-->')
const astNoComment = baseParse('<!--abc-->', { comments: false })
const astWithComments = baseParse('<!--abc-->', { comments: true })
__DEV__ = true
const astNoComment = baseParse('<!--abc-->', { comments: false })

expect(astDefaultComment.children).toHaveLength(0)
expect(astNoComment.children).toHaveLength(0)
expect(astWithComments.children).toHaveLength(1)
expect(astNoComment.children).toHaveLength(0)
})

// #2217
test('comments in the <pre> tag should be removed in production mode', () => {
__DEV__ = false
const rawText = `<p/><!-- foo --><p/>`
const ast = baseParse(`<pre>${rawText}</pre>`)
__DEV__ = true
const ast = baseParse(`<pre>${rawText}</pre>`, { comments: false })

expect((ast.children[0] as ElementNode).children).toMatchObject([
{
Expand Down
19 changes: 10 additions & 9 deletions packages/compiler-core/src/parse.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ export const defaultParserOptions: MergedParserOptions = {
decodeEntities: (rawText: string): string =>
rawText.replace(decodeRE, (_, p1) => decodeMap[p1]),
onError: defaultOnError,
comments: false
// only keep comment nodes in DEV by default
comments: __DEV__
}

export const enum TextModes {
Expand Down Expand Up @@ -99,9 +100,13 @@ function createParserContext(
rawOptions: ParserOptions
): ParserContext {
const options = extend({}, defaultParserOptions)
for (const key in rawOptions) {
let key: keyof ParserOptions
for (key in rawOptions) {
// @ts-ignore
options[key] = rawOptions[key] || defaultParserOptions[key]
options[key] =
rawOptions[key] === undefined
HcySunYang marked this conversation as resolved.
Show resolved Hide resolved
? defaultParserOptions[key]
: rawOptions[key]
}
return {
options,
Expand Down Expand Up @@ -237,12 +242,8 @@ function parseChildren(
node.content = node.content.replace(/[\t\r\n\f ]+/g, ' ')
}
}
// also remove comment nodes in prod by default
if (
!__DEV__ &&
node.type === NodeTypes.COMMENT &&
!context.options.comments
) {
// comment nodes handling
if (node.type === NodeTypes.COMMENT && !context.options.comments) {
HcySunYang marked this conversation as resolved.
Show resolved Hide resolved
removedWhitespace = true
nodes[i] = null as any
}
Expand Down