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

Fix custom classnames rule with VueJS objects within list. #359

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+95 −4
Open

Fix custom classnames rule with VueJS objects within list. #359

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1850c72
fix: no-custom-classname rule with VueJS objects within list.
Ericlm Sep 19, 2024
9f80169
test: adding tests for other props
Ericlm Sep 19, 2024
94514dd
chore: remove custom npm script
Ericlm Sep 19, 2024
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
5 changes: 1 addition & 4 deletions lib/util/ast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ function isVueValidAttributeValue(node) {
case isArrayExpression(node): // ['tw-unknown-class']
case isObjectExpression(node): // {'tw-unknown-class': true}
return true;
break;
default:
return false;
}
Expand Down Expand Up @@ -218,10 +217,8 @@ function extractValueFromNode(node) {
switch (node.value.expression.type) {
case 'ArrayExpression':
return node.value.expression.elements;
break;
case 'ObjectExpression':
return node.value.expression.properties;
break;
}
return node.value.expression.value;
default:
Expand Down Expand Up @@ -302,7 +299,7 @@ function parseNodeRecursive(rootNode, childNode, cb, skipConditional = false, is
return;
case 'ObjectExpression':
childNode.properties.forEach((prop) => {
const isUsedByClassNamesPlugin = rootNode.callee && rootNode.callee.name === 'classnames';
const isUsedByClassNamesPlugin = (rootNode.callee && rootNode.callee.name === 'classnames') || rootNode.type === 'VAttribute';
Copy link
Author

@Ericlm Ericlm Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the change that make it works. As there is no callee for this type of rootNode, I directly checked the type here.

I ensured it works with other possible props, dynamics or not.


if (prop.type === 'SpreadElement') {
// Ignore spread elements
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"scripts": {
"test": "npm run test:base && npm run test:integration",
"test:base": "mocha \"tests/lib/**/*.js\"",
"test:no-custom-classname": "mocha \"tests/lib/rules/no-custom-classname.js\"",
"test:integration": "mocha \"tests/integrations/*.js\" --timeout 60000"
},
"files": [
Expand Down
83 changes: 83 additions & 0 deletions tests/lib/rules/no-custom-classname.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1089,6 +1089,36 @@ ruleTester.run("no-custom-classname", rule, {
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
},
{
code: `<template><div :class="[{'text-red-500': true, 'bg-transparent': false}]">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
},
{
code: `<template><div :class="['hidden',{'text-red-500': true, 'bg-transparent': false}, 'text-red-200']">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
},
{
code: `<template><div :class="['tw-hidden',{'tw-text-red-500': true, 'tw-bg-transparent': false}, 'tw-text-red-200']">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
options: [
{
config: {
prefix: "tw-",
theme: {
extend: {},
},
},
},
],
},
{
code: `<template><div :class="['hidden',{'text-red-500': true, 'bg-transparent': false}, {'text-green-500': true}, 'bg-white']">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
}
],

invalid: [
Expand Down Expand Up @@ -1435,6 +1465,59 @@ ruleTester.run("no-custom-classname", rule, {
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
},
{
code: `
<script>
export default {
data() {
return {}
}
}
</script>
<template>
<span :class="['text-red-200', {'tw-unknown-class': true, 'tw-unknown-class-two': false}, 'tw-unknown-class-three', 'tw-bg-transparent']" />
</template>
`,
options: [
{
config: {
prefix: "tw-",
theme: {
extend: {},
},
},
},
],
errors: generateErrors(
"text-red-200 tw-unknown-class tw-unknown-class-two tw-unknown-class-three"
),
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
},
{
code: `<template><div :class="[{'baz': true, 'foo': false}]">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
errors: generateErrors("baz foo"),
},
{
code: `<template><div :class="['unknown',{'baz': true, 'foo': false}]">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
errors: generateErrors("unknown baz foo"),
},
{
code: `<template><div :class="['text-red-200','unknown',{'baz': true, 'foo': false}, 'tw-unknown-class']">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
errors: generateErrors("unknown baz foo tw-unknown-class"),
},
{
code: `<template><div :class="['tw-hidden',{'custom': true, '🧑‍💻': false}, {'text-green-500': true}, 'bg-tw']">Issue #319</div></template>`,
filename: "test.vue",
parser: require.resolve("vue-eslint-parser"),
errors: generateErrors("tw-hidden custom 🧑‍💻 bg-tw"),
},
{
code: `<div className="group-hover/edit:unknown-class">Custom group name variant with invalid class name</div>`,
errors: generateErrors("group-hover/edit:unknown-class"),
Expand Down