@adobe/spectrum-tokens 13.16.0 → 14.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,9 +22,9 @@ This project uses [Semantic Versioning (semver)](https://semver.org/). It also u
22
22
 
23
23
  x.x.n+1 releases are for bug fixes and patches.
24
24
 
25
- - bug fixes
26
- - typos
27
- - mistakes
25
+ * bug fixes
26
+ * typos
27
+ * mistakes
28
28
 
29
29
  Example: a token name changing from `detail-margin-top-mulitplier` to `detail-margin-top-multiplier` to fix a spelling mistake.
30
30
 
@@ -32,16 +32,16 @@ Example: a token name changing from `detail-margin-top-mulitplier` to `detail-ma
32
32
 
33
33
  x.n+1.0 releases are for new tokens and features.
34
34
 
35
- - adding new token
36
- - changing a value intentionally
37
- - adding deprecation metadata and aliased new tokens where applicable
35
+ * adding new token
36
+ * changing a value intentionally
37
+ * adding deprecation metadata and aliased new tokens where applicable
38
38
 
39
39
  #### Major
40
40
 
41
41
  n+1.0.0 releases are for breaking changes.
42
42
 
43
- - deleting tokens
44
- - changing token value type (e.g., from a color to a dimension; anything that would break a parser expecting specific data types)
43
+ * deleting tokens
44
+ * changing token value type (e.g., from a color to a dimension; anything that would break a parser expecting specific data types)
45
45
 
46
46
  ## Deprecations
47
47
 
@@ -49,6 +49,19 @@ n+1.0.0 releases are for breaking changes.
49
49
 
50
50
  Tokens with a name changed will first be marked as deprecated, while a new token will be created with the new name; the deprecated token will then become an alias for the new token. Finally, the deprecated token will eventually be removed, most likely in the next major release if there has been sufficient time to notify teams. The required amount of time is still to be determined.
51
51
 
52
+ ### Token properties for deprecation tracking
53
+
54
+ * `deprecated` (boolean): Marks a token as deprecated
55
+ * `deprecated_comment` (string): Provides context about why the token is deprecated and migration guidance
56
+ * `renamed` (string): For 1:1 token replacements, specifies the new token name that should be used instead
57
+
58
+ When a token is renamed:
59
+
60
+ 1. Set `deprecated: true` on the old token
61
+ 2. Add `renamed: "new-token-name"` to specify the replacement
62
+ 3. Update `deprecated_comment` to provide additional context if needed
63
+ 4. The old token's `value` should typically alias to the new token
64
+
52
65
  ## Releases
53
66
 
54
67
  All commits merged or pushed to the `main` branch will be released as a stable version with the `latest` tag on [NPM](https://www.npmjs.com/package/@adobe/spectrum-tokens?activeTab=versions). All commits merged or pushed to `next`, or `next-major` will update the version number according to the types of commits made in the branch (breaking change, feature, bug fix) and release it to NPM with the `next` tag.