@madgex/design-system - npm Package Compare versions

Comparing version 1.2.0 to 1.2.1

package.json

 {
   "name": "@madgex/design-system",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "scripts": {
@@ -5,0 +5,0 @@ "clean": "rimraf dist public tokens/build",

README.md

@@ -7,2 +7,4 @@ # Madgex Design System
 
+NOTE: Right now you'll need to be authenticated on npm under the Madgex account.
+
 ```bash
@@ -14,8 +16,13 @@ npm install @madgex/design-system --save
 
-You'll need to import the Madgex DS styles into your main Sass file.
+You'll need to import the Madgex DS styles into your project scss file.
 
-To import add the below to your Sass file:
+Use the DS tokens to change DS variables.
 
+e.g. import the Madgex DS to your Sass file & overload variables:
+
 ```scss
-@import 'node_modules/@madgex/design-system/public/css/index.css';
+$mds-color-primary: #ff0000; // my primary brand colour is RED
+$mds-size-font-md: 20px; // my base font-size is 20px
+
+@import 'node_modules/@madgex/design-system/src/scss/index.scss';
 ```
@@ -25,2 +32,2 @@
 
-With every commit to `master` the build server attempts to create a new version using [semantic-release](https://semantic-release.gitbook.io/semantic-release/) and deploys to `NPM`.
+With every commit to `master` the build server attempts to create a new version using [semantic-release](https://semantic-release.gitbook.io/semantic-release/) and deploys to [npm](https://npmjs.org) as [@madgex/design-system](https://www.npmjs.com/package/@madgex/design-system).

src/components/icon/icon.config.js

@@ -1,16 +0,1 @@
-// module.exports = {
-//   title: 'Icons',
-//   context: {
-//     id: 'bike',
-//   },
-//   variants: [
-//     {
-//       name: 'camera',
-//       context: {
-//         id: 'camera',
-//       },
-//     },
-//   ],
-// };
-
 /**
@@ -21,24 +6,16 @@ * Icon Pattern Config
 
-const path = require('path');
-const glob = require('glob');
+const iconList = require('../../../dist/assets/icons.json');
 
-const iconsGlob = './src/icons/**/*.svg'; // TODO: Load from global config
-const variants = [];
-
-// Collect Icon Names
-const files = glob.sync(iconsGlob) || [];
-files.forEach((file) => {
-  const name = path.basename(file, '.svg');
-  variants.push({
-    name,
-    context: {
-      icon: name,
-    },
-  });
-});
-
 module.exports = {
   title: 'Icon',
   status: 'ready',
-  variants,
+  default: iconList[0].name,
+  variants: iconList.map((item) => {
+    return {
+      name: item.name,
+      context: {
+        icon: item.name,
+      },
+    };
+  }),
 };

No alert changes

Improved metrics

Number of lines in readme file

31

increased by29.17%

Worsened metrics

Total package byte prevSize

51133

decreased by-0.01%

Lines of code

765

decreased by-2.55%

No dependency changes