File size: 6,025 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("../utils");
const ast_utils_1 = require("../utils/ast-utils");
const compat_1 = require("../utils/compat");
const TYPE_MESSAGES = {
normal: 'HTML elements',
void: 'HTML void elements',
component: 'Svelte custom components',
svelte: 'Svelte special elements'
};
exports.default = (0, utils_1.createRule)('html-self-closing', {
meta: {
docs: {
description: 'enforce self-closing style',
category: 'Stylistic Issues',
recommended: false,
conflictWithPrettier: true
},
type: 'layout',
fixable: 'code',
messages: {
requireClosing: 'Require self-closing on {{type}}.',
disallowClosing: 'Disallow self-closing on {{type}}.'
},
schema: [
{
anyOf: [
{
properties: {
void: {
enum: ['never', 'always', 'ignore']
},
normal: {
enum: ['never', 'always', 'ignore']
},
component: {
enum: ['never', 'always', 'ignore']
},
svelte: {
enum: ['never', 'always', 'ignore']
}
},
additionalProperties: false
},
{
enum: ['all', 'html', 'none']
}
]
}
]
},
create(context) {
let options = {
void: 'always',
normal: 'always',
component: 'always',
svelte: 'always'
};
const option = context.options?.[0];
switch (option) {
case 'none':
options = {
void: 'never',
normal: 'never',
component: 'never',
svelte: 'never'
};
break;
case 'html':
options = {
void: 'always',
normal: 'never',
component: 'never',
svelte: 'always'
};
break;
default:
if (typeof option !== 'object' || option === null)
break;
options = {
...options,
...option
};
break;
}
/**
* Get SvelteElement type.
* If element is custom component "component" is returned
* If element is svelte special element such as svelte:self "svelte" is returned
* If element is void element "void" is returned
* otherwise "normal" is returned
*/
function getElementType(node) {
if (node.kind === 'component')
return 'component';
if (node.kind === 'special')
return 'svelte';
if ((0, ast_utils_1.isVoidHtmlElement)(node))
return 'void';
return 'normal';
}
/**
* Returns true if element has no children, or has only whitespace text
*/
function isElementEmpty(node) {
if (node.children.length <= 0)
return true;
for (const child of node.children) {
if (child.type !== 'SvelteText')
return false;
if (!/^\s*$/.test(child.value))
return false;
}
return true;
}
/**
* Report
*/
function report(node, shouldBeClosed) {
const elementType = getElementType(node);
context.report({
node,
loc: {
start: (0, compat_1.getSourceCode)(context).getLocFromIndex(node.startTag.range[1] - (node.startTag.selfClosing ? 2 : 1)),
end: node.loc.end
},
messageId: shouldBeClosed ? 'requireClosing' : 'disallowClosing',
data: {
type: TYPE_MESSAGES[elementType]
},
*fix(fixer) {
if (shouldBeClosed) {
for (const child of node.children) {
yield fixer.removeRange(child.range);
}
yield fixer.insertTextBeforeRange([node.startTag.range[1] - 1, node.startTag.range[1]], '/');
if (node.endTag)
yield fixer.removeRange(node.endTag.range);
}
else {
yield fixer.removeRange([node.startTag.range[1] - 2, node.startTag.range[1] - 1]);
if (!(0, ast_utils_1.isVoidHtmlElement)(node))
yield fixer.insertTextAfter(node, `</${(0, ast_utils_1.getNodeName)(node)}>`);
}
}
});
}
return {
SvelteElement(node) {
if (!isElementEmpty(node))
return;
const elementType = getElementType(node);
const elementTypeOptions = options[elementType];
if (elementTypeOptions === 'ignore')
return;
const shouldBeClosed = elementTypeOptions === 'always';
if (shouldBeClosed && !node.startTag.selfClosing) {
report(node, true);
}
else if (!shouldBeClosed && node.startTag.selfClosing) {
report(node, false);
}
}
};
}
});
|