# @design-sync/w3c-dtfm

> Design tokens module format (DTFM) utils and types

Latest version **0.11.2** (published 2024-06-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @design-sync/w3c-dtfm
pnpm add @design-sync/w3c-dtfm
yarn add @design-sync/w3c-dtfm
bun add @design-sync/w3c-dtfm
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.11.2 |
| Published | 2024-06-06 |
| First published | 2023-11-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 173.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Maintainers | salamaashoush |

## Links

- npm: https://www.npmjs.com/package/@design-sync/w3c-dtfm
- Repository: https://github.com/salamaashoush/design-sync
- Homepage: https://github.com/salamaashoush/design-sync#readme
- Issues: https://github.com/salamaashoush/design-sync/issues
- npm.io page: https://npm.io/package/@design-sync/w3c-dtfm

## Dependencies (2)

- [culori](https://npm.io/package/culori.md) ^3.3.0
- [@design-sync/utils](https://npm.io/package/@design-sync/utils.md) 0.5.1

## Recent versions

- 0.11.2 (latest) — 2024-06-06
- 0.11.1 — 2024-06-06
- 0.11.0 — 2023-12-15
- 0.10.0 — 2023-12-15
- 0.9.1 — 2023-11-30
- 0.9.0 — 2023-11-29
- 0.8.0 — 2023-11-29
- 0.7.0 — 2023-11-28
- 0.6.0 — 2023-11-28
- 0.5.0 — 2023-11-27
- 0.4.0 — 2023-11-27
- 0.3.0 — 2023-11-27
- 0.2.1 — 2023-11-22
- 0.2.0 — 2023-11-21
- 0.1.0 — 2023-11-13
- … 1 more at https://npm.io/package/@design-sync/w3c-dtfm/versions

## README

# @design-sync/w3c-dtfm

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
<!-- [![bundle][bundle-src]][bundle-href]
[![Codecov][codecov-src]][codecov-href] -->

Design tokens module format (DTFM) utils and types

## Usage

Install package:

```sh
# npm
npm install @design-sync/w3c-dtfm

# yarn
yarn add @design-sync/w3c-dtfm

# pnpm
pnpm install @design-sync/w3c-dtfm

# bun
bun install @design-sync/w3c-dtfm
```

Import:

```js
import { TokensWalker } from "@design-sync/w3c-dtfm";

const tokens = {
  "color": {
    "primary": {
      "$value": "#000000",
      "$type": "color"
    }
  }
  ... // rest of tokens
};
const walker = new TokensWalker(tokens);

walker.walk((token) => {
  // do something with token
  console.log(token);
});
```


## Development

- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`

## License

Made with 💛

Published under [MIT License](./LICENSE).

<!-- Badges -->

[npm-version-src]: https://img.shields.io/npm/v/@design-sync/w3c-dtfm?style=flat&colorA=18181B&colorB=F0DB4F
[npm-version-href]: https://npmjs.com/package/@design-sync/w3c-dtfm
[npm-downloads-src]: https://img.shields.io/npm/dm/@design-sync/w3c-dtfm?style=flat&colorA=18181B&colorB=F0DB4F
[npm-downloads-href]: https://npmjs.com/package/@design-sync/w3c-dtfm
<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/unjs/@design-sync/w3c-dtfm/main?style=flat&colorA=18181B&colorB=F0DB4F
[codecov-href]: https://codecov.io/gh/unjs/@design-sync/w3c-dtfm
[bundle-src]: https://img.shields.io/bundlephobia/minzip/@design-sync/w3c-dtfm?style=flat&colorA=18181B&colorB=F0DB4F
[bundle-href]: https://bundlephobia.com/result?p=@design-sync/w3c-dtfm -->

---
_Source: https://npm.io/package/@design-sync/w3c-dtfm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._