@invisionag/injixo-tokens - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

injixo/injixo.cjs.js

@@ -12,6 +12,6 @@ // @flow
 const breakpoint = {
-    xs: 0,
-    sm: 600,
-    md: 960,
-    lg: 1280,
+    xs: 640,
+    sm: 960,
+    md: 1280,
+    lg: 1440,
     xl: 1920,
@@ -18,0 +18,0 @@ };

injixo/injixo.d.ts

@@ -6,6 +6,6 @@ export declare const asset: {
 export declare const breakpoint: {
-    readonly xs: 0;
-    readonly sm: 600;
-    readonly md: 960;
-    readonly lg: 1280;
+    readonly xs: 640;
+    readonly sm: 960;
+    readonly md: 1280;
+    readonly lg: 1440;
     readonly xl: 1920;
@@ -12,0 +12,0 @@ };

injixo/injixo.esm.js

@@ -6,6 +6,6 @@ const asset = {
 const breakpoint = {
-    xs: 0,
-    sm: 600,
-    md: 960,
-    lg: 1280,
+    xs: 640,
+    sm: 960,
+    md: 1280,
+    lg: 1440,
     xl: 1920,
@@ -12,0 +12,0 @@ };

package.json

 {
   "name": "@invisionag/injixo-tokens",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "injixo Design Tokens",
@@ -17,3 +17,4 @@ "main": "index.js",
     "build": "cd tokens && node ./src/build.js",
-    "prepublishOnly": "yarn build"
+    "prepublishOnly": "yarn build",
+    "eslint": "eslint ./tokens/src"
   },
@@ -31,7 +32,10 @@ "repository": {
   "devDependencies": {
-    "@invisionag/prettier-config-ivx": "^1.1.5",
-    "execa": "^2.0.2",
+    "@invisionag/eslint-config-ivx": "^4.4.0",
+    "@invisionag/prettier-config-ivx": "^2.0.0",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb": "^18.1.0",
+    "execa": "^4.0.0",
     "lodash": "^4.17.11",
-    "prettier": "^1.18.2",
-    "rollup": "^1.15.2",
+    "prettier": "^2.0.2",
+    "rollup": "^2.2.0",
     "style-dictionary": "^2.8.0",
@@ -38,0 +42,0 @@ "typescript": "^3.5.1"

README.md

 # injixo-tokens
 
-This repo is the central source for all injixo related design tokens. Utilizing
-Amazon's style dictionary, the build process produces two distinct packages to
-make use of the injixo design tokens:
+This repo is the central source for all injixo related design tokens. Utilizing [Amazon's style dictionary](https://amzn.github.io/style-dictionary/), the build process produces two distinct packages to make use of the injixo design tokens:
 
 - [NPM package](https://www.npmjs.com/package/@invisionag/injixo-tokens)
 - [Ruby gem](https://gems.ivx.cloud/gems/injixo-tokens)
+
+## Run locally
+
+Tokens can be locally built via `yarn build`. The compiled version of our tokens can then be found in `./injixo/`.
+
+## General Structure
+
+```
+./
+├── tokens/                  - Contains token source files
+│   └── src/
+│       └── injixo/
+│           ├── categories/
+│           │   └── *.json
+│           └── build.js     - Handles compiling process
+│
+├── injixo/                  - Compiled contents of NPM package & gem
+│
+├── gem/
+│   ├── assets/
+│   │   └── scss/            - SCSS files will be moved here on build
+│   ├── lib/
+│   │   ├── injixo-tokens/
+│   │   │   ├── version.rb   - Holds current version of gem
+└── ...
+```
+
+## Publishing a new token version
+
+### Publish NPM package
+
+- Execute `yarn publish` inside your terminal
+- Update version number accordingly ([semver](https://semver.org/))
+- Check if package was published successfully by navigating to https://www.npmjs.com/package/@invisionag/injixo-tokens (might take a few minutes to update there)
+
+### Publish Gem
+
+- Update version number accordingly ([semver](https://semver.org/)) in `gem/lib/injixo-tokens/version.rb`
+- After merging to master, CI will automatically publish the new version to our internal gem server. Check if this worked by navigating to http://gems.ivx.cloud/

New alerts

Explicitly Unlicensed Item

License

(Experimental) Something was found which is explicitly marked as unlicensed.

Found 1 instance in 1 package

Fixed alerts

Explicitly Unlicensed Item

License

(Experimental) Something was found which is explicitly marked as unlicensed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

182355

0.88%

Number of lines in readme file

46

411.11%

Worsened metrics

Dev dependency count

10

42.86%

No dependency changes