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

chore(deps-dev): bump style-dictionary from 3.9.2 to 4.0.1 #548

Closed

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 19, 2024

Bumps style-dictionary from 3.9.2 to 4.0.1.

Release notes

Sourced from style-dictionary's releases.

v4.0.1

Patch Changes

  • e6cbf73: Fix type information for Config.parser
  • e8aea2f: Fix transitive color transform advanced example, migrate chroma-js to colorjs.io
  • 7afcffd: Fix bugs with expand tokens where they would run before instead of after user-configured preprocessors, and would fatally error on broken references. Broken refs should be tolerated at the expand stage, and errors will be thrown after preprocessor lifecycle if the refs are still broken at that point.
  • 922b6aa: Update memfs esm-fork dependency to allow named import Volume.
  • 61b6984: Fix 'filePath' missing from falsy token values
  • 3ae67e3: Upgrade memfs esm fork to publish types and bumping stream to fix unclear licensing issue with transitive dependency.

v4.0.0

For a more comprehensive migration guide from version 3.x.x to version 4.0.0, visit the migration guide page

Major Changes

  • 6cc7f31: BREAKING:

    • usesReference util function is now usesReferences to be consistent plural form like the other reference util functions.

    • getReferences first and second parameters have been swapped to be consistent with resolveReferences, so value first, then the full token object (instead of the entire dictionary instance).

    • getReferences accepts a third options parameter which can be used to set reference Regex options as well as an unfilteredTokens object which can be used as a fallback when references are made to tokens that have been filtered out. There will be warnings logged for this.

    • format.formatter removed old function signature of (dictionary, platform, file) in favor of ({ dictionary, platform, options, file }).

    • Types changes:

      • Style Dictionary is entirely strictly typed now, and there will be .d.ts files published next to every file, this means that if you import from one of Style Dictionary's entrypoints, you automatically get the types implicitly with it. This is a big win for people using TypeScript, as the majority of the codebase now has much better types, with much fewer anys.
      • There is no more hand-written Style Dictionary module index.d.ts anymore that exposes all type interfaces on itself. This means that you can no longer grab types that aren't members of the Style Dictionary class directly from the default export of the main entrypoint. External types such as Parser, Transform, DesignTokens, etc. can be imported from the newly added types entrypoint:
      import type { DesignTokens, Transform, Parser } from 'style-dictionary/types';

      Please raise an issue if you find anything missing or suddenly broken.

      • Matcher, Transformer, Formatter, etc. are still available, although no longer directly but rather as properties on their parents, so Filter['matcher'], Transform['transformer'], Format['formatter']
  • dcbe2fb: - The project has been fully converted to ESM format, which is also the format that the browser uses. For users, this means you'll have to either use Style Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.

    • StyleDictionary.extend() method is now asynchronous, which means it returns Promise<StyleDictionary.Core> instead of StyleDictionary.Core.
    • allProperties / properties was deprecated in v3, and is now removed from StyleDictionary.Core, use allTokens and tokens instead.
    • Templates and the method registerTemplate were deprecated in v3, now removed. Use Formats instead.
    • The package now uses package entrypoints, which means that what is importable from the package is locked down to just the specified entrypoints: style-dictionary & style-dictionary/fs. If more is needed, please raise an issue explaining which file you were importing and why you need it to be public API.
  • f2ed88b: BREAKING: File headers, when registered, are put inside the hooks.fileHeaders property now, as opposed to fileHeader. Note the change from singular to plural form here.

    Before:

    export default {
      fileHeader: {

... (truncated)

Changelog

Sourced from style-dictionary's changelog.

4.0.1

Patch Changes

  • e6cbf73: Fix type information for Config.parser
  • e8aea2f: Fix transitive color transform advanced example, migrate chroma-js to colorjs.io
  • 7afcffd: Fix bugs with expand tokens where they would run before instead of after user-configured preprocessors, and would fatally error on broken references. Broken refs should be tolerated at the expand stage, and errors will be thrown after preprocessor lifecycle if the refs are still broken at that point.
  • 922b6aa: Update memfs esm-fork dependency to allow named import Volume.
  • 61b6984: Fix 'filePath' missing from falsy token values
  • 3ae67e3: Upgrade memfs esm fork to publish types and bumping stream to fix unclear licensing issue with transitive dependency.

4.0.0

For a more comprehensive migration guide from version 3.x.x to version 4.0.0, visit the migration guide page

Major Changes

  • 6cc7f31: BREAKING:

    • usesReference util function is now usesReferences to be consistent plural form like the other reference util functions.

    • getReferences first and second parameters have been swapped to be consistent with resolveReferences, so value first, then the full token object (instead of the entire dictionary instance).

    • getReferences accepts a third options parameter which can be used to set reference Regex options as well as an unfilteredTokens object which can be used as a fallback when references are made to tokens that have been filtered out. There will be warnings logged for this.

    • format.formatter removed old function signature of (dictionary, platform, file) in favor of ({ dictionary, platform, options, file }).

    • Types changes:

      • Style Dictionary is entirely strictly typed now, and there will be .d.ts files published next to every file, this means that if you import from one of Style Dictionary's entrypoints, you automatically get the types implicitly with it. This is a big win for people using TypeScript, as the majority of the codebase now has much better types, with much fewer anys.
      • There is no more hand-written Style Dictionary module index.d.ts anymore that exposes all type interfaces on itself. This means that you can no longer grab types that aren't members of the Style Dictionary class directly from the default export of the main entrypoint. External types such as Parser, Transform, DesignTokens, etc. can be imported from the newly added types entrypoint:
      import type { DesignTokens, Transform, Parser } from 'style-dictionary/types';

      Please raise an issue if you find anything missing or suddenly broken.

      • Matcher, Transformer, Formatter, etc. are still available, although no longer directly but rather as properties on their parents, so Filter['matcher'], Transform['transformer'], Format['formatter']
  • dcbe2fb: - The project has been fully converted to ESM format, which is also the format that the browser uses. For users, this means you'll have to either use Style Dictionary in ESM JavaScript code, or dynamically import it into your CommonJS code.

    • StyleDictionary.extend() method is now asynchronous, which means it returns Promise<StyleDictionary.Core> instead of StyleDictionary.Core.
    • allProperties / properties was deprecated in v3, and is now removed from StyleDictionary.Core, use allTokens and tokens instead.
    • Templates and the method registerTemplate were deprecated in v3, now removed. Use Formats instead.
    • The package now uses package entrypoints, which means that what is importable from the package is locked down to just the specified entrypoints: style-dictionary & style-dictionary/fs. If more is needed, please raise an issue explaining which file you were importing and why you need it to be public API.
  • f2ed88b: BREAKING: File headers, when registered, are put inside the hooks.fileHeaders property now, as opposed to fileHeader. Note the change from singular to plural form here.

    Before:

    export default {

... (truncated)

Commits
  • 4575dd5 chore: release (#1262)
  • a562148 docs: correction or removal of broken links (#1277)
  • 78088e8 docs(migration guide): update formatting options code example (#1278)
  • e6cbf73 Typing fix for parsers in Config interface (#1281)
  • 3d0a74f chore: fix some broken links to old v4 branch (#1273)
  • 922b6aa fix: update sd-transforms doc / memfs dependency (#1276)
  • 7afcffd fix: expand to run after user prepros, tolerate broken refs (#1268)
  • e8aea2f fix: advanced transitive transform color example chroma (#1260)
  • 61b6984 fix: missing filepath in falsy token values (#1265)
  • 3ae67e3 fix: unclear licensing memfs fork transitive deps, types (#1261)
  • Additional commits viewable in compare view

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Jul 19, 2024
@dependabot dependabot bot requested a review from dkolba as a code owner July 19, 2024 02:33
@dependabot dependabot bot added the javascript Pull requests that update Javascript code label Jul 19, 2024
@dependabot dependabot bot requested a review from annsch as a code owner July 19, 2024 02:33
@dependabot dependabot bot added the major label Jul 19, 2024
Copy link
Contributor

@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 2c45b60 to 07b94c3 Compare July 23, 2024 07:38
github-actions[bot]
github-actions bot previously approved these changes Jul 23, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 07b94c3 to 5861303 Compare July 23, 2024 08:09
github-actions[bot]
github-actions bot previously approved these changes Jul 23, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 5861303 to ca9067a Compare July 24, 2024 01:42
github-actions[bot]
github-actions bot previously approved these changes Jul 24, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from ca9067a to 8f770a6 Compare July 26, 2024 01:45
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 8f770a6 to 71f6386 Compare July 26, 2024 01:53
github-actions[bot]
github-actions bot previously approved these changes Jul 26, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 71f6386 to 2b858c1 Compare July 29, 2024 02:27
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 2b858c1 to deb2e28 Compare July 29, 2024 03:00
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from deb2e28 to e329823 Compare July 30, 2024 01:14
github-actions[bot]
github-actions bot previously approved these changes Jul 30, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from e329823 to 91d8836 Compare August 5, 2024 02:22
github-actions[bot]
github-actions bot previously approved these changes Aug 5, 2024
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 91d8836 to 197fc9d Compare August 8, 2024 07:15
Bumps [style-dictionary](https://github.com/amzn/style-dictionary) from 3.9.2 to 4.0.1.
- [Release notes](https://github.com/amzn/style-dictionary/releases)
- [Changelog](https://github.com/amzn/style-dictionary/blob/main/CHANGELOG.md)
- [Commits](amzn/style-dictionary@v3.9.2...v4.0.1)

---
updated-dependencies:
- dependency-name: style-dictionary
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch from 197fc9d to 67e5998 Compare August 14, 2024 01:31
Copy link
Contributor Author

dependabot bot commented on behalf of github Aug 29, 2024

Superseded by #565.

@dependabot dependabot bot closed this Aug 29, 2024
@dependabot dependabot bot deleted the dependabot-npm_and_yarn-style-dictionary-4.0.1 branch August 29, 2024 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code major
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants