@mevbg/design-essentials-vendor 2.0.2 → 2.0.4

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2025, Martin Metodiev
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -2,6 +2,10 @@
 
 > A simple vendor of design system essentials
 
+[![npm version][npm-version-src]][npm-version-href]
+[![License][license-src]][license-href]
+[![Style Dictionary][style-dictionary-src]][style-dictionary-href]
+
 ## 🎯 Overview
 
 _[Mev](https://mev.bg)’s Design Essentials Vendor_ (**mDEV**) is a full-fledged factory for generating essential assets used to scaffold a robust Design System. Built on top of [Style Dictionary](https://styledictionary.com/) and [Favicons](https://www.npmjs.com/package/favicons), it delivers a strongly opinionated and production-ready foundation of assets, tokens and utilities — aligned with Mev’s principle for creating resilient and stable UIs.
@@ -279,24 +283,24 @@ It is primarily utilized by the Viewport Scaler Generator and Tokens Generator,
 #### Usage of Master Generator
 
 ```ts
-import { generateDesignEssentials } from ’@mevbg/design-essentials-vendor’;
+import { generateDesignEssentials } from '@mevbg/design-essentials-vendor';
 
 try {
   await generateDesignEssentials({
-    buildPath: ’./dist’,
-    prefix: ’mev’,
+    buildPath: './dist',
+    prefix: 'mev',
     baseFontSize: 16,
     generators: {
       favicons: {
-        id: ’https://mev.bg’,
-        sourcePath: ’assets/images/logo.svg’,
-        appName: ’Mev.bg’,
-        appShortName: ’Mev’,
-        appDescription: ’Personal webpage’,
-        version: ’1.0.0’
+        id: 'https://mev.bg',
+        sourcePath: 'assets/images/logo.svg',
+        appName: 'Mev.bg',
+        appShortName: 'Mev',
+        appDescription: 'Personal webpage',
+        version: '1.0.0'
       },
       fontFaces: {
-        sourcePath: ’assets/client/fonts’,
+        sourcePath: 'assets/client/fonts',
         fonts: {
           Helvetica: {
             Regular: 400,
@@ -305,35 +309,35 @@ try {
         }
       },
       icons: {
-        fontFamily: ’MevIcons’,
-        color: ’var(--mev-color-content-gray)’,
+        fontFamily: 'MevIcons',
+        color: 'var(--mev-color-content-gray)',
         list: {
-          main: ’E000’,
-          nav: ’E001’,
-          search: ’E002’,
-          profile: ’E003’
+          main: 'E000',
+          nav: 'E001',
+          search: 'E002',
+          profile: 'E003'
           // ...
         },
         viewportScaler: {},
         scrollbar: {},
         tokens: {
-          sourcePath: ’./design/tokens/**/index.js’,
-          platforms: [’css’, ’js’, ’scss’],
+          sourcePath: './design/tokens/**/index.js',
+          platforms: ['css', 'js', 'scss'],
           contentScaling: {
             minViewportW: 600,
             maxViewportW: 1200
           },
           colorScheme: {
-            default: ’light’,
-            method: ’combined’
+            default: 'light',
+            method: 'combined'
           }
         }
       }
     }
   });
-  console.info(’Design essentials generated successfully!’);
+  console.info('Design essentials generated successfully!');
 } catch (err) {
-  console.error(’Failed to generate design essentials:’, err.message);
+  console.error('Failed to generate design essentials:', err.message);
 }
 ```
 
@@ -1509,7 +1513,7 @@ This generator automatically scans font directories and generates comprehensive
 - **Process**:
   1. Calls `getTypefaces(sourcePath)` to discover available fonts
   2. For each typeface, checks if there’s a predefined weight mapping in the `fonts` config
-  3. If no mapping exists and multiple weights are detected, skips the typeface (can't determine weights)
+  3. If no mapping exists and multiple weights are detected, skips the typeface (can’t determine weights)
   4. Sorts weights by their numeric values if mapping exists
   5. Filters files to ensure only `.woff2` files are processed
   6. Creates FontFace objects with:
@@ -1613,7 +1617,7 @@ This generator leverages the `favicons` npm package to create comprehensive favi
   2. Merges default parameters with provided parameters using spread operator
   3. Sets `manifestMaskable` to `sourcePath` if not provided (uses same image for maskable icons)
   4. Resolves the build path using `path.resolve()` for absolute path
-  5. Creates the output directory if it doesn't exist using `fs.mkdir()` with `recursive: true`
+  5. Creates the output directory if it doesn’t exist using `fs.mkdir()` with `recursive: true`
   6. Calls the `favicons()` function from the favicons package with `sourcePath` and `config`
   7. Uses `Promise.all()` to handle concurrent file writing operations:
      - **Image files**: Maps through `faviconsResult.images` array
@@ -2333,3 +2337,14 @@ favicons/
 
 This is a personal tool and no contributions are expected.
 At least for now. 😋
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/%40mevbg%2Fdesign-essentials-vendor/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/@mevbg/design-essentials-vendor
+
+[license-src]: https://img.shields.io/npm/l/%40mevbg%2Fdesign-essentials-vendor.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://github.com/mevbg/design-essentials-vendor/blob/main/LICENSE
+
+[style-dictionary-src]: https://img.shields.io/badge/Style%20Dictionary-%5E5.0.1-3fc6c0?colorA=020420
+[style-dictionary-href]: https://styledictionary.com

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mevbg/design-essentials-vendor",
   "title": "Design Essentials Vendor",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Mev’s personal vendor of design system essentials.",
   "keywords": [
     "design essentials vendor",