beathers 5.0.0 → 5.1.0

package/dist/scripts/BuildTheme.js

@@ -1,99 +1,30 @@
+/* eslint-disable no-console */
 import fs from 'fs-extra';
 import * as path from 'node:path';
 import { fileURLToPath } from 'node:url';
-import { LoadUserConfigs } from './LoadUserConfigs.js';
-import { DeepMerge } from './Merge.js';
-import { ReadDefaultValues } from './ReadDefaultValues.js';
 import { BuildScssVariables } from './BuildScssVariables.js';
 import { CallNewVariables } from './CallNewVariables.js';
+import { LoadUserConfigs } from './LoadUserConfigs.js';
+import { DeepMerge } from './Merge.js';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const projectRoot = path.resolve(__dirname, '../..');
 const variablesPath = path.join(projectRoot, 'src', 'scss', '_variables.scss');
-async function defaultTheme() {
-    let values = null;
-    try {
-        values = await ReadDefaultValues([
-            path.join(projectRoot, 'src', 'scss', 'settings', '_defaults.scss'),
-            path.join(projectRoot, 'src', 'scss', 'settings', '_configs.scss'),
-            path.join(projectRoot, 'src', 'scss', 'settings', '_index.scss'),
-        ], [
-            'colors',
-            'fonts',
-            'fontMainPath',
-            'fontFormat',
-            'fontWeights',
-            'fontStyles',
-            'textTruncate',
-            'defaultFontFamilies',
-            'fontSizes',
-            'axisDivisions',
-            'breakpoints',
-            'wrappers',
-            'opacities',
-            'blurValues',
-            'insetValues',
-            'guttersValues',
-            'bordersValue',
-            'radiuses',
-            'useMediaQueries',
-            'useIcons',
-            'useFontFamilies',
-            'useFontSizes',
-            'useFontShapes',
-            'useTextAligns',
-            'useTextTruncate',
-            'useColors',
-            'useColorsOpacities',
-            'useColorsLightMode',
-            'useColorsDarkMode',
-            'useCurrentColors',
-            'useRootColors',
-            'useGrid',
-            'useFlex',
-            'useTransitions',
-            'useWrappers',
-            'useShadows',
-            'useDisplays',
-            'useOverflows',
-            'useOpacities',
-            'useBlur',
-            'useObjectFits',
-            'usePositions',
-            'useInsets',
-            'useSizes',
-            'useGutters',
-            'useBorders',
-            'useTextBorders',
-            'useRadius',
-        ]);
-    }
-    catch (error) {
-        // eslint-disable-next-line no-console
-        console.error('❌ buildCustomTheme failed:', error instanceof Error ? error.message : error);
-        process.exit(1);
-    }
-    return values;
-}
 export async function BuildTheme() {
     try {
-        const defaults = await defaultTheme();
         const userConfigs = await LoadUserConfigs();
-        const theme = DeepMerge(defaults, userConfigs);
+        const theme = DeepMerge({}, userConfigs);
         const variablesString = BuildScssVariables(theme);
         await fs.writeFile(variablesPath, variablesString, { flag: 'w' });
         await CallNewVariables(projectRoot);
     }
     catch (error) {
-        // eslint-disable-next-line no-console
         console.error('Error during custom theme build:', error);
         throw error;
     }
 }
-// For backward compatibility when run directly
-if (import.meta.url === `file://${process.argv[1]}`) {
+if (import.meta.url === `file://${process.argv[1]}`)
     BuildTheme().catch((error) => {
         console.error(error);
         process.exit(1);
     });
-}

package/dist/scripts/cli.js

@@ -1,6 +1,195 @@
 #!/usr/bin/env node
+/* eslint-disable no-console */
+import fs from 'fs-extra';
+import path from 'path';
 import { BuildTheme } from './BuildTheme.js';
