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.

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

fix: diff-gen - deprecation in sets not being detected #434

Merged
merged 4 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
38 changes: 36 additions & 2 deletions tools/diff-generator/src/lib/deprecated-token-detection.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,53 @@ export default function detectDeprecatedTokens(renamedTokens, changes) {
const possibleMistakenRevert = { ...changes.deleted };
Object.keys(changes.added).forEach((token) => {
if (
(token !== undefined && !deprecatedTokens[token].deprecated) ||
(token !== undefined && !isDeprecated(deprecatedTokens[token])) ||
renamedTokens[token] !== undefined
) {
delete deprecatedTokens[token];
}
});
Object.keys(changes.deleted).forEach((token) => {
const t = possibleMistakenRevert[token]; // a token marked as deleted
if (t === undefined || (typeof t !== "string" && !("deprecated" in t))) {
if (t === undefined || !wasUndeprecated(t)) {
delete possibleMistakenRevert[token];
} else {
delete changes.deleted[token];
}
});
result.deprecated = deprecatedTokens;
result.reverted = possibleMistakenRevert;
return result;
}

function isDeprecated(tokenObj) {
if (typeof tokenObj !== "object") {
return false;
} else if (tokenObj.deprecated) {
return true;
} else {
let result = false;

Object.keys(tokenObj).forEach((property) => {
result = result || isDeprecated(tokenObj[property]);
});

return result;
}
}

function wasUndeprecated(tokenObj) {
if (typeof tokenObj !== "object") {
return false;
} else if ("deprecated" in tokenObj && tokenObj.deprecated === undefined) {
return true;
} else {
let result = false;

Object.keys(tokenObj).forEach((property) => {
result = result || wasUndeprecated(tokenObj[property]);
});

return result;
}
}
3 changes: 0 additions & 3 deletions tools/diff-generator/test/addedToken.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,6 @@ const expectedSeveralAddedSetTokens = {
$schema:
"https://opensource.adobe.com/spectrum-tokens/schemas/token-types/alias.json",
value: "{gray-800}",
deprecated: true,
deprecated_comment:
"Express will merge with Spectrum with the release of Spectrum 2.",
uuid: "60caae29-d389-421e-a574-b26bcaeed3bf",
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,6 @@
"express": {
"$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/token-types/alias.json",
"value": "{gray-800}",
"deprecated": true,
"deprecated_comment": "Express will merge with Spectrum with the release of Spectrum 2.",
"uuid": "60caae29-d389-421e-a574-b26bcaeed3bf"
}
}
Expand Down