about-system 0.0.18 → 0.0.19

package/src/about-system-cli.ts

@@ -1,179 +1,46 @@
 #!/usr/bin/env node
-import os from 'os';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { getSystemInfo } from './system-info-api.js';
-import type { SystemInfo, SystemInfoOptions } from './systeminfo-types.js';
+import os from "os";
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import { getSystemInfo } from "./system-info-api";
+import type { SystemInfo, SystemInfoOptions } from "./systeminfo-types";
 
 const __filename = fileURLToPath(import.meta.url);
 
-// Settings configuration
-const SETTINGS_FILE = path.join(os.homedir(), '.config', 'systeminfo-settings.json');
-const CACHE_FILE = path.join(os.tmpdir(), 'systeminfo-cache.json');
-
-// Default settings
-const DEFAULT_SETTINGS = {
-  display_order: [
-    ['user', 'hostname', 'os', 'device', 'kernel', 'cpu', 'gpu'],
-    ['disk_used', 'ram_used', 'top_process', 'uptime', 'temperature', 'battery', 'load_average'],
-    ['ip', 'iplocal', 'city', 'domain', 'isp'],
-    ['shell', 'pacman', 'services_running', 'containers'],
-  ],
-  colors: {
-    user: 'red',
-    hostname: 'orange',
-    disk_used: 'purple',
-    ram_used: 'yellow',
-    top_process: 'magenta',
-    uptime: 'cyan',
-    ip: 'green',
-    iplocal: 'yellow',
-    city: 'green',
-    domain: 'gray',
-    isp: 'lightblue',
-    os: 'gray',
-    cpu: 'orange',
-    gpu: 'yellow',
-    device: 'yellow',
-    kernel: 'green',
-    shell: 'orange',
-    pacman: 'multicolor',
-    ports: 'multicolor',
-    containers: 'green',
-    memory_available: 'blue',
-    swap_used: 'purple',
-    load_average: 'red',
-    users_logged_in: 'cyan',
-    network_interfaces: 'yellow',
-    mount_points: 'gray',
-    services_running: 'green',
-    temperature: 'red',
-    battery: 'green',
-    screen_resolution: 'blue',
-  },
-  display: {
-    show_emojis: true,
-    single_line: false,
-    line_wrap_length: process?.stdout?.columns || 100,
-  },
-  network: {
-    show_offline_message: true,
-  },
-  advanced: {
-    debug: false,
-  },
-};
-
-// Color codes
-const colors = {
-  reset: '\x1b[0m',
-  red: '\x1b[38;5;196m',
-  orange: '\x1b[38;5;208m',
-  yellow: '\x1b[38;5;226m',
-  green: '\x1b[38;5;46m',
-  blue: '\x1b[38;5;39m',
-  cyan: '\x1b[38;5;51m',
-  purple: '\x1b[38;5;171m',
-  magenta: '\x1b[38;5;213m',
-  gray: '\x1b[38;5;250m',
-  lightblue: '\x1b[38;5;220m',
-};
-
-// Emoji mappings
-const emojis: Record<string, string> = {
-  user: '👤 ',
-  hostname: '🏠 ',
-  ip: '🌎 ',
-  iplocal: '🌐 ',
-  city: '📍 ',
-  domain: '🔗 ',
-  isp: '👮 ',
-  os: '⚡ ',
-  cpu: '📈 ',
-  gpu: '🎮 ',
-  device: '💻 ',
-  kernel: '🔧 ',
-  shell: '🐚 ',
-  pacman: '🚀 ',
-  disk_used: '📁 ',
-  ram_used: '💾 ',
-  top_process: '🔝 ',
-  uptime: '⏱️  ',
-  ports: '🔌 ',
-  containers: '📦',
-  memory_available: '🧠 ',
-  swap_used: '🔄 ',
-  load_average: '⚖️ ',
-  users_logged_in: '👥 ',
-  network_interfaces: '🌐 ',
-  mount_points: '📂 ',
-  services_running: '⚙️ ',
-  temperature: '🌡️ ',
-  battery_charging: '🔌 ',
-  battery: '🔋 ',
-  screen_resolution: '🖥️ ',
-};
+import {
+  Settings,
+  DEFAULT_SETTINGS,
+  colors,
+  SETTINGS_FILE,
+  CACHE_FILE,
+  loadSettings,
+  saveSettings,
+} from "./info/settings";
 
 // Platform detection