-async function main() {
+import { ReadDefaultValues } from './ReadDefaultValues.js';
+const commands = {
+    build: { description: 'Build theme from configuration files', examples: ['beathers build'] },
+    init: { description: 'Initialize beathers configuration file', examples: ['beathers init'] },
+    version: { description: 'Show version information', examples: ['beathers -v', 'beathers --version'] },
+    help: { description: 'Show help information', examples: ['beathers --help'] },
+};
+function showHelp() {
+    console.log('\n🎨 Beathers CLI - Design System Builder\n');
+    const table = [
+        ['Command', 'Description', 'Examples'],
+        ['-------', '-----------', '--------'],
+    ];
+    Object.entries(commands).forEach(([cmd, info]) => {
+        table.push([cmd, info.description, info.examples[0]]);
+        if (info.examples.length > 1) {
+            info.examples.slice(1).forEach((example) => {
+                table.push(['', '', example]);
+            });
+        }
+    });
+    const maxLengths = table[0].map((_, colIndex) => Math.max(...table.map((row) => row[colIndex].length)));
+    table.forEach((row) => {
+        const formattedRow = row.map((cell, colIndex) => cell.padEnd(maxLengths[colIndex])).join('  ');
+        console.log(formattedRow);
+    });
+    console.log('\nFlags:');
+    console.log('  --help                Show this help message');
+    console.log('  -v, --version         Show version information');
+    console.log();
+}
+function showVersion() {
+    const packagePath = path.join(process.cwd(), 'package.json');
+    try {
+        const packageInfo = fs.readJsonSync(packagePath);
+        console.log(`Beathers v${packageInfo.version}`);
+    }
+    catch {
+        console.log('Beathers CLI');
+    }
+}
+async function getDefaultValues() {
+    const projectRoot = path.resolve(path.dirname(new URL(import.meta.url).pathname), '..', '..');
+    return (await ReadDefaultValues([
+        path.join(projectRoot, 'src', 'scss', 'settings', '_defaults.scss'),
+        path.join(projectRoot, 'src', 'scss', 'settings', '_configs.scss'),
+        path.join(projectRoot, 'src', 'scss', 'settings', '_index.scss'),
+    ], [
+        'colors',
+        'fonts',
+        'fontMainPath',
+        'fontFormat',
+        'fontWeights',
+        'fontStyles',
+        'textTruncate',
+        'defaultFontFamilies',
+        'fontSizes',
+        'axisDivisions',
+        'breakpoints',
+        'wrappers',
+        'opacities',
+        'blurValues',
+        'insetValues',
+        'guttersValues',
+        'bordersValue',
+        'radiuses',
+        'useMediaQueries',
+        'useIcons',
+        'useFontFamilies',
+        'useFontSizes',
+        'useFontShapes',
+        'useTextAligns',
+        'useTextTruncate',
+        'useColors',
+        'useColorsOpacities',
+        'useColorsLightMode',
+        'useColorsDarkMode',
+        'useCurrentColors',
+        'useRootColors',
+        'useGrid',
+        'useFlex',
+        'useTransitions',
+        'useWrappers',
+        'useShadows',
+        'useDisplays',
+        'useOverflows',
+        'useOpacities',
+        'useBlur',
+        'useObjectFits',
+        'usePositions',
+        'useInsets',
+        'useSizes',
+        'useGutters',
+        'useBorders',
+        'useTextBorders',
+        'useRadius',
+    ]));
+}
+async function promptUser(question) {
+    const readline = await import('readline');
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    return new Promise((resolve) => {
+        rl.question(question, (answer) => {
+            rl.close();
+            resolve(answer.toLowerCase().startsWith('y'));
+        });
+    });
+}
+async function promptFormat() {
+    const readline = await import('readline');
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    return new Promise((resolve) => {
+        rl.question('📁 Choose file format (json/js/ts) [json]: ', (answer) => {
+            rl.close();
+            const format = answer.toLowerCase().trim();
+            if (format === 'js' || format === 'ts')
+                resolve(format);
+            else
+                resolve('json');
+        });
+    });
+}
+async function initCommand() {
+    const format = await promptFormat();
+    const formatMap = { json: 'beathers.configs.json', js: 'beathers.configs.js', ts: 'beathers.configs.ts' };
+    const fileName = formatMap[format];
+    const filePath = path.join(process.cwd(), fileName);
+    if (await fs.pathExists(filePath)) {
+        const shouldOverride = await promptUser(`⚠️ ${fileName} already exists. Do you want to override it? (y/n): `);
+        if (!shouldOverride) {
+            console.log('❌ Operation aborted.');
+            return;
+        }
+    }
+    const includeStarterValues = await promptUser('📝 Would you like to include starter configuration values? (y/n): ');
+    const emptyTemplate = {
+        colors: {},
+        typography: {
+            defaultFontFamilies: [],
+            fontMainPath: '',
+            fontFormat: '',
+            fontWeights: [],
+            fontStyles: [],
+            fontSizes: {},
+            textTruncate: 0,
+            fonts: {},
+        },
+        settings: {
+            axisDivisions: 0,
+            opacities: [],
+            blurValues: [],
+            insetValues: [],
+            bordersValue: 0,
+            radiuses: [],
+            breakpoints: {},
+            wrappers: {},
+            guttersValues: {},
+        },
+        roles: {},
+    };
+    let content = '';
+    if (format === 'json') {
+        const data = includeStarterValues ? await getDefaultValues() : emptyTemplate;
+        content = JSON.stringify(data, null, 2);
+    }
+    else if (format === 'js') {
+        if (includeStarterValues) {
+            const defaultValues = await getDefaultValues();
+            content = `export default ${JSON.stringify(defaultValues, null, 2)}`;
+        }
+        else
+            content = `export default ${JSON.stringify(emptyTemplate, null, 2)}`;
+    }
+    else if (format === 'ts') {
+        const importLine = "import { Theme } from 'beathers'\n\n";
+        if (includeStarterValues) {
+            const defaultValues = await getDefaultValues();
+            content = `${importLine}export default ${JSON.stringify(defaultValues, null, 2)} satisfies Theme`;
+        }
+        else
+            content = `${importLine}export default ${JSON.stringify(emptyTemplate, null, 2)} satisfies Theme`;
+    }
+    await fs.writeFile(filePath, content);
+    const starterText = includeStarterValues ? ' with starter configuration values' : '';
+    console.log(`✅ Created ${fileName}${starterText}`);
+}
+async function buildCommand() {
     try {
         console.log('🎨 Building Beathers theme...');
         await BuildTheme();
@@ -11,4 +200,23 @@ async function main() {
         process.exit(1);
     }
 }
+async function main() {
+    const args = process.argv.slice(2);
+    if (args.length === 0 || args[0] === 'build') {
+        await buildCommand();
+        return;
+    }
+    const command = args[0];
+    if (command === 'init')
+        await initCommand();
+    else if (command === '--help')
+        showHelp();
+    else if (['-v', '--version'].includes(command))
+        showVersion();
+    else {
+        console.error(`❌ Unknown command: ${command}`);
+        console.log('\nUse "beathers --help" to see available commands.');
+        process.exit(1);
+    }
+}
 main();

package/dist/scripts/types.d.ts

@@ -15,7 +15,7 @@ export interface FontVariant {
 export type FontType = {
     weights?: FontWeight[];
     styles?: FontStyle[];
-    variants?: FontVariant[];
+    variants?: Record<string, FontVariant>;
 };
 export interface Typography {
     defaultFontFamilies?: string[];
@@ -23,9 +23,7 @@ export interface Typography {
     fontFormat?: 'woff' | 'woff2';
     fontWeights?: FontWeight[];
     fontStyles?: FontStyle[];
-    fontSizes?: {
-        [sizeName: string]: FontSize;
-    };
+    fontSizes?: Record<string, FontSize>;
     textTruncate?: number;
     fonts?: Record<string, FontType>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beathers",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "type": "module",
   "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.",
   "main": "dist/index.js",
@@ -9,45 +9,40 @@
     "beathers": "dist/scripts/cli.js"
   },
   "scripts": {
-    "watch": "nodemon --watch src/scss/ --ext scss --exec \"npm-run-all build\"",
-    "watch:expanded": " nodemon --watch src/scss/ --ext scss --exec \"npm-run-all build:expanded\"",
-    "build": "sass --style compressed --source-map --embed-sources --no-error-css src/scss/:dist/css/",
-    "build:expanded": "sass --style expanded --source-map --embed-sources --no-error-css src/scss/:dist/css/expanded/",
-    "build:clean": "rimraf dist",
-    "build:lib": "tsc",
-    "build:all": "rimraf dist && npm run build:lib && npm run build",
-    "build:with-configs": "tsx src/scripts/BuildTheme.ts",
-    "watch:with-configs": "nodemon --watch src --ext ts --exec \"tsx src/scripts/BuildTheme.ts\"",
-    "prepublishOnly": "npm run build:all",
+    "watch": "nodemon --watch src/scss/ --ext scss --exec \"npm-run-all build:expanded\"",
+    "build:compressed": "sass --style compressed --source-map --embed-sources --no-error-css src/scss/:dist/css/",
+    "build:expanded": "sass --style expanded --source-map --embed-sources --no-error-css src/scss/:dist/css/",
+    "build:user-configs": "tsx src/scripts/BuildTheme.ts",
+    "prepublish": "rimraf dist && tsc && pnpm build:compressed",
     "lint": "eslint . && stylelint \"**/*.scss\"",
-    "lint:fix": "eslint . --fix && stylelint \"**/*.scss\" --fix",
-    "lint:scss": "stylelint \"**/*.scss\"",
-    "lint:scss:fix": "stylelint \"**/*.scss\" --fix",
     "format:check": "prettier --check --ignore-path .gitignore .",
     "format:fix": "prettier --write --ignore-path .gitignore . && pnpm lint"
   },
   "keywords": [
-    "Design-system",
-    "Bhoenix",
-    "Feather",
-    "Beathers",
-    "SCSS",
-    "CSS",
-    "responsive",
-    "front-end",
-    "framework",
-    "web"
+    "design-system",
+    "scss-library",
+    "css-framework",
+    "utility-first",
+    "responsive-design",
+    "dark-mode",
+    "light-mode",
+    "theming",
+    "css-variables",
+    "typography",
+    "flexbox",
+    "css-grid",
+    "media-queries",
+    "atomic-css",
+    "modular-css",
+    "frontend-framework",
+    "scalable-css",
+    "customizable-theme",
+    "component-library",
+    "ui-framework"
   ],
   "author": "Bhoenix studio",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/BhoenixStudio/Beathers.git"
-  },
-  "bugs": {
-    "url": "https://github.com/BhoenixStudio/Beathers/issues"
-  },
-  "homepage": "https://github.com/BhoenixStudio/Beathers#readme",
+  "homepage": "https://bhoenixstudio.com/beathers",
   "dependencies": {
     "fs-extra": "^11.3.0"
   },
@@ -79,6 +74,7 @@
     "dist/css/**/*.{css,map}",
     "dist/**/*.{js,d.ts}",
     "src/scss/**/*.scss",
+    "public/images/logo.png",
     "readme.md"
   ]
 }