beathers 5.3.3 → 5.3.5

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.
@@ -4,7 +4,7 @@ const commands = [
4
4
  { cmd: '-v', description: 'Show beathers version' },
5
5
  { divider: true },
6
6
  { cmd: 'init', description: 'Initialize beathers configuration file' },
7
- { cmd: 'build', description: 'Build theme from configuration file' },
7
+ { cmd: 'build:pack', description: 'Build theme from configuration file' },
8
8
  { divider: true },
9
9
  { cmd: 'add-font', description: 'Add a new font to the configuration file' },
10
10
  { cmd: 'remove-font', description: 'Remove a font from the configuration file' },
@@ -37,6 +37,6 @@ export function Help() {
37
37
  });
38
38
  console.log('\nFlags:');
39
39
  console.log(" --local Build with user's custom output path (use with build command)");
40
- console.log(' Example: npx beathers build --local');
40
+ console.log(' Example: npx beathers build:pack --local');
41
41
  console.log();
42
42
  }
@@ -1,3 +1,3 @@
1
1
  export declare function Commands(args: any): Record<string, () => void | Promise<void>>;
2
- export type CommandKey = '--help' | '-v' | '--version' | 'init' | 'build' | 'add-font' | 'remove-font' | 'import-font-sample' | 'add-colors' | 'remove-color' | 'import-color-pack' | 'import-color';
2
+ export type CommandKey = '--help' | '-v' | '--version' | 'init' | 'build:pack' | 'add-font' | 'remove-font' | 'import-font-sample' | 'add-colors' | 'remove-color' | 'import-color-pack' | 'import-color';
3
3
  //# sourceMappingURL=list.d.ts.map
@@ -5,7 +5,7 @@ const commands = {
5
5
  '-v': () => Version(),
6
6
  '--version': () => Version(),
7
7
  init: async () => await Init(),
8
- build: async () => await Build(),
8
+ 'build:pack': async () => await Build(),
9
9
  '--local': async () => await Build(),
10
10
  'add-font': async () => await AddFont(),
11
11
  'remove-font': async () => await RemoveFont(),
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Beathers v5.3.3 (https://bhoenixstudio.com/beathers)
2
+ * Beathers v5.3.5 (https://bhoenixstudio.com/beathers)
3
3
  * Copyright 2020-2025 Bhoenix Studio
4
4
  */
5
5
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "beathers",
3
- "version": "5.3.3",
3
+ "version": "5.3.5",
4
4
  "type": "module",
5
5
  "description": "Beather is a lightweight SCSS library that serves as a comprehensive design system for your projects. It offers a structured and consistent approach to manage colors, fonts, and other design related variables, making it easier to maintain a cohesive visual identity across your application.",
6
6
  "main": "dist/index.js",
@@ -21,10 +21,10 @@
21
21
  "beathers": "dist/scripts/cli.js"
22
22
  },
23
23
  "scripts": {
24
- "watch": "nodemon --watch src/scss/ --ext scss --exec \"npm-run-all build\"",
25
- "build": "sass --style compressed --source-map --embed-sources --no-error-css src/scss/:dist/css/",
24
+ "watch": "nodemon --watch src/scss/ --ext scss --exec \"npm-run-all build:pack\"",
25
+ "build:pack": "sass --style compressed --source-map --embed-sources --no-error-css src/scss/:dist/css/",
26
26
  "build:test": "tsx src/scripts/cli.ts",
27
- "build:publish": "rimraf dist && tsc && copyfiles -u 1 \"src/scss/**/*\" dist/ && npm run build",
27
+ "build:publish": "rimraf dist && tsc && copyfiles -u 1 \"src/scss/**/*\" dist/ && npm run build:pack",
28
28
  "lint": "eslint . && stylelint \"**/*.scss\"",
29
29
  "lint:fix": "eslint . --fix && stylelint \"**/*.scss\" --fix",
30
30
  "format:check": "prettier --check --ignore-path .gitignore .",
@@ -56,7 +56,8 @@
56
56
  "license": "MIT",
57
57
  "homepage": "https://bhoenixstudio.com/beathers",
58
58
  "dependencies": {
59
- "fs-extra": "^11.3.0"
59
+ "fs-extra": "^11.3.0",
60
+ "sass": "^1.88.0"
60
61
  },
61
62
  "devDependencies": {
62
63
  "@eslint/js": "^9.26.0",
@@ -76,7 +77,6 @@
76
77
  "postcss-scss": "^4.0.9",
77
78
  "prettier": "^3.5.3",
78
79
  "rimraf": "^6.0.1",
79
- "sass": "^1.88.0",
80
80
  "stylelint": "^16.19.1",
81
81
  "stylelint-config-prettier": "^9.0.5",
82
82
  "stylelint-config-standard-scss": "^15.0.1",
package/readme.md CHANGED
@@ -7,7 +7,6 @@
7
7
  [![License](https://img.shields.io/badge/license-MIT-black.svg)](https://opensource.org/licenses/MIT)
8
8
  [![Changelog](https://img.shields.io/badge/Changelog-View-blue?style=flat)](https://www.npmjs.com/package/beathers?activeTab=code)
9
9
 
10
-
11
10
  Beathers is a lightweight, powerful SCSS library designed to accelerate your web development workflow.**Everything is fully customizable** through a simple configuration file, allowing you to tailor every aspect to match your brand and requirements. It offers a comprehensive suite of SCSS mixins, variables, and utility classes, enabling you to build responsive, visually appealing web applications with complete design control.
12
11
 
13
12
  ## Get Started
@@ -41,7 +40,7 @@ This will prompt you to:
41
40
  Generate your custom CSS from the configuration:
42
41
 
43
42
  ```bash
44
- npx beathers build
43
+ npx beathers
45
44
  ```
46
45
 
47
46
  ### CLI Commands
@@ -51,8 +50,8 @@ Beathers provides a comprehensive set of CLI commands to manage your design syst
51
50
  #### Configuration
52
51
 
53
52
  - `npx beathers init` - Initialize a new configuration file
54
- - `npx beathers build` - Build theme from configuration
55
- - `npx beathers build --local` - Build with custom output path
53
+ - `npx beathers` - Build theme from configuration
54
+ - `npx beathers --local` - Build with custom output path
56
55
 
57
56
  #### Font Management
58
57
 
@@ -85,11 +84,21 @@ Beathers provides a comprehensive set of CLI commands to manage your design syst
85
84
 
86
85
  ```scss
87
86
  // Import the entire library
88
- @import 'node_modules/beathers/src/scss/beathers.min.scss';
87
+ @import 'node_modules/beathers/dist/scss/beathers.min.scss';
89
88
 
90
89
  // Or import specific modules
91
- @import 'node_modules/beathers/src/scss/functions/colors';
92
- @import 'node_modules/beathers/src/scss/style/grid';
90
+ @import 'node_modules/beathers/dist/scss/functions/colors';
91
+ @import 'node_modules/beathers/dist/scss/style/grid';
92
+
93
+ // Or import using @use with changing variables
94
+ @use 'node_modules/beathers/dist/scss/beathers.min.scss' with (
95
+ $colors: (
96
+ 1: (
97
+ 'light': '#000000',
98
+ 'dark': '$ffffff',
99
+ ),
100
+ )
101
+ );
93
102
  ```
94
103
 
95
104
  **JavaScript/Framework Import:**