Skip to content

fix: Fix deprecation label in objects #230

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

Merged
RayRedGoose merged 3 commits into from
Jan 8, 2026
Merged

fix: Fix deprecation label in objects #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78edee1
fix: Fix deprecationlabel in objects
RayRedGoose Nov 24, 2025
e1f80ed
Merge branch 'prerelease/major' of https://github.com/Workday/canvas-…
RayRedGoose Jan 8, 2026
3a0694f
fix: Fix unit tests
RayRedGoose Jan 8, 2026
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
24 changes: 18 additions & 6 deletions packages/canvas-tokens/utils/formatters/formatTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export const formatJSToTypes: Formatter = ({dictionary, file, options}) => {
recursivelyCreateFileStructure({
originalValues,
tokens: dictionary.properties,
allTokens: dictionary.allTokens,
content,
replaceInContent,
});
Expand All @@ -35,6 +36,7 @@ const startingText = 'export declare const';
type ReplaceFn = (pattern: string, newText: string) => string;

type HelperArgs = {
allTokens: Record<string, any>[];
originalValues: Record<string, any>;
tokens: Record<string, any>;
depth?: number;
Expand All @@ -43,6 +45,7 @@ type HelperArgs = {
};

const recursivelyCreateFileStructure = ({
allTokens,
originalValues,
tokens,
content,
Expand All @@ -57,7 +60,8 @@ const recursivelyCreateFileStructure = ({
const spaces = ' '.repeat(depth);

if (typeof values === 'string') {
const jsDocText = generateJSDoc(original, depth);
const token = allTokens?.find(token => `--cnvs-${token.path.join('-')}` === values);
const jsDocText = generateJSDoc(token?.original || original, depth);

const innerText = depth
? `${spaces}"${key}": "${values}",`
Expand All @@ -79,6 +83,7 @@ const recursivelyCreateFileStructure = ({
updatedContent = replaceInContent(`**${key}**`, innerText);

recursivelyCreateFileStructure({
allTokens,
originalValues: original,
tokens: values,
depth: depth + 1,
Expand All @@ -98,25 +103,32 @@ const generateJSDoc = (original: TransformedToken, depth: number) => {
const spaces = ' '.repeat(depth);
const extraSpaces = spaces + ' ';
const newJSDocLineStart = `\n${extraSpaces}* `;
const {value, comment, raw} = original;
const {value, comment, deprecated, deprecatedComment, raw} = original;

const pxValue = `${value}`.includes('rem') ? parseFloat(value) * 16 : null;
const valueText = value + (pxValue ? ` (${pxValue}px)` : '');
const tokenValue =
typeof raw === 'string'
? 'token: ' + raw.replace(/^{(.+)}$/, (_: any, b: any) => b).replace('palette.', '')
? 'token: ' +
raw.replace(/^{(.+)}$/, (_: any, b: any) => b).replace('palette.', '') +
newJSDocLineStart +
newJSDocLineStart
: '';

const updatedComment = comment?.replace(/; /g, newJSDocLineStart);
const deprecatedText = deprecated ? `@deprecated ${deprecatedComment || ''}` : '';

const updatedComment = comment
? comment.replace(/; /g, newJSDocLineStart) + newJSDocLineStart + newJSDocLineStart
: '';

const text = comment
? newJSDocLineStart +
valueText +
newJSDocLineStart +
newJSDocLineStart +
tokenValue +
newJSDocLineStart +
newJSDocLineStart +
updatedComment +
deprecatedText +
`\n${extraSpaces}`
: ` ${valueText} `;

Expand Down
2 changes: 1 addition & 1 deletion packages/canvas-tokens/utils/spec/formats.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ describe('formats', () => {

const expected =
headerContent +
'export declare const opacity: {\n /**\n * 0.4\n * \n * token: base.opacity.400\n * \n * Test JSDoc\n */\n "disabled": "--cnvs-base-opacity-300",\n};\n';
'export declare const opacity: {\n /**\n * 0.4\n * \n * token: base.opacity.400\n * \n * Test JSDoc\n * \n * \n */\n "disabled": "--cnvs-base-opacity-300",\n};\n';

expect(result).toBe(expected);
});
Expand Down
Loading