@mevbg/design-essentials-vendor 2.0.3 β†’ 2.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +28 -24
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  [![npm version][npm-version-src]][npm-version-href]
6
6
  [![License][license-src]][license-href]
7
+ [![Style Dictionary][style-dictionary-src]][style-dictionary-href]
7
8
 
8
9
  ## 🎯 Overview
9
10
 
@@ -282,24 +283,24 @@ It is primarily utilized by the Viewport Scaler Generator and Tokens Generator,
282
283
  #### Usage of Master Generator
283
284
 
284
285
  ```ts
285
- import { generateDesignEssentials } from ’@mevbg/design-essentials-vendor’;
286
+ import { generateDesignEssentials } from '@mevbg/design-essentials-vendor';
286
287
 
287
288
  try {
288
289
  await generateDesignEssentials({
289
- buildPath: ’./dist’,
290
- prefix: ’mev’,
290
+ buildPath: './dist',
291
+ prefix: 'mev',
291
292
  baseFontSize: 16,
292
293
  generators: {
293
294
  favicons: {
294
- id: ’https://mev.bg’,
295
- sourcePath: ’assets/images/logo.svg’,
296
- appName: ’Mev.bg’,
297
- appShortName: ’Mev’,
298
- appDescription: ’Personal webpage’,
299
- version: ’1.0.0’
295
+ id: 'https://mev.bg',
296
+ sourcePath: 'assets/images/logo.svg',
297
+ appName: 'Mev.bg',
298
+ appShortName: 'Mev',
299
+ appDescription: 'Personal webpage',
300
+ version: '1.0.0'
300
301
  },
301
302
  fontFaces: {
302
- sourcePath: ’assets/client/fonts’,
303
+ sourcePath: 'assets/client/fonts',
303
304
  fonts: {
304
305
  Helvetica: {
305
306
  Regular: 400,
@@ -308,35 +309,35 @@ try {
308
309
  }
309
310
  },
310
311
  icons: {
311
- fontFamily: ’MevIcons’,
312
- color: ’var(--mev-color-content-gray)’,
312
+ fontFamily: 'MevIcons',
313
+ color: 'var(--mev-color-content-gray)',
313
314
  list: {
314
- main: ’E000’,
315
- nav: ’E001’,
316
- search: ’E002’,
317
- profile: ’E003’
315
+ main: 'E000',
316
+ nav: 'E001',
317
+ search: 'E002',
318
+ profile: 'E003'
318
319
  // ...
319
320
  },
320
321
  viewportScaler: {},
321
322
  scrollbar: {},
322
323
  tokens: {
323
- sourcePath: ’./design/tokens/**/index.js’,
324
- platforms: [’css’, ’js’, ’scss’],
324
+ sourcePath: './design/tokens/**/index.js',
325
+ platforms: ['css', 'js', 'scss'],
325
326
  contentScaling: {
326
327
  minViewportW: 600,
327
328
  maxViewportW: 1200
328
329
  },
329
330
  colorScheme: {
330
- default: ’light’,
331
- method: ’combined’
331
+ default: 'light',
332
+ method: 'combined'
332
333
  }
333
334
  }
334
335
  }
335
336
  }
336
337
  });
337
- console.info(’Design essentials generated successfully!’);
338
+ console.info('Design essentials generated successfully!');
338
339
  } catch (err) {
339
- console.error(’Failed to generate design essentials:’, err.message);
340
+ console.error('Failed to generate design essentials:', err.message);
340
341
  }
341
342
  ```
342
343
 
@@ -1512,7 +1513,7 @@ This generator automatically scans font directories and generates comprehensive
1512
1513
  - **Process**:
1513
1514
  1. Calls `getTypefaces(sourcePath)` to discover available fonts
1514
1515
  2. For each typeface, checks if there’s a predefined weight mapping in the `fonts` config
1515
- 3. If no mapping exists and multiple weights are detected, skips the typeface (can't determine weights)
1516
+ 3. If no mapping exists and multiple weights are detected, skips the typeface (can’t determine weights)
1516
1517
  4. Sorts weights by their numeric values if mapping exists
1517
1518
  5. Filters files to ensure only `.woff2` files are processed
1518
1519
  6. Creates FontFace objects with:
@@ -1616,7 +1617,7 @@ This generator leverages the `favicons` npm package to create comprehensive favi
1616
1617
  2. Merges default parameters with provided parameters using spread operator
1617
1618
  3. Sets `manifestMaskable` to `sourcePath` if not provided (uses same image for maskable icons)
1618
1619
  4. Resolves the build path using `path.resolve()` for absolute path
1619
- 5. Creates the output directory if it doesn't exist using `fs.mkdir()` with `recursive: true`
1620
+ 5. Creates the output directory if it doesn’t exist using `fs.mkdir()` with `recursive: true`
1620
1621
  6. Calls the `favicons()` function from the favicons package with `sourcePath` and `config`
1621
1622
  7. Uses `Promise.all()` to handle concurrent file writing operations:
1622
1623
  - **Image files**: Maps through `faviconsResult.images` array
@@ -2344,3 +2345,6 @@ At least for now. πŸ˜‹
2344
2345
 
2345
2346
  [license-src]: https://img.shields.io/npm/l/%40mevbg%2Fdesign-essentials-vendor.svg?style=flat&colorA=020420&colorB=00DC82
2346
2347
  [license-href]: https://github.com/mevbg/design-essentials-vendor/blob/main/LICENSE
2348
+
2349
+ [style-dictionary-src]: https://img.shields.io/badge/Style%20Dictionary-%5E5.0.1-3fc6c0?colorA=020420
2350
+ [style-dictionary-href]: https://styledictionary.com
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@mevbg/design-essentials-vendor",
3
3
  "title": "Design Essentials Vendor",
4
- "version": "2.0.3",
4
+ "version": "2.0.4",
5
5
  "description": "Mev’s personal vendor of design system essentials.",
6
6
  "keywords": [
7
7
  "design essentials vendor",