use the official $deprecated property now (#1099)

* use the official $deprecated property now * added changeset
primer · Dec 4, 2024 · 80cc57c · 80cc57c
1 parent e00e02e
commit 80cc57c
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 207 deletions.
diff --git a/.changeset/lemon-donuts-protect.md b/.changeset/lemon-donuts-protect.md
@@ -0,0 +1,5 @@
+---
+'@primer/primitives': patch
+---
+
+Replace `deprecated` prop with `$deprecated` which is the w3c standard
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/filters/isDeprecated.test.ts b/src/filters/isDeprecated.test.ts
@@ -3,17 +3,17 @@ import {isDeprecated} from './isDeprecated.js'
 
 describe('Filter: isDeprecated', () => {
   it('Returns true if depreacted property is true', () => {
-    expect(isDeprecated(getMockToken({deprecated: true}))).toStrictEqual(true)
+    expect(isDeprecated(getMockToken({$deprecated: true}))).toStrictEqual(true)
   })
 
   it('Returns true if depreacted property is a string', () => {
-    expect(isDeprecated(getMockToken({deprecated: 'pumpkin'}))).toStrictEqual(true)
+    expect(isDeprecated(getMockToken({$deprecated: 'pumpkin'}))).toStrictEqual(true)
   })
 
   it('Returns false if deprecated is falsy', () => {
-    expect(isDeprecated(getMockToken({deprecated: false}))).toStrictEqual(false)
-    expect(isDeprecated(getMockToken({deprecated: null}))).toStrictEqual(false)
-    expect(isDeprecated(getMockToken({deprecated: undefined}))).toStrictEqual(false)
+    expect(isDeprecated(getMockToken({$deprecated: false}))).toStrictEqual(false)
+    expect(isDeprecated(getMockToken({$deprecated: null}))).toStrictEqual(false)
+    expect(isDeprecated(getMockToken({$deprecated: undefined}))).toStrictEqual(false)
   })
 
   it('Returns false if no deprecated property exists', () => {
@@ -22,19 +22,19 @@ describe('Filter: isDeprecated', () => {
 
   const inputArray = [
     getMockToken({
-      deprecated: true,
+      $deprecated: true,
     }),
     getMockToken({
-      deprecated: '{scale.yellow}',
+      $deprecated: '{scale.yellow}',
     }),
     getMockToken({
-      deprecated: null,
+      $deprecated: null,
     }),
     getMockToken({
-      deprecated: false,
+      $deprecated: false,
     }),
     getMockToken({
-      deprecated: undefined,
+      $deprecated: undefined,
     }),
     getMockToken({
       value: 'pumpkin',
@@ -43,10 +43,10 @@ describe('Filter: isDeprecated', () => {
 
   const expectedOutput = [
     getMockToken({
-      deprecated: true,
+      $deprecated: true,
     }),
     getMockToken({
-      deprecated: '{scale.yellow}',
+      $deprecated: '{scale.yellow}',
     }),
   ]
 

diff --git a/src/filters/isDeprecated.ts b/src/filters/isDeprecated.ts
@@ -6,5 +6,5 @@ import type {TransformedToken} from 'style-dictionary/types'
  * @returns boolean
  */
 export const isDeprecated = (token: TransformedToken): boolean => {
-  return token.deprecated === true || typeof token.deprecated === 'string'
+  return token.$deprecated === true || typeof token.$deprecated === 'string'
 }
diff --git a/src/schemas/baseToken.ts b/src/schemas/baseToken.ts
@@ -3,6 +3,6 @@ import {z} from 'zod'
 export const baseToken = z
   .object({
     $description: z.string().optional(),
-    deprecated: z.union([z.string(), z.boolean()]).optional(),
+    $deprecated: z.union([z.string(), z.boolean()]).optional(),
   })
   .strict()
diff --git a/src/transformers/jsonDeprecated.test.ts b/src/transformers/jsonDeprecated.test.ts
@@ -5,7 +5,7 @@ describe('Transformer: jsonDeprecated', () => {
   it('Replaces token value with `null` if deprecated is set to `true`', () => {
     const item = getMockToken({
       value: 'tokenName',
-      deprecated: true,
+      $deprecated: true,
     })
     const expectedOutput = null
     expect(jsonDeprecated.transform(item, {}, {})).toStrictEqual(expectedOutput)
@@ -14,7 +14,7 @@ describe('Transformer: jsonDeprecated', () => {
   it('Replaces token value with deprecated value if deprecated is a `string`', () => {
     const item = getMockToken({
       value: 'tokenName',
-      deprecated: `token.pumpkin`,
+      $deprecated: `token.pumpkin`,
     })
     const expectedOutput = 'token.pumpkin'
     expect(jsonDeprecated.transform(item, {}, {})).toStrictEqual(expectedOutput)
@@ -23,7 +23,7 @@ describe('Transformer: jsonDeprecated', () => {
   it('Replaces token value with deprecated value if deprecated is a `string` and removes {}', () => {
     const item = getMockToken({
       value: 'tokenName',
-      deprecated: `{token.pumpkin}`,
+      $deprecated: `{token.pumpkin}`,
     })
     const expectedOutput = 'token.pumpkin'
     expect(jsonDeprecated.transform(item, {}, {})).toStrictEqual(expectedOutput)

diff --git a/src/transformers/jsonDeprecated.ts b/src/transformers/jsonDeprecated.ts
@@ -12,5 +12,5 @@ export const jsonDeprecated: Transform = {
   transitive: true,
   filter: isDeprecated,
   transform: (token: TransformedToken) =>
-    typeof token.deprecated === 'string' ? token.deprecated.replace(/[{}]/g, '') : null,
+    typeof token.$deprecated === 'string' ? token.$deprecated.replace(/[{}]/g, '') : null,
 }