Skip to content

Commit

Permalink
Merge pull request #1029 from amzn/changeset-release/v4
Browse files Browse the repository at this point in the history
Version Packages (prerelease)
  • Loading branch information
jorenbroekema committed Oct 23, 2023
2 parents e43b147 + 016ac6b commit dab4161
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 4 deletions.
2 changes: 0 additions & 2 deletions .changeset/big-worms-collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
'style-dictionary': major
---

#### BREAKING:

- The project has been fully converted to [ESM format](https://nodejs.org/api/esm.html), 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.
- `Style-Dictionary.extend()` method is now asynchronous, which means it returns `Promise<StyleDictionary.Core>` instead of `StyleDictionary.Core`.
Expand Down
5 changes: 4 additions & 1 deletion .changeset/pre.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@
"initialVersions": {
"style-dictionary": "3.8.0"
},
"changesets": []
"changesets": [
"big-worms-collect-2",
"big-worms-collect"
]
}
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Changelog

## 4.0.0-prerelease.0

### Major Changes

- dcbe2fb:
- The project has been fully converted to [ESM format](https://nodejs.org/api/esm.html), 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.
- `Style-Dictionary.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](https://nodejs.org/api/packages.html), 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.

### Minor Changes

- dcbe2fb: FileSystem that is used by Style-Dictionary can now be customized:

```js
import { setFs } from 'style-dictionary/fs';
setFs(myFileSystemShim);
```

By default, it uses an in-memory filesystem shim `@bundled-es-modules/memfs` in browser context, `node:fs` built-in module in Node context.

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

## [3.8.0](https://github.com/amzn/style-dictionary/compare/v3.7.2...v3.8.0) (2023-04-25)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "style-dictionary",
"version": "3.8.0",
"version": "4.0.0-prerelease.0",
"description": "Style once, use everywhere. A build system for creating cross-platform styles.",
"keywords": [
"style dictionary",
Expand Down

0 comments on commit dab4161

Please sign in to comment.