@adobe/spectrum-tokens 12.0.0-beta.9 → 12.0.0

package/CHANGELOG.md

@@ -1,6 +1,51 @@
-# [12.0.0-beta.9](https://github.com/adobe/spectrum-tokens/compare/v12.0.0-beta.8...v12.0.0-beta.9) (2022-03-31)
+# [12.0.0](https://github.com/adobe/spectrum-tokens/compare/v11.0.0...v12.0.0) (2023-02-14)
 
 
 ### Bug Fixes
 
-* update gray values for WCAG 2.1 goodness ([5259a58](https://github.com/adobe/spectrum-tokens/commit/5259a58e18a94b1d109dfdb612501637106a3383))
+* .releaserc config updated to treat beta as a release branch] ([8f54fa5](https://github.com/adobe/spectrum-tokens/commit/8f54fa525210d1d915d22b5ff39f8f218b243708))
+* fixed missing token sets for color loupe ([7de5d5b](https://github.com/adobe/spectrum-tokens/commit/7de5d5bf4148e565336b65aed8691275896c0b87))
+* heading-cjk-light-strong-emphasized-font-weight should be font-weight-extra-bold ([db7ce60](https://github.com/adobe/spectrum-tokens/commit/db7ce6071bf643387d4dfa129614d95e50187195))
+* missing units on `toast-maximum-width` ([9b0fa71](https://github.com/adobe/spectrum-tokens/commit/9b0fa716b28c7618e7c2cf2314692d20a54c8b71))
+* orange bugs in notice and visual color ([1606dea](https://github.com/adobe/spectrum-tokens/commit/1606dea473a6f415fd51914cd6cc670c67dbc2b9))
+* rename meter-thinkness-medium; closes DNA-1224 ([#75](https://github.com/adobe/spectrum-tokens/issues/75)) ([bcd839f](https://github.com/adobe/spectrum-tokens/commit/bcd839fa92cb9fde155a6e3ac398b7ab86984993))
+* token name typo ([007da82](https://github.com/adobe/spectrum-tokens/commit/007da828661f97ea7f8880b795d8571f3a0026d2))
+* trigger release ([44d7637](https://github.com/adobe/spectrum-tokens/commit/44d7637db052d168dd23de42c2246ff66124e128))
+* typo in typography - changed `spectrum for express` to `express` ([e19eea3](https://github.com/adobe/spectrum-tokens/commit/e19eea3f8253096f031897a5c69c7e86fee555ea))
+
+
+* ci!: merge branch 'next-major' into beta ([1e6cdd2](https://github.com/adobe/spectrum-tokens/commit/1e6cdd2536950871500471bef39219f705d43b9e))
+
+
+### Features
+
+* add border-400 and opacity-disabled ([0447910](https://github.com/adobe/spectrum-tokens/commit/0447910f99577ad5206937ba3b234b4996ae00b4))
+* added alert-banner tokens ([626d3ab](https://github.com/adobe/spectrum-tokens/commit/626d3abfd80d04abe31f9b835c4202908416444e))
+* added detail typography tokens for uppercase, DNA-1257 ([a4fce7e](https://github.com/adobe/spectrum-tokens/commit/a4fce7e3b197f23f92a5f8f869d4cf11f32339dc))
+* added dropzone tokens, DNA-1258 ([c0ce9df](https://github.com/adobe/spectrum-tokens/commit/c0ce9dfe39f0a9a22ac5b3ba31bebb4c80aa48e4))
+* added field-width token ([8894edd](https://github.com/adobe/spectrum-tokens/commit/8894edde8c6bf87e359b9a400ccc8e1325f94754))
+* added illustrated-message tokens ([3326f28](https://github.com/adobe/spectrum-tokens/commit/3326f28d285a7cbbc9c97d74d7ca032e2442a79f))
+* added missing field-edge-to-visual-quiet token ([4250036](https://github.com/adobe/spectrum-tokens/commit/4250036a7923837a2e28937812b2488c40f29b61))
+* added new alert dialog typography tokens, DNA-1255 ([f590663](https://github.com/adobe/spectrum-tokens/commit/f590663292178e5d261013d4e830de487fcadd25))
+* added rating indicator tokens ([1df0d94](https://github.com/adobe/spectrum-tokens/commit/1df0d94a0ab283a6fe33ecdf9b9725c1fc9cc357))
+* added search-field tokens ([3f8f544](https://github.com/adobe/spectrum-tokens/commit/3f8f54493eec685897429b6379345889073f84a3))
+* adding color area tokens (DNA-1234) ([28f42bc](https://github.com/adobe/spectrum-tokens/commit/28f42bcc06e5b0be5c6ce26d01c607a3c6b2b90b))
+* adding floating action button shadow blur token (DNA-1246) ([840c48f](https://github.com/adobe/spectrum-tokens/commit/840c48f1631ff576fc98aa1c6acc18d330857643))
+* adds alert dialog tokens; closes DNA-1223 ([ed9a705](https://github.com/adobe/spectrum-tokens/commit/ed9a7054a285dbed6d0c5f4aaedf6e74c29412fb))
+* adds navigational indicator tokens (DNA-1236) ([c4eb51c](https://github.com/adobe/spectrum-tokens/commit/c4eb51c4e0deb62c11aac5e18f91ccc4a27c42e8))
+* adds thumbnail tokens; closes DNA-1221 ([086e6fa](https://github.com/adobe/spectrum-tokens/commit/086e6fae30813fc332da45836c732ade588e93ba))
+* color loupe tokens, DNA-1249 ([4169f4a](https://github.com/adobe/spectrum-tokens/commit/4169f4a9548169b855fdd78ae918f74935cc0306))
+* color-slider tokens (DNA-1238) ([524feaf](https://github.com/adobe/spectrum-tokens/commit/524feaf43ead77ffb681e8ca35dc69182064ef95))
+* color-wheeeeeeeeeeeeeeeeel tokens (DNA-1235) ([9c8daac](https://github.com/adobe/spectrum-tokens/commit/9c8daace803665f1cd5196deb5c016dba33a2fb1))
+* new card tokens, DNA-1250 ([c9e3bdd](https://github.com/adobe/spectrum-tokens/commit/c9e3bdd24d77659b174e350a5671067bb019a081))
+* new typography color tokens, DNA-1254 ([b836ae5](https://github.com/adobe/spectrum-tokens/commit/b836ae5e47014e6a5eca23e9e574b5f6d27a04b1))
+* rename typography tokens, new heading tokens (DNA-1242, DNA-1243) ([ffe856a](https://github.com/adobe/spectrum-tokens/commit/ffe856afbeb67924043c6e86a045cf76e2923bbe))
+* Typography updated ([#76](https://github.com/adobe/spectrum-tokens/issues/76)) ([83b8c74](https://github.com/adobe/spectrum-tokens/commit/83b8c741a9f3cacee2b36d188dc94c82ef9827ad))
+* update field label values (DNA-1240) ([e9ed057](https://github.com/adobe/spectrum-tokens/commit/e9ed057f76d6cc86f706c87438df2ef4d1737621))
+* update side label character count spacing (DNA-1241) ([2738648](https://github.com/adobe/spectrum-tokens/commit/2738648704acc73f35d7eeefb71ff5928f7ef01f))
+* updated color-wheel-minimum-width and added color-wheel-width, DNA-1256 ([57ee5f4](https://github.com/adobe/spectrum-tokens/commit/57ee5f425abde5941c486224c91b3bd4d82a3261))
+
+
+### BREAKING CHANGES
+
+* moving to new format, a departure from v11.x.x

package/README.md

@@ -1,15 +1,84 @@
-# Spectrum Style Dictionary
+# Spectrum Tokens
+
+Design tokens are primarily name-value pairs used to store design decisions and distributed in a way platforms, implementations, and products can use across design tools and coding languages. These value types are represented as data, which include spacing, color, typography, object styles, animation, etc. These can represent anything defined by design: a color as an RGB value, an opacity as a number, and an animation ease function as Bezier coordinates. They're used in place of hard-coded values to ensure flexibility and unity across all product experiences.
+
+Design tokens are directly integrated into our component libraries, UI kits, and the Spectrum XD plugin. They cover the various options of platform scales, color themes, component states, and more. We also offer teams a variety of token types to use directly within their products if they are not using a Spectrum component library.
 
 ## Getting started
 
 Start by installing all the project dependencies.
 
 ```bash
-yarn install
+yarn
 ```
 
-Then build the project.
+Running this script will also build the tokens to the `dist` directory.
+
+To manually build the project, you can also run the following script:
 
 ```bash
-yarn run build
+yarn build
+```
+
+## Generate a Diff from the last release
+
+The `yarn generateDiffResult` script will build the project and compare the tokens in the `dist` directory with the last released version of Spectrum Tokens. It will generate a report of added tokens, deleted tokens, tokens with value changes, and tokens with potential name changes. The script can't guarantee the correct name changes; it compares new tokens and deleted tokens to see if any have the same value and are likely to be token name changes.
+
+## Versioning
+
+This project uses [Semantic Versioning (semver)](https://semver.org/). It also utilizes [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and [semantic-release](https://semantic-release.gitbook.io/semantic-release/) with a GitHub Action to automate the release process.
+
+### Major, minor, and patch criteria
+
+#### Patches
+
+x.x.n+1 releases are for bug fixes and patches.
+
+- bug fixes
+- typos
+- mistakes
+
+Example: a token name changing from `detail-margin-top-mulitplier` to `detail-margin-top-multiplier` to fix a spelling mistake.
+
+#### Minor
+
+x.n+1.0 releases are for new tokens and features.
+
+- adding new token
+- changing a value intentionally
+- adding deprecation metadata and aliased new tokens where applicable
+
+#### Major
+
+n+1.0.0 releases are for breaking changes.
+
+- deleting tokens
+- changing token value type (e.g., from a color to a dimension; anything that would break a parser expecting specific data types)
+
+## Deprecations
+
+### Planned token name changes
+
+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.
+
+## Releases
+
+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.
+
+More details can be found in this [example workflow](https://semantic-release.gitbook.io/semantic-release/recipes/release-workflow/distribution-channels).
+
+## Spectrum Tokens 11.x.x and 12.x.x
+
+Starting with `@adobe/spectrum-tokens` v12.0.0, this project uses a more efficient list of tokens. Previously in v11.x.x, every possible combination of component options was used to define tokens, resulting in an unnecessarily large list of tokens. However, while the work is ongoing in migrating components from the old system to the newer one, v12.0.0 and future versions will be published under the `next` tag. To install it, use the script:
+
+```
+yarn add @adobe/spectrum-tokens@next
+```
+
+or
+
 ```
+npm install --save @adobe/spectrum-tokens@next
+```
+
+If you need to use the older and more complete set of tokens side by side with the v12.x.x release while the development of this migration is ongoing, you can use the [`@adobe/spectrum-tokens-depreacated`](https://www.npmjs.com/package/@adobe/spectrum-tokens-deprecated) package, which is an archived release of `@adobe/spectrum-tokens@11.8.0`.

package/{config.js → commitlint.config.cjs}

@@ -9,28 +9,11 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
-
-const StyleDictionary = require("style-dictionary");
-const JsonSetsFormatter = require("style-dictionary-sets").JsonSetsFormatter;
-
-StyleDictionary.registerFormat(JsonSetsFormatter);
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
 
 module.exports = {
-  source: ["tokens/**/*.json"],
-  platforms: {
-    JSON: {
-      buildPath: "dist/json/",
-      transforms: ["attribute/cti", "name/cti/kebab"],
-      files: [
-        {
-          destination: "variables.json",
-          format: "json/sets",
-          options: {
-            showFileHeader: false,
-            outputReferences: true,
-          },
-        },
-      ],
-    },
-  },
+  extends: ["@commitlint/config-conventional"],
 };