@momentum-ui/design-tokens - npm Package Compare versions

Comparing version 0.0.24 to 0.0.25

package.json

@@ -5,3 +5,3 @@ {
   "description": "See [documentation on Confluence](https://confluence-eng-gpk2.cisco.com/conf/display/~pauwitty/Token+proposal)",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "main": "./dist/index.css",
@@ -19,5 +19,10 @@ "devDependencies": {
     "build:clean": "rimraf ./dist",
-    "build:css": "npm run build:clean && node theme_generator.js --platform=web themes/* --sizeUnit=rem",
+    "build:web": "npm run build:clean && node theme_generator.js --target=targets/web.json",
+    "build:windows": "npm run build:clean && node theme_generator.js --target=targets/qt.json && node theme_generator.js --target=targets/windows-high-contrast.json",
+    "build:linux": "npm run build:clean && node theme_generator.js --target=targets/qt.json",
+    "build:macos": "npm run build:clean && node theme_generator.js --target=targets/macos.json",
+    "build:ios": "npm run build:clean && node theme_generator.js --target=targets/ios.json",
+    "build:android": "npm run build:clean && node theme_generator.js --target=targets/android.json",
     "publishNpm": "./publishNpm.sh",
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npm run build:web && npm run build:windows && npm run build:macos && npm run build:ios && npm run build:android",
     "prepare": "husky install"
@@ -24,0 +29,0 @@ },

README.md

@@ -1,44 +0,35 @@
-# token-proposal
+# Momentum Design Tokens
 
-See [documentation on Confluence](https://confluence-eng-gpk2.cisco.com/conf/display/~pauwitty/Token+proposal)
+[![license](https://img.shields.io/badge/license-MIT-blueviolet)](https://github.com/momentum-design/tokens/blob/master/LICENSE) ![state](https://img.shields.io/badge/state-alpha-blue)
 
-To generate a flat token file for a particular theme, run:
+**Momentum Design Tokens** is a design token project to provide standardization of themes and colors to downstream [Momentum Design](https://momentum.design/) projects.
 
-```
-node theme_generator.js <theme file>
-```
+See [documentation on Confluence](https://confluence-eng-gpk2.cisco.com/conf/display/~pauwitty/Token+proposal).
 
-e.g.
+## Overview
 
-```
-node theme_generator.js ./themes/theme-light-webex.json
-```
+This project is built with the following goals:
 
-It supports some options
+* **Simplicity** - Tokens should be easily built and consumed
+* **Themed** - Tokens should be designed with theming in mind
+* **Extensible** - Usage of multiple tokens should work seemlessly
 
-```
-Usage: /home/paul/token-proposal/theme_generator.js [OPTION]... [THEME FILE]...
-Options
-  --colorFormat=[hex|rgba]    What color format to use in the output.
-       rgba   -> rgba(244,233,20,0.8)
-       object -> { "r": 244, "g": 233, "b": 20, "a": 0.8 }
-       hex    -> #RRGGBBAA
-       names  -> red-05
-  --sizeUnit=[px|pt|rem]      What unit to use for sizes in the output.
-       px    -> pixels (matching that on Figma)
-       pt    -> points (pixels * 0.75)
-       rem   -> root em, used on web to create sizes relative to user font size
-  --componentGroups           Group tokens by component
-  --omitThemeTokens           Removes theme tokens from the generated file
-  --fileFormat=[css|json]     What format to use for the output files
-  --platform=PLATFORM         Which platform to generate for.
-       web
-       qt
-       macos
-       ios
-       android
-  --toStdOut                  Output to std out instead of writing to files
+## Getting Started
 
-```
+Please review our [getting started guide](./GETTING_STARTED.md) for details on how to prepare this project for downstream consumption.
 
-Tokens for individual components go in the components folder. If components are needed on only one platform, they should go in e.g. platformcomponents/ios/component_name.json. It's also possible to add platformcomponents/mobile/component_name.json which applies on both ios and android, or platformcomponents/desktop/component_name.json, for both macos and qt.
+## Contribution
+
+Want to contribute? Be sure to review the [contribution guide](./CONTRIBUTING.md).
+
+## Change Log
+
+See [the commit history](https://github.com/momentum-design/tokens/commits/master) for the most up-to-date changes.
+
+## Tooling
+
+* [NPM](https://www.npmjs.com/) - Package Manager
+
+## Copyright
+
+Copyright (c) 2021 Cisco Systems

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

668857

increased by39.71%

Number of package files

16

increased by6.67%

Lines of code

11393

increased by39.64%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Number of lines in readme file

36

decreased by-20%

No dependency changes