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: ignore anchor tags in multiline rule #738

Merged
merged 8 commits into from Feb 3, 2019
Merged

feat: ignore anchor tags in multiline rule #738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
77e5e5b
feat: ignore anchor tags in multiline rule
manniL Dec 24, 2018
600e257
Update singleline-html-element-content-newline.js
manniL Dec 24, 2018
8cc5364
Update singleline-html-element-content-newline.md
manniL Dec 30, 2018
ab13973
Update multiline-html-element-content-newline.md
manniL Dec 30, 2018
b1e2b6f
feat(singleline-html-element-content-newline): Ignore all inline elem…
michalsnik Jan 7, 2019
6541f67
feat(multiline-html-element-content-newline): Ignore all inline elements
michalsnik Jan 7, 2019
e7578ba
chore(*-element-content-newline): Simplify configuration
michalsnik Jan 26, 2019
6764e62
Merge branch 'master' into patch-1
michalsnik Jan 29, 2019
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
12 changes: 8 additions & 4 deletions docs/rules/multiline-html-element-content-newline.md
View file
Open in desktop
Expand Up @@ -74,23 +74,27 @@ This rule enforces a line break before and after the contents of a multiline ele

## :wrench: Options

```json
```js
{
"vue/multiline-html-element-content-newline": ["error", {
"ignoreWhenEmpty": true,
"ignores": ["pre", "textarea"],
"ignores": ["pre", "textarea", ...INLINE_ELEMENTS],
"allowEmptyLines": false
}]
}
```

- `ignoreWhenEmpty` ... disables reporting when element has no content.
default `true`
- `ignores` ... the configuration for element names to ignore line breaks style.
default `["pre", "textarea"]`
- `ignores` ... the configuration for element names to ignore line breaks style.
default `["pre", "textarea", ...INLINE_ELEMENTS]`.
- `allowEmptyLines` ... if `true`, it allows empty lines around content. If you want to disallow multiple empty lines, use [no-multiple-empty-lines] in combination.
default `false`

::: info
All inline non void elements can be found [here](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/utils/inline-non-void-elements.json).
:::

### `"ignores": ["VueComponent", "pre", "textarea"]`

<eslint-code-block fix :rules="{'vue/multiline-html-element-content-newline': ['error', { ignores: ['VueComponent', 'pre', 'textarea'] }]}">
Expand Down
13 changes: 9 additions & 4 deletions docs/rules/singleline-html-element-content-newline.md
View file
Open in desktop
Expand Up @@ -50,12 +50,12 @@ This rule enforces a line break before and after the contents of a singleline el

## :wrench: Options

```json
```js
{
"vue/singleline-html-element-content-newline": ["error", {
"ignoreWhenNoAttributes": true,
"ignoreWhenEmpty": true,
"ignores": ["pre", "textarea"]
"ignores": ["pre", "textarea", ...INLINE_ELEMENTS]
}]
}
```
Expand All @@ -64,8 +64,13 @@ This rule enforces a line break before and after the contents of a singleline el
default `true`
- `ignoreWhenEmpty` ... disables reporting when element has no content.
default `true`
- `ignores` ... the configuration for element names to ignore line breaks style.
default `["pre", "textarea"]`
- `ignores` ... the configuration for element names to ignore line breaks style.
default `["pre", "textarea", ...INLINE_ELEMENTS]`.


::: info
All inline non void elements can be found [here](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/utils/inline-non-void-elements.json).
:::


### `"ignoreWhenNoAttributes": true`
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/multiline-html-element-content-newline.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@

const utils = require('../utils')
const casing = require('../utils/casing')
const INLINE_ELEMENTS = require('../utils/inline-non-void-elements.json')

