Skip to content

Fix: html-indent about comments (fixes #241) #280

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

Merged
merged 1 commit into from
Dec 17, 2017
Merged

Fix: html-indent about comments (fixes #241) #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
44 changes: 38 additions & 6 deletions lib/rules/html-indent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,26 @@ function isBeginningOfLine (node, index, nodes) {
return false
}

/**
* Check whether a given token is a closing token which triggers unindent.
* @param {Token} token The token to check.
* @returns {boolean} `true` if the token is a closing token.
*/
function isClosingToken (token) {
return token != null && (
token.type === 'HTMLEndTagOpen' ||
token.type === 'VExpressionEnd' ||
(
token.type === 'Punctuator' &&
(
token.value === ')' ||
token.value === '}' ||
token.value === ']'
)
)
)
}

/**
* Creates AST event handlers for html-indent.
*
Expand Down Expand Up @@ -504,9 +524,10 @@ function create (context) {
* Validate the given token with the pre-calculated expected indentation.
* @param {Token} token The token to validate.
* @param {number} expectedIndent The expected indentation.
* @param {number|undefined} optionalExpectedIndent The optional expected indentation.
* @returns {void}
*/
function validateCore (token, expectedIndent) {
function validateCore (token, expectedIndent, optionalExpectedIndent) {
const line = token.loc.start.line
const actualIndent = token.loc.start.column
const indentText = getIndentText(token)
Expand All @@ -530,7 +551,7 @@ function create (context) {
}
}

if (actualIndent !== expectedIndent) {
if (actualIndent !== expectedIndent && (optionalExpectedIndent === undefined || actualIndent !== optionalExpectedIndent)) {
context.report({
loc: {
start: { line, column: 0 },
Expand All @@ -553,9 +574,10 @@ function create (context) {
* Validate indentation of the line that the given tokens are on.
* @param {Token[]} tokens The tokens on the same line to validate.
* @param {Token[]} comments The comments which are on the immediately previous lines of the tokens.
* @param {Token|null} lastToken The last validated token. Comments can adjust to the token.
* @returns {void}
*/
function validate (tokens, comments) {
function validate (tokens, comments, lastToken) {
// Calculate and save expected indentation.
const firstToken = tokens[0]
const actualIndent = firstToken.loc.start.column
Expand Down Expand Up @@ -604,9 +626,17 @@ function create (context) {
}
}

// Calculate the expected indents for comments.
// It allows the same indent level with the previous line.
const lastOffsetInfo = offsets.get(lastToken)
const lastExpectedIndent = lastOffsetInfo && lastOffsetInfo.expectedIndent
const commentExpectedIndents = (typeof lastExpectedIndent === 'number' && isClosingToken(firstToken))
? { primary: lastExpectedIndent, secondary: expectedIndent }
: { primary: expectedIndent, secondary: undefined }

// Validate.
for (const comment of comments) {
validateCore(comment, expectedIndent)
validateCore(comment, commentExpectedIndents.primary, commentExpectedIndents.secondary)
}
validateCore(firstToken, expectedIndent)
}
Expand Down Expand Up @@ -1142,6 +1172,7 @@ function create (context) {
let tokensOnSameLine = []
let isBesideMultilineToken = false
let first = true
let lastValidatedToken = null

// Validate indentation of tokens.
for (const token of template.getTokens(node, { includeComments: true, filter: isNotWhitespace })) {
Expand All @@ -1168,15 +1199,16 @@ function create (context) {
}
}

validate(tokensOnSameLine, comments)
validate(tokensOnSameLine, comments, lastValidatedToken)
lastValidatedToken = tokensOnSameLine[0]
}
isBesideMultilineToken = last(tokensOnSameLine).loc.end.line === token.loc.start.line
tokensOnSameLine = [token]
comments = []
}
}
if (tokensOnSameLine.length >= 1 && tokensOnSameLine.some(isNotComment)) {
validate(tokensOnSameLine, comments)
validate(tokensOnSameLine, comments, lastValidatedToken)
}
}
}))
Expand Down
97 changes: 97 additions & 0 deletions tests/lib/rules/html-indent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1290,6 +1290,46 @@ tester.run('html-indent', rule, {
}}
</template>
`,
unIndent`
<template>
{{
message
// comment
// comment
}}
<!-- comment -->
</template>
`,
unIndent`
<template>
{{
message
/*
* comment
*/
}}
</template>
`,
unIndent`
<template>
{{
message
// comment
// comment
}}
<!-- comment -->
</template>
`,
unIndent`
<template>
{{
message
/*
* comment
*/
}}
</template>
`,

// Ignores
{
Expand Down Expand Up @@ -4246,6 +4286,63 @@ tester.run('html-indent', rule, {
{ message: 'Expected indentation of 4 spaces but found 2 spaces.', line: 6 }
]
},
{
code: unIndent`
<template>
{{
message
// comment
// comment
}}
<!-- comment -->
</template>
`,
output: unIndent`
<template>
{{
message
// comment
// comment
}}
<!-- comment -->
</template>
`,
errors: [
{ message: 'Expected indentation of 2 spaces but found 0 spaces.', line: 2 },
{ message: 'Expected indentation of 4 spaces but found 0 spaces.', line: 3 },
{ message: 'Expected indentation of 4 spaces but found 0 spaces.', line: 4 },
{ message: 'Expected indentation of 4 spaces but found 0 spaces.', line: 5 },
{ message: 'Expected indentation of 2 spaces but found 0 spaces.', line: 6 }
]
},
{
code: unIndent`
<template>
{{
message
/*
* comment
*/
}}
</template>
`,
output: unIndent`
<template>
{{
message
/*
* comment
*/
}}
</template>
`,
errors: [
{ message: 'Expected indentation of 2 spaces but found 0 spaces.', line: 2 },
{ message: 'Expected indentation of 4 spaces but found 0 spaces.', line: 3 },
{ message: 'Expected indentation of 4 spaces but found 0 spaces.', line: 4 },
{ message: 'Expected indentation of 2 spaces but found 0 spaces.', line: 7 }
]
},

// Ignores
{
Expand Down