{"_id":"@animaapp/design-tokens-validator","_rev":"11-4dec388c3ca269c6d811ca56085434b4","name":"@animaapp/design-tokens-validator","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@animaapp/design-tokens-validator","version":"0.0.1","keywords":[],"author":"","license":"ISC","_id":"@animaapp/design-tokens-validator@0.0.1","maintainers":[{"name":"andrico-anima","email":"andrico@animaapp.com"},{"name":"aymeric_animaapp","email":"aymeric@animaapp.com"},{"name":"moez_anima","email":"moez@animaapp.com"},{"name":"federico_anima","email":"federico@animaapp.com"},{"name":"orarbel","email":"or@animaapp.com"},{"name":"jorgeanima","email":"jorge@animaapp.com"},{"name":"animaapp-npm","email":"support@animaapp.com"}],"dist":{"shasum":"41037c0fab5b931700e8f53c0c8531c609a37ca8","tarball":"https://registry.npmjs.org/@animaapp/design-tokens-validator/-/design-tokens-validator-0.0.1.tgz","fileCount":55,"integrity":"sha512-4hCgIKinYa29uz0A079qJZMK7VAvB+UGGtCzArQIP7sFIr4Odb46aYd9qJTixOwr5UuNVqFCkMI2ooPiHEzu6g==","signatures":[{"sig":"MEUCIQCm32MC+GTCqALgRQW79WmTJaUGrbu5o7hIyPrZlJluBgIgdPN+7ENMimH0y3wHVXRZS3WoMGqpqrmjXs/dbnF5GKQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":65472},"main":"index.js","type":"module","gitHead":"f0ad7c76d7a561d1d71010332747a75821db5fca","scripts":{"test":"vitest","build":"tsc","release":"npm run build && npm run test --run && npm publish --access public"},"_npmUser":{"name":"andrico-anima","email":"andrico@animaapp.com"},"_npmVersion":"8.19.2","description":"Design tokens are becoming more commonplace as a tool to help provide a consistent way of managing design system attributes.","directories":{},"_nodeVersion":"18.11.0","_hasShrinkwrap":false,"devDependencies":{"vitest":"^0.32.0","typescript":"^5.1.3"},"_npmOperationalInternal":{"tmp":"tmp/design-tokens-validator_0.0.1_1686555931723_0.0110316057884563","host":"s3://npm-registry-packages"}},"0.0.2":{"name":"@animaapp/design-tokens-validator","version":"0.0.2","keywords":[],"author":"","license":"ISC","_id":"@animaapp/design-tokens-validator@0.0.2","maintainers":[{"name":"andrico-anima","email":"andrico@animaapp.com"},{"name":"aymeric_animaapp","email":"aymeric@animaapp.com"},{"name":"moez_anima","email":"moez@animaapp.com"},{"name":"federico_anima","email":"federico@animaapp.com"},{"name":"orarbel","email":"or@animaapp.com"},{"name":"jorgeanima","email":"jorge@animaapp.com"},{"name":"animaapp-npm","email":"support@animaapp.com"}],"dist":{"shasum":"9420f5ff0d5a471fb0b7be9b9f24070d08d79d44","tarball":"https://registry.npmjs.org/@animaapp/design-tokens-validator/-/design-tokens-validator-0.0.2.tgz","fileCount":107,"integrity":"sha512-qJh4i753TX28LmQ8auOBeZW+JV1j7OHv489QJgYZ27zJLXuOlpb4v5xws6WWjQljZGtjLF7ysXCNA7+CLp0sdw==","signatures":[{"sig":"MEYCIQCLL3t1BGdPOLmAJIPosFFkPYUMAVIypWF/hjNhvLn+EwIhAPObnRVUBifJBkmYq1tbMAq4UTArAiXbY6KbNPhpqoUt","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":116786},"main":"dist/index.js","type":"module","gitHead":"6213ca8016c2cadeff82ef66f2c35d65cbef60bd","scripts":{"test":"vitest run","build":"tsc","release":"npm run build && npm run test && npm publish --access public"},"_npmUser":{"name":"andrico-anima","email":"andrico@animaapp.com"},"_npmVersion":"8.19.2","description":"Design tokens are becoming more commonplace as a tool to help provide a consistent way of managing design system attributes.","directories":{},"_nodeVersion":"18.11.0","_hasShrinkwrap":false,"devDependencies":{"vitest":"^0.32.0","typescript":"^5.1.3"},"_npmOperationalInternal":{"tmp":"tmp/design-tokens-validator_0.0.2_1686556336760_0.7381586520028538","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-06-12T07:45:31.557Z","modified":"2026-08-12T10:24:56.146Z","0.0.1":"2023-06-12T07:45:31.887Z","0.0.2":"2023-06-12T07:52:16.924Z"},"license":"ISC","keywords":[],"description":"Design tokens are becoming more commonplace as a tool to help provide a consistent way of managing design system attributes.","maintainers":[{"email":"support@animaapp.com","name":"animaapp-npm"},{"email":"moez@animaapp.com","name":"moez_anima"},{"email":"aymeric@animaapp.com","name":"aymeric_animaapp"},{"email":"marin@animaapp.com","name":"marin_anima"},{"email":"ofer@animaapp.com","name":"ofer-animaapp"},{"email":"haim@animaapp.com","name":"haim_anima"},{"email":"bruno@animaapp.com","name":"macabeus-anima"},{"email":"emilio@animaapp.com","name":"anima-emilio"}],"readme":"# Design Tokens Validator\n\nDesign tokens are becoming more commonplace as a tool to help provide a consistent way of managing design system attributes.\n\nAs the number of tools that include design token support increases, so does the importance of ensuring that your design tokens adhere to the [Design Tokens Standard](https://design-tokens.github.io/community-group/format/#introduction).\n\nBy having tokens that conform to this standard, you ensure that your tokens will be interoperable across a suite of different design system management platforms, like Anima.\n\n## Getting Started\n\nIf you want to validate your tokens online, try out our free online tool: ...\n\nIf you want to run this locally then:\n\n1. Install the package in your project:\n\n```bash\nnpm i @animaapp/design-tokens-validator\n```\n\n2. Import `validate` into your file:\n\n```javascript\nimport { validate } from \"@animaapp/design-tokens-validator\";\n```\n\n3. Pass through your design tokens as a JavaScript object\n\n```javascript\nconst tokens = {\n  brand: {\n    $description: \"Design tokens from our brand guidelines\",\n    color: {\n      $description: \"Our brand's primary color palette\",\n      acid green: {\n        $value: \"#00ff66\"\n      },\n      hot pink: {\n        $value: \"#dd22cc\"\n      }\n    }\n  }\n}\n\nconst errors = validate(tokens)\n```\n\n4. Print out your errors to the console:\n\n```javascript\nconsole.log(errors);\n```\n\n## Automate your entire design system workflow\n\n## TODO\n\n### Additional Features\n\n- [ ] Handle resolution of local design token file\n- [ ] Validate JSON file\n- [ ] Handle external resolution of a design token file\n- [ ] Include link to relevant location in the design system spec\n- [ ] Add severity to messages (ERROR + WARN)\n\n### Improvements\n\n- [ ] Move messages over to the messages object. Use string interpolation to add the useful information to the message\n- [ ] Don't return early when the validator finds an error, as we can spot many errors in one pass\n\n### Future ideas\n\n- [ ] Support as a VSCode extension\n","readmeFilename":"README.md"}