// ------------------------------------------------------------------------------
// Helpers
Expand All @@ -21,7 +22,7 @@ function isMultilineElement (element) {

function parseOptions (options) {
return Object.assign({
ignores: ['pre', 'textarea'],
ignores: ['pre', 'textarea'].concat(INLINE_ELEMENTS),
ignoreWhenEmpty: true,
allowEmptyLines: false
}, options)
Expand Down
3 changes: 2 additions & 1 deletion lib/rules/singleline-html-element-content-newline.js
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@

const utils = require('../utils')
const casing = require('../utils/casing')
const INLINE_ELEMENTS = require('../utils/inline-non-void-elements.json')

// ------------------------------------------------------------------------------
// Helpers
Expand All @@ -21,7 +22,7 @@ function isSinglelineElement (element) {

function parseOptions (options) {
return Object.assign({
ignores: ['pre', 'textarea'],
ignores: ['pre', 'textarea'].concat(INLINE_ELEMENTS),
ignoreWhenNoAttributes: true,
ignoreWhenEmpty: true
}, options)
Expand Down
40 changes: 40 additions & 0 deletions lib/utils/inline-non-void-elements.json
View file
Open in desktop
@@ -0,0 +1,40 @@
[
"a",
"abbr",
"audio",
"b",
"bdi",
"bdo",
"canvas",
"cite",
"code",
"data",
"del",
"dfn",
"em",
"i",
"iframe",
"ins",
"kbd",
"label",
"map",
"mark",
"noscript",
"object",
"output",
"picture",
"q",
"ruby",
"s",
"samp",
"small",
"span",
"strong",
"sub",
"sup",
"svg",
"time",
"u",
"var",
"video"
]
89 changes: 82 additions & 7 deletions tests/lib/rules/multiline-html-element-content-newline.js
View file
Open in desktop
Expand Up @@ -44,15 +44,80 @@ tester.run('multiline-html-element-content-newline', rule, {
<div class="panel">
content
</div>
</template>`,
</template>
`,
`
<template>
<div
class="panel"
>
content
</div>
</template>`,
</template>
`,
`
<template>
<a
href="/"
class="link"
>Home</a>
</template>
`,
`
<template>
<a
href="/"
class="link"
>Home
</a>
</template>
`,
`
<template>
<a
href="/"
class="link"
>
Home
</a>
</template>
`,
`
<template>
<div>
<label
for="test"
class="label"
>Foo</label>
<input id="test">
</div>
</template>
`,
`
<template>
<div>
<label
for="test"
class="label"
>Foo
</label>
<input id="test">
</div>
</template>
`,
`
<template>
<div>
<label
for="test"
class="label"
>
Foo
</label>
<input id="test">
</div>
</template>
`,
`
<template>
<div>
Expand All @@ -61,17 +126,23 @@ tester.run('multiline-html-element-content-newline', rule, {
content
</div>
</div>
</template>`,
`<div>multiline end tag</div
>`,
</template>
`,
`
<div>multiline end tag</div
>
`,

// empty
`<template><div class="panel"></div></template>`,
`
<template>
<div
class="panel">
</div>
</template>`,
</template>
`,

// allowEmptyLines
{
code: `
Expand Down Expand Up @@ -109,11 +180,14 @@ tester.run('multiline-html-element-content-newline', rule, {
</template>`,
options: [{ allowEmptyLines: true }]
},

// self closing
`
<template>
<self-closing />
</template>`,
</template>
`,

// ignores
`
<template>
Expand Down Expand Up @@ -180,6 +254,7 @@ tester.run('multiline-html-element-content-newline', rule, {
ignores: ['IgnoreTag']
}]
},

// Ignore if no closing brackets
`
<template>
Expand Down
33 changes: 27 additions & 6 deletions tests/lib/rules/singleline-html-element-content-newline.js
View file
Open in desktop
Expand Up @@ -33,39 +33,59 @@ tester.run('singleline-html-element-content-newline', rule, {
<div class="panel">
content
</div>
</template>`,
</template>
`,
`
<template>
<div class="panel">
<div>
</div>
</div>
</template>`,
</template>
`,
`
<template>
<div class="panel">
<!-- comment -->
</div>
</template>`,
</template>
`,
`
<template>
<div>
content
</div>
</template>`,
</template>
`,
`
<template>
<div>
<div>
</div>
</div>
</template>`,
</template>
`,
`
<template>
<div>
<!-- comment -->
</div>
</template>`,
</template>
`,
`
<template>
<a href="/">Home</a>
</template>
`,
`
<template>
<form>
<label for="test">Home</label>
<input id="test" name="test">
</form>
</template>
`,

// ignoreWhenNoAttributes: true
`
<template>
Expand All @@ -91,6 +111,7 @@ tester.run('singleline-html-element-content-newline', rule, {
<template>
<div> </div>
</template>`,

// ignoreWhenNoAttributes: false
{
code: `
Expand Down