penguins-eggs 25.10.30 → 25.11.12

package/dist/classes/daddy.js

@@ -1,18 +1,15 @@
 /**
  * ./src/classes/daddy.ts
- * penguins-eggs v.25.7.x / ecmascript 2020
- * author: Piero Proietti
- * email: piero.proietti@gmail.com
+ * penguins-eggs v.25.7.x / ECMAScript 2020
+ * author: Piero Proietti (modified by Hossein Seilani)
  * license: MIT
  */
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 import yaml from 'js-yaml';
-import fs from 'node:fs';
-// _dirname
+import fs from 'node:fs/promises';
 import path from 'node:path';
 import { exec } from '../lib/utils.js';
-// We need to remove .js extension from import
 import Pacman from '../classes/pacman.js';
 import Settings from '../classes/settings.js';
 import Utils from '../classes/utils.js';
@@ -20,159 +17,191 @@ const __dirname = path.dirname(new URL(import.meta.url).pathname);
 export default class Daddy {
     settings = {};
     /**
-     * editConfif
-     * @param c
-     * @returns
+     * [CHANGE 1] Modular, type-safe, interactive configuration editor
+     * This method asks the user for LiveCD parameters using inquirer and returns
+     * a fully typed IEggsConfig object. It replaces the older JSON.stringify/parse approach.
      */
-    async editConfig(c) {
-        // Utils.titles('dad')
-        console.log(chalk.cyan('Edit and save Live system parameters'));
-        console.log();
-        let compressionOpt = 0;
-        if (c.compression === 'xz') {
-            compressionOpt = 1;
+    async editConfig(config) {
+        console.log(chalk.cyan('Edit and save Live system parameters\n'));
+        // Determine default compression option
+        let compressionOpt;
+        switch (config.compression) {
+            case 'xz':
+                compressionOpt = 1;
+                break;
+            case 'xz -Xbcj x86':
+                compressionOpt = 2;
+                break;
+            default:
+                compressionOpt = 0;
+                break;
+        }
+        // Provide a default snapshot prefix if empty
+        if (!config.snapshot_prefix) {
+            config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId);
         }
-        else if (c.compression === 'xz -Xbcj x86') {
-            compressionOpt = 2;
+        /**
+         *     // Define type-safe inquirer questions
+         * const questions: inquirer.QuestionCollection<IEggsConfig> = [
+         */
+        const questions = [
+            {
+                type: 'input',
+                name: 'snapshot_prefix',
+                message: 'LiveCD iso prefix: ',
+                default: config.snapshot_prefix,
+            },
+            {
+                type: 'input',
+                name: 'snapshot_basename',
+                message: 'LiveCD iso basename: ',
+                default: config.snapshot_basename,
+            },
+            {
+                type: 'input',
+                name: 'user_opt',
+                message: 'LiveCD user:',
+                default: config.user_opt,
+            },
+            {
+                type: 'input',
+                name: 'user_opt_passwd',
+                message: 'LiveCD user password:',
+                default: config.user_opt_passwd,
+            },
+            {
+                type: 'input',
+                name: 'root_passwd',
+                message: 'LiveCD root password:',
+                default: config.root_passwd,
+            },
+            {
+                type: 'list',
+                name: 'compression',
+                message: 'LiveCD compression: ',
+                choices: ['fast', 'max'],
+                default: compressionOpt,
+            },
+        ];
+        try {
+            // Prompt the user and return the typed config object
+            const answers = await inquirer.prompt(questions);
+            return answers;
         }
-        if (c.snapshot_prefix === '') {
-            c.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId);
+        catch (err) {
+            console.error(chalk.red('Error editing configuration:'), err);
+            throw err;
         }
-        return new Promise((resolve) => {
-            const questions = [
-                {
-                    default: c.snapshot_prefix,
-                    message: 'LiveCD iso prefix: ',
-                    name: 'snapshot_prefix',
-                    type: 'input'
-                },
-                {
-                    default: c.snapshot_basename,
-                    message: 'LiveCD iso basename: ',
-                    name: 'snapshot_basename',
-                    type: 'input'
-                },
-                {
-                    default: c.user_opt,
-                    message: 'LiveCD user:',
-                    name: 'user_opt',
-                    type: 'input'
-                },
-                {
-                    default: c.user_opt_passwd,
-                    message: 'LiveCD user password: ',
-                    name: 'user_opt_passwd',
-                    type: 'input'
-                },
-                {
-                    default: c.root_passwd,
-                    message: 'LiveCD root password: ',
-                    name: 'root_passwd',
-                    type: 'input'
-                },
-                {
-                    choices: ['fast', 'max'],
-                    default: compressionOpt,
-                    message: 'LiveCD compression: ',
-                    name: 'compression',
-                    type: 'list'
-                }
-            ];
-            inquirer.prompt(questions).then((options) => {
-                resolve(JSON.stringify(options));
-            });
-        });
     }
     /**
-     *
-     * @param reset
-     * @param isCustom
-     * @param fileCustom
-     * @param verbose
+     * [CHANGE 2] Central method to manage environment, configuration and save
+     * This method is modular, type-safe, and handles:
+     * - Pacman and distro templates check
+     * - Load, reset, or apply custom configuration
+     * - Save configuration to disk
+     * - Provide clear guidance to the user
      */
     async helpMe(reset = false, isCustom = false, fileCustom = '', verbose = false) {
-        if (isCustom) {
-            console.log('using custom file:', fileCustom);
+        try {
+            if (isCustom)
+                console.log('Using custom file:', fileCustom);
+            // Step 1: Check system prerequisites
+            await this.checkPacman(verbose);
+            // Step 2: Load settings
+            this.settings = new Settings();
+            const loaded = await this.settings.load();
+            let config = loaded ? this.settings.config : {};
+            // Step 3: Apply reset or custom configuration
+            if (reset || isCustom) {
+                await this.applyResetOrCustomConfig(config, isCustom, fileCustom);
+            }
+            else {
+                config = await this.editConfig(config);
+            }
+            // Step 4: Save final configuration
+            await this.settings.save(config);
+            // Step 5: Display help messages
+            this.displayFinalHelp();
         }
-        // Controllo configurazione
+        catch (err) {
+            console.error(chalk.red('An error occurred in helpMe:'), err);
+        }
+    }
+    /**
+     * Check and install Pacman configuration and templates if missing
+     */
+    async checkPacman(verbose) {
         if (!Pacman.configurationCheck()) {
-            console.log('- creating configuration dir...');
+            console.log('- creating configuration directory...');
             await Pacman.configurationInstall(verbose);
         }
-        // Templates
         if (!Pacman.distroTemplateCheck()) {
-            console.log('- distro template install...');
+            console.log('- installing distro template...');
             await Pacman.distroTemplateInstall(verbose);
         }
-        //Calamares 
-        if (!Pacman.calamaresExists() &&
-            Pacman.isInstalledGui() &&
-            Pacman.isCalamaresAvailable()) {
-            console.log('- this is a GUI system, calamares is available, but NOT installed');
+        if (!Pacman.calamaresExists() && Pacman.isInstalledGui() && Pacman.isCalamaresAvailable()) {
+            console.log('- GUI system detected, calamares is available but not installed.');
         }
-        // show and edit configuration
-        this.settings = new Settings();
-        let config = {};
-        let jsonConf = '';
-        if (await this.settings.load()) {
-            config = this.settings.config;
-            config.compression = 'fast';
-            if (reset || isCustom) {
-                // add fstype to snapshot_prefix 
-                if (config.snapshot_prefix === '') {
-                    let fstype = ((await exec(`findmnt -n -o FSTYPE /`, { capture: true })).data.trim());
-                    if (fstype === 'ext4') {
-                        fstype = '';
-                    }
-                    else {
-                        // btrfs-, etc
-                        fstype += '-';
-                    }
-                    // excluded now
-                    fstype = '';
-                    config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId) + fstype;
-                }
-                jsonConf = JSON.stringify(config);
-            }
-            else {
-                jsonConf = await this.editConfig(config);
+    }
+    /**
+     * Apply reset or custom configuration
+     */
+    async applyResetOrCustomConfig(config, isCustom, fileCustom) {
+        // Reset snapshot prefix if empty
+        if (!config.snapshot_prefix) {
+            let fstype = '';
+            try {
+                const { data } = await exec(`findmnt -n -o FSTYPE /`, { capture: true });
+                fstype = data.trim() === 'ext4' ? '' : `${data.trim()}-`;
             }
-            // Custom configuration
-            if (isCustom) {
-                const conf = fs.readFileSync(fileCustom, 'utf8');
-                const confCustom = yaml.load(conf);
-                config.snapshot_basename = confCustom.snapshot_basename;
-                config.snapshot_prefix = confCustom.snapshot_prefix;
-                config.user_opt = confCustom.user_opt;
-                config.user_opt_passwd = confCustom.user_opt_passwd;
-                config.root_passwd = confCustom.root_passwd;
-                config.theme = confCustom.theme;
-                jsonConf = JSON.stringify(config);
+            catch (err) {
+                console.warn('Unable to detect FSTYPE:', err);
             }
-            // Save new configuration
-            const confNew = JSON.parse(jsonConf);
-            config.snapshot_basename = confNew.snapshot_basename;
-            config.snapshot_prefix = confNew.snapshot_prefix;
-            config.user_opt = confNew.user_opt;
-            config.user_opt_passwd = confNew.user_opt_passwd;
-            config.root_passwd = confNew.root_passwd;
-            config.theme = confNew.theme;
-            await this.settings.save(config);
+            config.snapshot_prefix = Utils.snapshotPrefix(this.settings.distro.distroId, this.settings.distro.codenameId) + fstype;
+        }
+        // Apply custom YAML if needed
+        if (isCustom && fileCustom) {
+            await this.applyCustomYAML(config, fileCustom);
+        }
+    }
+    /**
+     * Load and apply a custom YAML configuration
+     * [CHANGE 3] Async reading of file and type-safe parsing
+     */
+    async applyCustomYAML(config, fileCustom) {
+        try {
+            const conf = await fs.readFile(fileCustom, 'utf8');
+            const confCustom = yaml.load(conf);
+            // Safely copy fields from YAML to config
+            config.snapshot_basename = confCustom.snapshot_basename ?? config.snapshot_basename;
+            config.snapshot_prefix = confCustom.snapshot_prefix ?? config.snapshot_prefix;
+            config.user_opt = confCustom.user_opt ?? config.user_opt;
+            config.user_opt_passwd = confCustom.user_opt_passwd ?? config.user_opt_passwd;
+            config.root_passwd = confCustom.root_passwd ?? config.root_passwd;
+            config.theme = confCustom.theme ?? config.theme;
         }
+        catch (err) {
+            console.error(chalk.red('Failed to load custom YAML config:'), err);
+            throw err;
+        }
+    }
+    /**
+     * Display final guidance and tips to the user
+     * [CHANGE 4] Modular, clear, user-friendly messages
+     */
+    displayFinalHelp() {
         console.log();
         console.log(chalk.cyan('Your configuration was saved on: /etc/penguins-eggs.d'));
+        console.log(chalk.cyan('You can create a clean ISO with: ') + chalk.white('sudo eggs produce'));
+        console.log(chalk.cyan('Or a full personal clone: ') + chalk.white('sudo eggs produce --clone'));
         console.log();
-        console.log(chalk.cyan(`You can create a clean ISO with: `) + chalk.white(`sudo eggs produce`));
-        console.log(chalk.cyan(`or a full personal clone: `) + chalk.white(`sudo eggs produce --clone`));
-        console.log();
-        console.log(chalk.cyan(`If you don't have enough space to remaster, you can mount`));
-        console.log(chalk.cyan(`some remote or local space. Follow the samples:`));
-        console.log(chalk.cyan(`- first, create an hidden mountpoint under the nest:`));
-        console.log(chalk.white(`sudo mkdir /home/eggs/.mnt -p`));
-        console.log(chalk.cyan(`- then, mount remote space:`));
-        console.log(chalk.white(`sudo sshfs -o allow_other root@192.168.1.2:/zfs/iso /home/eggs/.mnt`));
-        console.log(chalk.cyan('- or, mount a local partition:'));
-        console.log(chalk.white(`sudo mount /dev/sdx1 /home/eggs/.mnt`));
+        console.log(chalk.cyan('If you don’t have enough space to remaster, you can mount remote or local space:'));
+        console.log(chalk.cyan('- Create a hidden mountpoint under the nest:'));
+        console.log(chalk.white('sudo mkdir /home/eggs/.mnt -p'));
+        console.log(chalk.cyan('- Mount remote space:'));
+        console.log(chalk.white('sudo sshfs -o allow_other root@192.168.1.2:/zfs/iso /home/eggs/.mnt'));
+        console.log(chalk.cyan('- Or mount a local partition:'));
+        console.log(chalk.white('sudo mount /dev/sdx1 /home/eggs/.mnt'));
         console.log();
         console.log(chalk.cyan('More help? ') + chalk.white('eggs mom'));
     }

package/dist/classes/distro.js

@@ -67,10 +67,9 @@ class Distro {
             this.distroId = "Bigcommunity";
         }
         /**
-         * Alpine, Fedora, openmamba, opensuse, VoidLinux solo distroId.
+         * Alpine, Fedora, openmamba, opensuse analyze **distroId**
          *
-         * Debian, Devuan, Ubuntu e derivate ricadono in
-         * default e si analizza il codebaseId
+         * Arch, Debian, Devuan, Ubuntu and derivatives we analyze **codebaseId**
          *
          */
         if (this.distroId === 'Alpine') {
@@ -118,7 +117,7 @@ class Distro {
         }
         else {
             /**
-             * We must analize codenameId
+             * Debian/ARCH: we  analize **codenameId**
              */
             /**
              * Arch
@@ -177,13 +176,6 @@ class Distro {
                 this.distroLike = 'Debian';
                 this.distroUniqueId = 'trixie';
                 this.liveMediumPath = '/run/live/medium/'; //initramfs
-                // this.liveMediumPath = '/run/initramfs/live/'  // dracut
-                /**
-                 * dracut su trixie
-                 if (Pacman.packageIsInstalled('dracut')) {
-                   this.liveMediumPath = '/run/initramfs/live/'
-                 }
-                 */
                 /**
                  * Debian 14 forky
                  */
@@ -219,14 +211,6 @@ class Distro {
             else if (this.codenameId === 'excalibur') {
                 this.distroLike = 'Devuan';
                 this.distroUniqueId = 'excalibur';
-                /**
-                 * Ubuntu bionic
-                 */
-            }
-            else if (this.codenameId === 'bionic') {
-                this.distroLike = 'Ubuntu';
-                this.distroUniqueId = 'bionic';
-                this.liveMediumPath = '/lib/live/mount/medium/';
                 /**
                  * Ubuntu focal
                  */
@@ -264,11 +248,11 @@ class Distro {
                 /**
                  * derivatives: families archlinux, debian
                  */
-                let file = path.resolve(__dirname, '../../conf/derivatives.yaml');
+                let archDebianDerivatives = path.resolve(__dirname, '../../conf/derivatives.yaml');
                 if (fs.existsSync('/etc/penguins-eggs.d/derivatives.yaml')) {
-                    file = '/etc/penguins-eggs.d/derivatives.yaml';
+                    archDebianDerivatives = '/etc/penguins-eggs.d/derivatives.yaml';
                 }
-                const content = fs.readFileSync(file, 'utf8');
+                const content = fs.readFileSync(archDebianDerivatives, 'utf8');
                 const distros = yaml.load(content);
                 for (const distro of distros) {
                     if (distro.ids !== undefined) {
@@ -287,11 +271,11 @@ class Distro {
                  * derivatives: family fedora
                  */
                 if (!found) {
-                    let file = path.resolve(__dirname, '../../conf/derivatives_fedora.yaml');
+                    let fedoraDerivatives = path.resolve(__dirname, '../../conf/derivatives_fedora.yaml');
                     if (fs.existsSync('/etc/penguins-eggs.d/derivatives_fedora.yaml')) {
-                        file = '/etc/penguins-eggs.d/derivatives_fedora.yaml';
+                        fedoraDerivatives = '/etc/penguins-eggs.d/derivatives_fedora.yaml';
                     }
-                    const content = fs.readFileSync(file, 'utf8');
+                    const content = fs.readFileSync(fedoraDerivatives, 'utf8');
                     const elem = yaml.load(content);
                     if (elem.includes(this.distroId)) {
                         this.familyId = 'fedora';
@@ -327,7 +311,7 @@ class Distro {
             this.usrLibPath = '/usr/lib64/';
         }
         /**
-         * Manjarolinux e derivate (biglinux)
+         * Manjarolinux anf derivatives (biglinux)
          */
         if (Diversions.isManjaroBased(this.distroId)) {
             this.liveMediumPath = '/run/miso/bootmnt/';
@@ -345,7 +329,7 @@ class Distro {
                 const data = fs.readFileSync(os_release, 'utf8');
                 lines = data.split('\n');
             }
-            // per ogni riga
+            // read every line
             for (const line of lines) {
                 if (line.startsWith('HOME_URL=')) {
                     this.homeUrl = line.slice('HOME_URL='.length).replaceAll('"', '');

package/dist/classes/diversions.d.ts

@@ -1,53 +1,19 @@
 /**
  * ./src/classes/diversions.ts
  * penguins-eggs v.25.7.x / ecmascript 2020
- * author: Piero Proietti
- * email: piero.proietti@gmail.com
+ * author: Piero Proietti (modified by Hossein Seilani)
  * license: MIT
- */
-/**
- * contiene le variazione di nome
- * per ogni famiglia
+ *
+ * NEW VERSION: Improved and cleaned with detailed comments and new changes
  */
 import { IDistro } from '../interfaces/index.js';
 export default class Diversions {
-    /**
-     *
-     * @param familyId
-     * @returns
-     */
     static isSystemDBoot(familyId: string, isEfi: boolean): boolean;
-    /**
-     *
-     * @param familyId
-     * @returns deluser
-     */
     static deluser(familyId: string): string;
-    /**
-     *
-     * @param familyId
-     * @returns
-     */
     static grubName(familyId: string): string;
-    /**
-     * grubForce
-     */
     static grubForce(familyId: string): string;
-    /**
-     *
-     * @param familyId
-     * @param volid
-     * @returns
-     */
     static kernelParameters(familyId: string, volid: string, fullCrypt?: boolean): string;
-    /**
-       *
-       * @returns
-       */
     static distro(): IDistro;
-    /**
-    * isManjaroBased
-    */
     static isManjaroBased(distro: string): boolean;
     static bootloaders(familyId: string): string;
 }