-const IS_WINDOWS = os.platform() === 'win32';
-
-interface Settings {
-  display_order: string[][];
-  colors: Record<string, string>;
-  display: {
-    show_emojis: boolean;
-    single_line: boolean;
-    line_wrap_length: number;
-  };
-  network: {
-    show_offline_message: boolean;
-  };
-  advanced: {
-    debug: boolean;
-  };
-}
-
-function loadSettings(): Settings {
-  try {
-    if (fs.existsSync(SETTINGS_FILE)) {
-      const settings = JSON.parse(fs.readFileSync(SETTINGS_FILE, 'utf8'));
-      return { ...DEFAULT_SETTINGS, ...settings };
-    }
-  } catch {}
-  return DEFAULT_SETTINGS;
-}
-
-function saveSettings(settings: Settings): boolean {
-  try {
-    const configDir = path.dirname(SETTINGS_FILE);
-    if (!fs.existsSync(configDir)) {
-      fs.mkdirSync(configDir, { recursive: true });
-    }
-    fs.writeFileSync(SETTINGS_FILE, JSON.stringify(settings, null, 2));
-    return true;
-  } catch {
-    return false;
-  }
-}
+const IS_WINDOWS = os.platform() === "win32";
 
 function formatValue(key: string, value: string, settings: Settings): string {
-  if (!value || value.trim() === '') return '';
+  if (!value || value.trim() === "") return "";
 
-  const color = colors[settings.colors[key] as keyof typeof colors] || colors.reset;
-  const emoji = settings.display.show_emojis ? emojis[key] || '' : '';
+  const color =
+    colors[settings.colors[key] as keyof typeof colors] || colors.reset;
+  const emoji = settings.display.show_emojis ? settings.emojis[key] || "" : "";
 
   // Special handling for battery emoji
-  if (key === 'battery' && settings.display.show_emojis) {
-    const batteryEmoji = value.includes('+') ? emojis.battery_charging : emojis.battery;
+  if (key === "battery" && settings.display.show_emojis) {
+    const batteryEmoji = value.includes("+")
+      ? settings.emojis.battery_charging
+      : settings.emojis.battery;
     return `${color}${batteryEmoji}${value}`;
   }
 
   // Multicolor handling for ports
-  if (key === 'ports' && settings.colors[key] === 'multicolor' && value) {
-    const emoji = settings.display.show_emojis ? emojis.ports : '';
+  if (key === "ports" && settings.colors[key] === "multicolor" && value) {
+    const emoji = settings.display.show_emojis ? settings.emojis.ports : "";
     let output = ` ${emoji}`;
-    const ports = value.split(' ');
+    const ports = value.split(" ");
     const colorCodes = [31, 32, 33, 34, 35, 36];
     ports.forEach((port, index) => {
       const colorCode = colorCodes[index % colorCodes.length];
@@ -183,8 +50,8 @@ function formatValue(key: string, value: string, settings: Settings): string {
   }
 
   // Multicolor handling for pacman
-  if (key === 'pacman' && settings.colors[key] === 'multicolor' && value) {
-    const emoji = settings.display.show_emojis ? emojis.pacman : '';
+  if (key === "pacman" && settings.colors[key] === "multicolor" && value) {
+    const emoji = settings.display.show_emojis ? settings.emojis.pacman : "";
     return `${color}${emoji}${value}`;
   }
 
@@ -192,10 +59,12 @@ function formatValue(key: string, value: string, settings: Settings): string {
 }
 
 function removeAnsiCodes(str: string): string {
-  return str.replace(/\x1b\[[0-9;]*m/g, '');
+  return str.replace(/\x1b\[[0-9;]*m/g, "");
 }
 
-async function displaySystemInfo(customDisplayOrder: string[][] | null = null): Promise<void> {
+async function displaySystemInfo(
+  customDisplayOrder: string[][] | null = null
+): Promise<void> {
   const settings = loadSettings();
   const displayOrder = customDisplayOrder || settings.display_order;
 
@@ -217,14 +86,14 @@ async function displaySystemInfo(customDisplayOrder: string[][] | null = null):
     }
 
     if (allItems.length > 0) {
-      console.log(allItems.join(' ') + colors.reset);
+      console.log(allItems.join(" ") + colors.reset);
     }
     return;
   }
 
   // Multi-line mode with intelligent wrapping
   const lines: string[] = [];
-  let currentLine = '';
+  let currentLine = "";
   const maxLineLength = settings.display.line_wrap_length;
 
   for (const group of displayOrder) {
@@ -236,7 +105,10 @@ async function displaySystemInfo(customDisplayOrder: string[][] | null = null):
         const formattedLength = removeAnsiCodes(formatted).length;
         const currentLineLength = removeAnsiCodes(currentLine).length;
 
-        if (currentLine && currentLineLength + formattedLength + 1 > maxLineLength) {
+        if (
+          currentLine &&
+          currentLineLength + formattedLength + 1 > maxLineLength
+        ) {
           lines.push(currentLine);
           currentLine = formatted;
         } else {
@@ -256,58 +128,61 @@ async function displaySystemInfo(customDisplayOrder: string[][] | null = null):
       console.log(line + colors.reset);
     });
   } else if (settings.advanced.debug) {
-    console.log('No system information could be displayed');
+    console.log("No system information could be displayed");
   }
 }
 
 function handleSettingsCommand(args: string[]): boolean {
   const settings = loadSettings();
 
-  if (args.includes('--settings-init')) {
+  if (args.includes("--settings-init")) {
     if (saveSettings(DEFAULT_SETTINGS)) {
-      console.log('Settings initialized with defaults');
+      console.log("Settings initialized with defaults");
     } else {
-      console.log('Failed to initialize settings');
+      console.log("Failed to initialize settings");
     }
     return true;
   }
 
-  if (args.includes('--settings-show')) {
-    console.log('Current settings:');
+  if (args.includes("--settings-show")) {
+    console.log("Current settings:");
     console.log(JSON.stringify(settings, null, 2));
     return true;
   }
 
-  if (args.includes('--settings-reset')) {
+  if (args.includes("--settings-reset")) {
     if (saveSettings(DEFAULT_SETTINGS)) {
-      console.log('Settings reset to defaults');
+      console.log("Settings reset to defaults");
     } else {
-      console.log('Failed to reset settings');
+      console.log("Failed to reset settings");
     }
     return true;
   }
 
-  if (args.includes('--refresh')) {
+  if (args.includes("--refresh")) {
     try {
       if (fs.existsSync(CACHE_FILE)) {
         fs.unlinkSync(CACHE_FILE);
-        console.log('Cache cleared');
+        console.log("Cache cleared");
       }
     } catch (error) {
-      console.error('Error clearing cache:', (error as Error).message);
+      console.error("Error clearing cache:", (error as Error).message);
     }
     return true;
   }
 
-  const setIndex = args.indexOf('--set');
+  const setIndex = args.indexOf("--set");
   if (setIndex !== -1 && args[setIndex + 1] && args[setIndex + 2]) {
     const key = args[setIndex + 1];
     const value = args[setIndex + 2];
 
     try {
-      const parsedValue = value.startsWith('{') || value.startsWith('[') ? JSON.parse(value) : value;
+      const parsedValue =
+        value.startsWith("{") || value.startsWith("[")
+          ? JSON.parse(value)
+          : value;
 
-      const keys = key.split('.');
+      const keys = key.split(".");
       let current: any = settings;
       for (let i = 0; i < keys.length - 1; i++) {
         if (!current[keys[i]]) current[keys[i]] = {};
@@ -318,10 +193,10 @@ function handleSettingsCommand(args: string[]): boolean {
       if (saveSettings(settings)) {
         console.log(`Setting ${key} = ${value}`);
       } else {
-        console.log('Failed to save settings');
+        console.log("Failed to save settings");
       }
     } catch (error) {
-      console.error('Error setting value:', (error as Error).message);
+      console.error("Error setting value:", (error as Error).message);
     }
     return true;
   }
@@ -334,11 +209,11 @@ function installShellGreeting(): void {
 
   let configDir: string, scriptPath: string;
   if (IS_WINDOWS) {
-    configDir = path.join(homeDir, 'AppData', 'Local');
-    scriptPath = path.join(configDir, 'systeminfo.js');
+    configDir = path.join(homeDir, "AppData", "Local");
+    scriptPath = path.join(configDir, "systeminfo");
   } else {
-    configDir = path.join(homeDir, '.config');
-    scriptPath = path.join(configDir, 'systeminfo.js');
+    configDir = path.join(homeDir, ".config");
+    scriptPath = path.join(configDir, "systeminfo");
   }
 
   const currentScript = path.resolve(__filename);
@@ -350,81 +225,99 @@ function installShellGreeting(): void {
 
     fs.copyFileSync(currentScript, scriptPath);
     if (!IS_WINDOWS) {
-      fs.chmodSync(scriptPath, '755');
+      fs.chmodSync(scriptPath, "755");
     }
 
     if (IS_WINDOWS) {
-      console.log('Windows installation:');
-      console.log('1. Script copied to:', scriptPath);
-      console.log('2. To add to PowerShell profile, run:');
+      console.log("Windows installation:");
+      console.log("1. Script copied to:", scriptPath);
+      console.log("2. To add to PowerShell profile, run:");
       console.log(`   Add-Content $PROFILE "node '${scriptPath}'"`);
-      console.log('3. To add to Command Prompt, create a batch file in your startup folder');
+      console.log(
+        "3. To add to Command Prompt, create a batch file in your startup folder"
+      );
 
-      const startupBat = path.join(configDir, 'systeminfo-startup.bat');
+      const startupBat = path.join(configDir, "systeminfo-startup.bat");
       fs.writeFileSync(startupBat, `@echo off\nnode "${scriptPath}"\n`);
-      console.log('4. Batch file created:', startupBat);
+      console.log("4. Batch file created:", startupBat);
     } else {
       try {
-        const hushLoginPath = path.join(homeDir, '.hushlogin');
-        fs.writeFileSync(hushLoginPath, '');
+        const hushLoginPath = path.join(homeDir, ".hushlogin");
+        fs.writeFileSync(hushLoginPath, "");
       } catch {}
 
-      const bashrcPath = path.join(homeDir, '.bashrc');
+      const bashrcPath = path.join(homeDir, ".bashrc");
       const bashLine = `node ${scriptPath}`;
 
       if (fs.existsSync(bashrcPath)) {
-        const bashrc = fs.readFileSync(bashrcPath, 'utf8');
-        if (!bashrc.includes('systeminfo.js')) {
+        const bashrc = fs.readFileSync(bashrcPath, "utf8");
+        if (!bashrc.includes("systeminfo")) {
           fs.appendFileSync(bashrcPath, `\n${bashLine}\n`);
         }
       } else {
         fs.writeFileSync(bashrcPath, `${bashLine}\n`);
       }
 
-      const zshrcPath = path.join(homeDir, '.zshrc');
+      const zshrcPath = path.join(homeDir, ".zshrc");
       if (fs.existsSync(zshrcPath)) {
-        const zshrc = fs.readFileSync(zshrcPath, 'utf8');
-        if (!zshrc.includes('systeminfo.js')) {
+        const zshrc = fs.readFileSync(zshrcPath, "utf8");
+        if (!zshrc.includes("systeminfo")) {
           fs.appendFileSync(zshrcPath, `\n${bashLine}\n`);
         }
       }
 
-      const fishConfigPath = path.join(homeDir, '.config', 'fish', 'config.fish');
+      const fishConfigPath = path.join(
+        homeDir,
+        ".config",
+        "fish",
+        "config.fish"
+      );
       if (fs.existsSync(fishConfigPath)) {
-        const fishConfig = fs.readFileSync(fishConfigPath, 'utf8');
-        if (!fishConfig.includes('systeminfo.js')) {
-          fs.appendFileSync(fishConfigPath, `\nset -U fish_greeting ""\n${bashLine}\n`);
+        const fishConfig = fs.readFileSync(fishConfigPath, "utf8");
+        if (!fishConfig.includes("systeminfo")) {
+          fs.appendFileSync(
+            fishConfigPath,
+            `\nset -U fish_greeting ""\n${bashLine}\n`
+          );
         }
       }
 
-      const nushellConfigPath = path.join(homeDir, '.config', 'nushell', 'config.nu');
+      const nushellConfigPath = path.join(
+        homeDir,
+        ".config",
+        "nushell",
+        "config.nu"
+      );
       if (fs.existsSync(nushellConfigPath)) {
-        const nushellConfig = fs.readFileSync(nushellConfigPath, 'utf8');
-        if (!nushellConfig.includes('systeminfo.js')) {
-          fs.appendFileSync(nushellConfigPath, `\n$env.config.show_banner = false\n${bashLine}\n`);
+        const nushellConfig = fs.readFileSync(nushellConfigPath, "utf8");
+        if (!nushellConfig.includes("systeminfo")) {
+          fs.appendFileSync(
+            nushellConfigPath,
+            `\n$env.config.show_banner = false\n${bashLine}\n`
+          );
         }
       }
     }
 
-    console.log('Shell greeting installation completed!');
+    console.log("Shell greeting installation completed!");
   } catch (error) {
-    console.error('Error installing shell greeting:', (error as Error).message);
+    console.error("Error installing shell greeting:", (error as Error).message);
     process.exit(1);
   }
 }
 
 function parseCLIMode(args: string[]): string[] | null {
   for (const arg of args) {
-    if (!arg.startsWith('--') && arg.includes(',')) {
+    if (!arg.startsWith("--") && arg.includes(",")) {
       return arg
-        .split(',')
+        .split(",")
         .map((part) => part.trim())
         .filter((part) => part.length > 0);
     }
   }
 
   for (const arg of args) {
-    if (!arg.startsWith('--') && !arg.includes('=') && arg.length > 0) {
+    if (!arg.startsWith("--") && !arg.includes("=") && arg.length > 0) {
       return [arg.trim()];
     }
   }
@@ -458,12 +351,22 @@ Examples:
   about-system --install
   about-system --set display.show_emojis false
   about-system --set colors.user blue
+  about-system --set emojis.cpu "🚀 "
+  about-system --set labels.cpu "Processor"
   about-system --json
 
 Settings file: ${SETTINGS_FILE}
 Cache file: ${CACHE_FILE}
 
-Platform: ${IS_WINDOWS ? 'Windows' : os.platform() === 'darwin' ? 'macOS' : os.platform() === 'linux' ? 'Linux' : 'Unknown'}
+Platform: ${
+    IS_WINDOWS
+      ? "Windows"
+      : os.platform() === "darwin"
+      ? "macOS"
+      : os.platform() === "linux"
+      ? "Linux"
+      : "Unknown"
+  }
 
 Available display blocks:
   Basic: user, hostname, uptime, shell, os, kernel, device
@@ -482,17 +385,17 @@ async function main(): Promise<void> {
     return;
   }
 
-  if (args.includes('--help') || args.includes('-h')) {
+  if (args.includes("--help") || args.includes("-h")) {
     await showHelp();
     return;
   }
 
-  if (args.includes('--install')) {
+  if (args.includes("--install")) {
     installShellGreeting();
     return;
   }
 
-  if (args.includes('--json')) {
+  if (args.includes("--json")) {
     const info = await getSystemInfo();
     console.log(JSON.stringify(info, null, 2));
     return;
@@ -509,7 +412,7 @@ async function main(): Promise<void> {
 }
 
 main().catch((error) => {
-  console.error('Error:', error.message);
+  console.error("Error:", error.message);
   process.exit(1);
 });
 

package/src/cache/cache-config.ts

@@ -0,0 +1,68 @@
+/**
+ * Cache configuration and constants
+ * @module cache-config
+ */
+
+import os from "os";
+import path from "path";
+
+/**
+ * Cache file location in system's temporary directory
+ * @constant
+ */
+export const CACHE_FILE = path.join(os.tmpdir(), "systeminfo-cache.json");
+
+/**
+ * Cache duration configuration for different system information types
+ * Values are in milliseconds
+ *
+ * @constant
+ * @property {number} ip - IP information cache (5 minutes)
+ * @property {number} cpu - CPU information cache (24 hours)
+ * @property {number} gpu - GPU information cache (24 hours)
+ * @property {number} os - OS information cache (24 hours)
+ * @property {number} device - Device information cache (24 hours)
+ * @property {number} kernel - Kernel information cache (1 hour)
+ * @property {number} pacman - Package managers cache (10 minutes)
+ * @property {number} ports - Open ports cache (5 minutes)
+ * @property {number} containers - Docker containers cache (5 minutes)
+ * @property {number} top_process - Top process cache (5 seconds)
+ * @property {number} disk_used - Disk usage cache (1 minute)
+ * @property {number} ram_used - RAM usage cache (10 seconds)
+ * @property {number} services_running - Services cache (5 minutes)
+ * @property {number} temperature - Temperature cache (30 seconds)
+ * @property {number} battery - Battery status cache (1 minute)
+ * @property {number} network_interfaces - Network interfaces cache (5 minutes)
+ * @property {number} mount_points - Mount points cache (10 minutes)
+ */
+export const CACHE_DURATION = {
+  ip: 5 * 60 * 1000,
+  cpu: 24 * 60 * 60 * 1000,
+  gpu: 24 * 60 * 60 * 1000,
+  os: 24 * 60 * 60 * 1000,
+  device: 24 * 60 * 60 * 1000,
+  kernel: 60 * 60 * 1000,
+  pacman: 10 * 60 * 1000,
+  ports: 5 * 60 * 1000,
+  containers: 5 * 60 * 1000,
+  top_process: 5 * 1000,
+  disk_used: 60 * 1000,
+  ram_used: 10 * 1000,
+  services_running: 5 * 60 * 1000,
+  temperature: 30 * 1000,
+  battery: 60 * 1000,
+  network_interfaces: 5 * 60 * 1000,
+  mount_points: 10 * 60 * 1000,
+};
+
+/**
+ * Default IPInfo.io API token for geolocation
+ * @constant
+ */
+export const DEFAULT_IPINFO_TOKEN = "da2d6cc4baa5d1";
+
+/**
+ * Default network request timeout in milliseconds
+ * @constant
+ */
+export const DEFAULT_NETWORK_TIMEOUT = 5000;