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

no-unused-private-members treats hyphens and underscores as equals #987

Merged
merged 2 commits into from May 2, 2024
Merged

no-unused-private-members treats hyphens and underscores as equals #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73ab3da
no-unused-private-members treats hyphens and underscores as equals
pamelalozano16 Apr 4, 2024
05dd67e
Ignore variables in mixins
pamelalozano16 Apr 4, 2024
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
45 changes: 31 additions & 14 deletions src/rules/no-unused-private-members/__tests__/index.js
View file
Open in desktop
Expand Up @@ -80,7 +80,7 @@ testRule({
code: `
@import 'foo';

%-toolbelt:hover {
%_toolbelt:hover {
color: red;
}

Expand All @@ -96,7 +96,7 @@ testRule({
},
{
code: `
$-a: 3px;
$_a: 3px;
$_b: 1px;

.action-buttons {
Expand Down Expand Up @@ -124,7 +124,7 @@ testRule({
{
code: `
$_app-bar-height: 65px;
$_header-height: 70px;
$-header_height: 70px;
$_explorer-margin: 64px;
$_total-offset: $_app-bar-height + $_header-height + $_explorer-margin;

Expand All @@ -137,9 +137,9 @@ testRule({
{
code: `
@function _add-one($n1) { @return $n1 + 1 }
@function _add-two($n1) { @return $n1 + 2 }
@function _add-three($n1) {
@return _add-two (
@function -add-two($n1) { @return $n1 + 2 }
@function _add_three($n1) {
@return _add_two (
_add-one($n1)
)}

Expand All @@ -162,13 +162,30 @@ testRule({
{
code: `
$_gm-toolbar-item-state-offset: 0.5 * 3;
@mixin _position-offset($offset: $_gm-toolbar-item-state-offset) {
@mixin _position_offset($offset: $_gm-toolbar-item-state-offset) {
top: $offset;
}
.b {
@include _position-offset;
}`,
description: "Is used as a mixin default parameter"
},
{
code: `
$_a-b: 1px;
.b {
margin: $-a-b;
}`,
description: "Is used as a mixin default parameter"
},
{
code: `
@mixin foo {
$_a-b: 1px;
}
@include foo
`,
description: "Is used as a mixin default parameter"
}
],

Expand All @@ -187,7 +204,7 @@ testRule({
margin-left: _addNums(4, 6);
}
`,
message: messages.expected("_one"),
message: messages.expected("-one"),
description: "Private function",
line: 6,
column: 7
Expand All @@ -203,7 +220,7 @@ testRule({
margin: 0;
}
`,
message: messages.expected("_reset-list"),
message: messages.expected("-reset-list"),
description: "Private mixin",
line: 2,
column: 7
Expand Down Expand Up @@ -271,7 +288,7 @@ testRule({
@include column($_a);
@include footer();
}`,
message: messages.expected("$_c"),
message: messages.expected("$-c"),
line: 4,
column: 7,
description: "Variables used as function parameters"
Expand All @@ -285,7 +302,7 @@ testRule({
margin: 5px map.get($_a);
}
`,
message: messages.expected("$_b"),
message: messages.expected("$-b"),
line: 3,
column: 7,
description: "map.get uses variable"
Expand All @@ -304,7 +321,7 @@ testRule({
)
);
}`,
message: messages.expected("$_a-color"),
message: messages.expected("$-a-color"),
line: 3,
column: 7,
description: "Is in theme declaration"
Expand All @@ -319,7 +336,7 @@ testRule({
margin: 0px;
}
}`,
message: messages.expected("$_b"),
message: messages.expected("$-b"),
line: 3,
column: 7,
description: "Is used in @if"
Expand All @@ -334,7 +351,7 @@ testRule({
margin: 0px;
}
}`,
message: messages.expected("$_b"),
message: messages.expected("$-b"),
line: 3,
column: 7,
description: "Variable in interpolated selector."
Expand Down
32 changes: 25 additions & 7 deletions src/rules/no-unused-private-members/index.js
View file
Open in desktop
Expand Up @@ -25,6 +25,21 @@ function getPrivateMembers(inputString) {
return matches;
}

function matchUnderscores(inputString) {
return inputString.replaceAll("_", "-");
}

function isWithinMixin(node) {
let parent = node.parent;
while (parent) {
if (parent.type === "atrule" && parent.name === "mixin") {
return true;
}
parent = parent.parent;
}
return false;
}

function rule(primaryOption) {
return (root, result) => {
const validOptions = utils.validateOptions(result, ruleName, {
Expand Down Expand Up @@ -60,17 +75,18 @@ function rule(primaryOption) {
);
selectors.forEach(selector => {
if (!privateMembers.selectors.has(selector)) {
privateMembers.selectors.set(selector, node);
privateMembers.selectors.set(matchUnderscores(selector), node);
}
});
}

// Private variables
const isPrivateVariable =
node.type === "decl" &&
(node.prop.startsWith("$-") || node.prop.startsWith("$_"));
(node.prop.startsWith("$-") || node.prop.startsWith("$_")) &&
!isWithinMixin(node);
if (isPrivateVariable) {
privateMembers.variables.set(node.prop, node);
privateMembers.variables.set(matchUnderscores(node.prop), node);
}

// Private functions
Expand All @@ -81,7 +97,7 @@ function rule(primaryOption) {
if (isPrivateFunction) {
const match = extractFunctionName(node.params);
if (match.length < 2) return;
privateMembers.functions.set(match[1], node);
privateMembers.functions.set(matchUnderscores(match[1]), node);
}

// Private mixins
Expand All @@ -92,7 +108,7 @@ function rule(primaryOption) {
if (isPrivateMixin) {
const match = extractFunctionName(node.params);
privateMembers.mixins.set(
match.length < 2 ? node.params : match[1],
matchUnderscores(match.length < 2 ? node.params : match[1]),
node
);
}
Expand All @@ -104,6 +120,7 @@ function rule(primaryOption) {
const valuePrivateMembers = getPrivateMembers(value);
if (valuePrivateMembers) {
valuePrivateMembers.forEach(privateMember => {
privateMember = matchUnderscores(privateMember);
if (privateMembers.mixins.get(privateMember) !== node)
privateMembers.mixins.delete(privateMember);
if (
Expand All @@ -124,6 +141,7 @@ function rule(primaryOption) {
const valuePrivateMembers = getPrivateMembers(decls.value);
if (valuePrivateMembers) {
valuePrivateMembers.forEach(privateMember => {
privateMember = matchUnderscores(privateMember);
if (privateMembers.variables.get(privateMember) !== decls)
privateMembers.variables.delete(privateMember);
if (privateMembers.functions.get(privateMember) !== decls)
Expand All @@ -133,10 +151,10 @@ function rule(primaryOption) {
});

for (const types in privateMembers) {
for (const [key, value] of privateMembers[types].entries()) {
for (const [key, node] of privateMembers[types].entries()) {
utils.report({
message: messages.expected(key),
node: value,
node,
result,
ruleName
});
Expand Down