eslint-plugin-better-tailwindcss
Version:
auto-wraps tailwind classes after a certain print width or class count into multiple lines to improve readability.
105 lines • 4.48 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.noRestrictedClasses = void 0;
exports.getOptions = getOptions;
const default_options_js_1 = require("../options/default-options.js");
const descriptions_js_1 = require("../options/descriptions.js");
const options_js_1 = require("../utils/options.js");
const rule_js_1 = require("../utils/rule.js");
const utils_js_1 = require("../utils/utils.js");
const defaultOptions = {
attributes: default_options_js_1.DEFAULT_ATTRIBUTE_NAMES,
callees: default_options_js_1.DEFAULT_CALLEE_NAMES,
restrict: [],
tags: default_options_js_1.DEFAULT_TAG_NAMES,
variables: default_options_js_1.DEFAULT_VARIABLE_NAMES
};
const DOCUMENTATION_URL = "https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/rules/no-restricted-classes.md";
exports.noRestrictedClasses = {
name: "no-restricted-classes",
rule: {
create: ctx => (0, rule_js_1.createRuleListener)(ctx, getOptions(ctx), lintLiterals),
meta: {
docs: {
description: "Disallow restricted classes.",
recommended: false,
url: DOCUMENTATION_URL
},
schema: [
{
additionalProperties: false,
properties: {
...descriptions_js_1.CALLEE_SCHEMA,
...descriptions_js_1.ATTRIBUTE_SCHEMA,
...descriptions_js_1.VARIABLE_SCHEMA,
...descriptions_js_1.TAG_SCHEMA,
restrict: {
items: {
anyOf: [
{
additionalProperties: false,
properties: {
message: {
default: undefined,
description: "The message to report when a class is restricted.",
type: "string"
},
pattern: {
description: "The regex pattern to match restricted classes.",
type: "string"
}
},
required: ["pattern"],
type: "object"
},
{
type: "string"
}
]
},
type: "array"
}
},
type: "object"
}
],
type: "problem"
}
}
};
function lintLiterals(ctx, literals) {
const { restrict: restrictions } = getOptions(ctx);
for (const literal of literals) {
const classes = literal.content;
const classNames = (0, utils_js_1.splitClasses)(classes);
for (const className of classNames) {
for (const restriction of restrictions) {
const pattern = typeof restriction === "string" ? restriction : restriction.pattern;
const message = typeof restriction === "string" ? undefined : restriction.message;
const matches = className.match(pattern);
if (!matches) {
continue;
}
ctx.report({
data: {
className
},
loc: (0, utils_js_1.getExactClassLocation)(literal, className),
message: message
? (0, utils_js_1.replacePlaceholders)(message, matches)
: "Restricted class: \"{{ className }}\"."
});
}
}
}
}
function getOptions(ctx) {
const options = ctx.options[0] ?? {};
const common = (0, options_js_1.getCommonOptions)(ctx);
const restrict = options.restrict ?? defaultOptions.restrict;
return {
...common,
restrict
};
}
//# sourceMappingURL=no-restricted-classes.js.map