ftreeview 0.1.1

package/src/lib/icons.js

@@ -0,0 +1,658 @@
+/**
+ * Icon and color mapping for ftree file explorer
+ *
+ * Provides emoji icons and chalk styles based on file types,
+ * extensions, and attributes (executable, hidden, symlink).
+ */
+
+import chalk from 'chalk';
+
+/**
+ * ASCII fallback icons for --no-icons mode
+ */
+const ASCII_ICONS = {
+  /** Collapsed directory indicator */
+  COLLAPSED_DIR: '▸',
+  /** Expanded directory indicator */
+  EXPANDED_DIR: '▾',
+  /** File indicator */
+  FILE: '·',
+  /** Error indicator */
+  ERROR: '⛔',
+  /** Symlink indicator */
+  SYMLINK: '↗',
+  /** Socket indicator */
+  SOCKET: 's',
+  /** FIFO indicator */
+  FIFO: 'p',
+  /** Block device indicator */
+  BLOCK_DEVICE: 'b',
+};
+
+/**
+ * Nerd Font icon set (requires a Nerd Font in the terminal).
+ * We keep this intentionally small; unknown types fall back to a generic file icon.
+ */
+const NERD_ICONS = {
+  /** Collapsed directory */
+  COLLAPSED_DIR: '',
+  /** Expanded directory */
+  EXPANDED_DIR: '',
+  /** File */
+  FILE: '',
+  /** Error */
+  ERROR: '',
+  /** Symlink */
+  SYMLINK: '',
+  /** Socket */
+  SOCKET: '',
+  /** FIFO */
+  FIFO: '󰆯',
+  /** Block device */
+  BLOCK_DEVICE: '',
+};
+
+const NERD_EXTENSION_ICONS = {
+  // JS/TS
+  'js': '',
+  'mjs': '',
+  'cjs': '',
+  'ts': '',
+  'tsx': '',
+  'jsx': '',
+
+  // Web
+  'html': '',
+  'css': '',
+  'scss': '',
+  'sass': '',
+
+  // Data/config
+  'json': '',
+  'yml': '',
+  'yaml': '',
+
+  // Docs
+  'md': '',
+
+  // Languages
+  'py': '',
+  'go': '',
+  'rs': '',
+};
+
+const NERD_SPECIAL_FILE_ICONS = {
+  'package.json': '',
+  'package-lock.json': '',
+  'README.md': '',
+  'LICENSE': '',
+  '.gitignore': '',
+};
+
+/**
+ * Extension to icon mapping
+ * Maps file extensions to their representative emoji icons
+ */
+const EXTENSION_ICONS = {
+  // JavaScript/Node files
+  'js': '📜',
+  'mjs': '📜',
+  'cjs': '📜',
+
+  // TypeScript files
+  'ts': '🔷',
+  'tsx': '🔷',
+
+  // React JSX
+  'jsx': '⚛️',
+
+  // Python
+  'py': '🐍',
+  'pyi': '🐍',
+
+  // Go
+  'go': '🐹',
+
+  // Rust
+  'rs': '🦀',
+
+  // Documentation
+  'md': '📝',
+  'markdown': '📝',
+  'rst': '📝',
+
+  // Configuration files
+  'json': '🔧',
+  'yaml': '⚙️',
+  'yml': '⚙️',
+  'toml': '⚙️',
+  'ini': '⚙️',
+  'conf': '⚙️',
+
+  // Web files
+  'html': '🌐',
+  'htm': '🌐',
+  'css': '🎨',
+  'scss': '🎨',
+  'sass': '🎨',
+  'less': '🎨',
+
+  // Shell scripts
+  'sh': '🐚',
+  'bash': '🐚',
+  'zsh': '🐚',
+  'fish': '🐚',
+
+  // Lock files
+  'lock': '🔒',
+  'lockfile': '🔒',
+
+  // Environment files
+  'env': '🔑',
+
+  // Text and data
+  'txt': '📄',
+  'csv': '📄',
+  'tsv': '📄',
+
+  // Database files
+  'sql': '🗃️',
+  'db': '🗃️',
+  'sqlite': '🗃️',
+  'sqlite3': '🗃️',
+
+  // Audio files
+  'mp3': '🎵',
+  'wav': '🎵',
+  'flac': '🎵',
+  'ogg': '🎵',
+  'm4a': '🎵',
+
+  // Video files
+  'mp4': '🎬',
+  'mov': '🎬',
+  'avi': '🎬',
+  'mkv': '🎬',
+  'webm': '🎬',
+
+  // Image files
+  'png': '🖼️',
+  'jpg': '🖼️',
+  'jpeg': '🖼️',
+  'gif': '🖼️',
+  'svg': '🖼️',
+  'webp': '🖼️',
+  'ico': '🖼️',
+
+  // Documents
+  'pdf': '📕',
+
+  // Archives
+  'zip': '📦',
+  'tar': '📦',
+  'gz': '📦',
+  'bz2': '📦',
+  'xz': '📦',
+  '7z': '📦',
+  'rar': '📦',
+};
+
+/**
+ * Special filename to icon mapping
+ * Used for files without standard extensions (e.g., Dockerfile, .gitignore)
+ */
+const SPECIAL_FILE_ICONS = {
+  'Dockerfile': '🐳',
+  'dockerignore': '🐳',
+  'Makefile': '🛠️',
+  'docker-compose.yml': '🐳',
+  'docker-compose.yaml': '🐳',
+  '.gitignore': '📋',
+  '.gitattributes': '📋',
+  '.gitmodules': '📋',
+  '.env': '🔑',
+  '.env.example': '🔑',
+  '.env.local': '🔑',
+  '.env.production': '🔑',
+  '.env.development': '🔑',
+  '.nvmrc': '🔢',
+  '.npmrc': '📦',
+  '.editorconfig': '⚙️',
+  '.prettierrc': '✨',
+  '.prettierrc.json': '✨',
+  '.prettierrc.yml': '✨',
+  '.prettierrc.yaml': '✨',
+  '.eslintrc': '📏',
+  '.eslintrc.json': '📏',
+  '.eslintrc.yml': '📏',
+  '.eslintrc.yaml': '📏',
+  '.eslintrc.js': '📏',
+  'package-lock.json': '🔒',
+  'yarn.lock': '🔒',
+  'pnpm-lock.yaml': '🔒',
+  'package.json': '📦',
+  'tsconfig.json': '🔷',
+  'tslint.json': '📏',
+  'webpack.config.js': '📦',
+  'vite.config.js': '⚡',
+  'next.config.js': '▲',
+  'nuxt.config.js': '🟢',
+  'tailwind.config.js': '🎨',
+  '.babelrc': '📜',
+  '.babelrc.json': '📜',
+  '.browserslistrc': '🌐',
+  'LICENSE': '⚖️',
+  'LICENSE-MIT': '⚖️',
+  'LICENSE-APACHE': '⚖️',
+  'README': '📖',
+  'README.md': '📖',
+  'README.txt': '📖',
+  'CONTRIBUTING': '🤝',
+  'CHANGELOG': '📜',
+  'AUTHORS': '👥',
+};
+
+/**
+ * Icon colors mapping
+ * Maps file types/extensions to their chalk color styles
+ */
+const ICON_COLORS = {
+  // JavaScript
+  'js': chalk.yellow,
+  'mjs': chalk.yellow,
+  'cjs': chalk.yellow,
+
+  // TypeScript
+  'ts': chalk.blue,
+  'tsx': chalk.blue,
+
+  // React
+  'jsx': chalk.cyan,
+
+  // Python
+  'py': chalk.green,
+  'pyi': chalk.green,
+
+  // Go
+  'go': chalk.cyan,
+
+  // Rust
+  'rs': chalk.red,
+
+  // Documentation
+  'md': chalk.white,
+  'markdown': chalk.white,
+  'rst': chalk.white,
+
+  // Configuration
+  'json': chalk.yellow.dim,
+  'yaml': chalk.magenta,
+  'yml': chalk.magenta,
+  'toml': chalk.magenta,
+
+  // Web
+  'html': chalk.hex('#e44d26'), // Orange
+  'css': chalk.magenta,
+  'scss': chalk.magenta,
+  'sass': chalk.magenta,
+  'less': chalk.magenta,
+
+  // Shell
+  'sh': chalk.green,
+  'bash': chalk.green,
+  'zsh': chalk.green,
+
+  // Docker
+  'Dockerfile': chalk.blue,
+  'dockerignore': chalk.blue,
+
+  // Lock files
+  'lock': chalk.dim.gray,
+  'lockfile': chalk.dim.gray,
+  'package-lock.json': chalk.dim.gray,
+  'yarn.lock': chalk.dim.gray,
+  'pnpm-lock.yaml': chalk.dim.gray,
+
+  // Environment
+  'env': chalk.yellow,
+  '.env': chalk.yellow,
+
+  // Git
+  'gitignore': chalk.dim,
+  'gitattributes': chalk.dim,
+
+  // Text/data
+  'txt': chalk.white,
+  'csv': chalk.white,
+
+  // Database
+  'sql': chalk.blue,
+  'db': chalk.blue,
+  'sqlite': chalk.blue,
+
+  // Audio
+  'mp3': chalk.magenta,
+  'wav': chalk.magenta,
+  'flac': chalk.magenta,
+
+  // Video
+  'mp4': chalk.red,
+  'mov': chalk.red,
+  'avi': chalk.red,
+
+  // Images
+  'png': chalk.green,
+  'jpg': chalk.green,
+  'jpeg': chalk.green,
+  'svg': chalk.green,
+
+  // Documents
+  'pdf': chalk.red,
+
+  // Archives
+  'zip': chalk.yellow,
+  'tar': chalk.yellow,
+  'gz': chalk.yellow,
+};
+
+/**
+ * Get the icon for a file or directory
+ *
+ * @param {string} name - The filename or directory name
+ * @param {boolean} isDir - Whether this is a directory
+ * @param {boolean} expanded - Whether the directory is expanded (only applies when isDir=true)
+ * @param {boolean} isSymlink - Whether this is a symbolic link
+ * @param {boolean} hasError - Whether this node has an error
+ * @param {string|null} fileType - Special file type: 'socket', 'fifo', 'blockDevice', 'charDevice'
+ * @param {Object} options - Options object
+ * @param {boolean} options.noIcons - If true, use ASCII fallback icons
+ * @returns {string} The icon character (emoji or ASCII)
+ */
+export function getIcon(name, isDir = false, expanded = false, isSymlink = false, hasError = false, fileType = null, options = {}) {
+  const { noIcons = false, iconSet } = options;
+  const resolvedSet = (iconSet || '').toLowerCase() || (noIcons ? 'ascii' : 'emoji');
+
+  // Handle ASCII mode
+  if (resolvedSet === 'ascii') {
+    if (hasError) {
+      return ASCII_ICONS.ERROR;
+    }
+    if (isSymlink) {
+      return ASCII_ICONS.SYMLINK;
+    }
+    if (fileType === 'socket') {
+      return ASCII_ICONS.SOCKET;
+    }
+    if (fileType === 'fifo') {
+      return ASCII_ICONS.FIFO;
+    }
+    if (fileType === 'blockDevice') {
+      return ASCII_ICONS.BLOCK_DEVICE;
+    }
+    if (isDir) {
+      return expanded ? ASCII_ICONS.EXPANDED_DIR : ASCII_ICONS.COLLAPSED_DIR;
+    }
+    return ASCII_ICONS.FILE;
+  }
+
+  // Handle Nerd Font mode
+  if (resolvedSet === 'nerd') {
+    if (hasError) {
+      return NERD_ICONS.ERROR;
+    }
+    if (isSymlink) {
+      return NERD_ICONS.SYMLINK;
+    }
+    if (fileType === 'socket') {
+      return NERD_ICONS.SOCKET;
+    }
+    if (fileType === 'fifo') {
+      return NERD_ICONS.FIFO;
+    }
+    if (fileType === 'blockDevice') {
+      return NERD_ICONS.BLOCK_DEVICE;
+    }
+    if (isDir) {
+      return expanded ? NERD_ICONS.EXPANDED_DIR : NERD_ICONS.COLLAPSED_DIR;
+    }
+
+    if (NERD_SPECIAL_FILE_ICONS.hasOwnProperty(name)) {
+      return NERD_SPECIAL_FILE_ICONS[name];
+    }
+
+    const ext = getExtension(name);
+    if (ext && NERD_EXTENSION_ICONS.hasOwnProperty(ext)) {
+      return NERD_EXTENSION_ICONS[ext];
+    }
+
+    return NERD_ICONS.FILE;
+  }
+
+  // Handle errors first (highest priority)
+  if (hasError) {
+    return '⛔';
+  }
+
+  // Handle special file types
+  if (fileType === 'socket') {
+    return '🔌';
+  }
+  if (fileType === 'fifo') {
+    return '🔀';
+  }
+  if (fileType === 'blockDevice') {
+    return '💾';
+  }
+  if (fileType === 'charDevice') {
+    return '📟';
+  }
+
+  // Handle symlinks (they take precedence over regular files/dirs)
+  if (isSymlink) {
+    return '🔗';
+  }
+
+  // Handle directories
+  if (isDir) {
+    return expanded ? '📂' : '📁';
+  }
+
+  // Check special files first (full filename match)
+  if (SPECIAL_FILE_ICONS.hasOwnProperty(name)) {
+    return SPECIAL_FILE_ICONS[name];
+  }
+
+  // Extract extension
+  const ext = getExtension(name);
+
+  // Check extension mapping
+  if (ext && EXTENSION_ICONS.hasOwnProperty(ext)) {
+    return EXTENSION_ICONS[ext];
+  }
+
+  // Check for special files with extension (e.g., .gitignore, Dockerfile)
+  const baseName = name.toLowerCase();
+  for (const [specialFile, icon] of Object.entries(SPECIAL_FILE_ICONS)) {
+    if (baseName === specialFile.toLowerCase() || baseName.endsWith(`/${specialFile.toLowerCase()}`)) {
+      return icon;
+    }
+  }
+
+  // Default file icon
+  return '📄';
+}
+
+/**
+ * Get the chalk style for a file or directory
+ *
+ * @param {string} name - The filename or directory name
+ * @param {number|null} mode - The file mode from fs.stats (for detecting executables)
+ * @param {boolean} isDir - Whether this is a directory
+ * @param {boolean} isSymlink - Whether this is a symbolic link
+ * @param {boolean} hasError - Whether this node has an error
+ * @param {string|null} fileType - Special file type: 'socket', 'fifo', 'blockDevice', 'charDevice'
+ * @returns {Function} A chalk style function
+ */
+export function getStyle(name, mode = null, isDir = false, isSymlink = false, hasError = false, fileType = null) {
+  // Errors get red styling
+  if (hasError) {
+    return chalk.red;
+  }
+
+  // Symlinks get special styling
+  if (isSymlink) {
+    return chalk.magenta.italic;
+  }
+
+  // Special file types
+  if (fileType === 'socket') {
+    return chalk.cyan.dim;
+  }
+  if (fileType === 'fifo') {
+    return chalk.yellow.dim;
+  }
+  if (fileType === 'blockDevice' || fileType === 'charDevice') {
+    return chalk.gray.dim;
+  }
+
+  // Directories get blue bold
+  if (isDir) {
+    return chalk.blue.bold;
+  }
+
+  // Executable files get green
+  if (mode !== null && (mode & 0o111) !== 0) {
+    return chalk.green;
+  }
+
+  // Hidden files get gray dim
+  if (name.startsWith('.')) {
+    return chalk.gray.dim;
+  }
+
+  // Check special files first
+  if (SPECIAL_FILE_ICONS.hasOwnProperty(name)) {
+    const baseName = name;
+    if (ICON_COLORS.hasOwnProperty(baseName)) {
+      return ICON_COLORS[baseName];
+    }
+    // Default for known special files without explicit color
+    for (const key of Object.keys(SPECIAL_FILE_ICONS)) {
+      if (name.toLowerCase() === key.toLowerCase()) {
+        if (ICON_COLORS.hasOwnProperty(key)) {
+          return ICON_COLORS[key];
+        }
+      }
+    }
+  }
+
+  // Check extension-based colors
+  const ext = getExtension(name);
+  if (ext && ICON_COLORS.hasOwnProperty(ext)) {
+    return ICON_COLORS[ext];
+  }
+
+  // Default style (white)
+  return chalk.white;
+}
+
+/**
+ * Extract the file extension from a filename
+ *
+ * @param {string} name - The filename
+ * @returns {string|null} The extension without the dot, or null if no extension
+ */
+function getExtension(name) {
+  const lastDotIndex = name.lastIndexOf('.');
+
+  // No dot found, or dot is at the start (hidden file) or end (no extension)
+  if (lastDotIndex <= 0 || lastDotIndex === name.length - 1) {
+    return null;
+  }
+
+  return name.slice(lastDotIndex + 1).toLowerCase();
+}
+
+/**
+ * Detect special file types from file mode
+ *
+ * @param {number|null} mode - The file mode from fs.stats
+ * @returns {string|null} The file type: 'socket', 'fifo', 'blockDevice', 'charDevice', or null
+ */
+export function detectFileType(mode = null) {
+  if (mode === null) {
+    return null;
+  }
+
+  // File type is stored in the upper 4 bits of the mode (0o170000 mask)
+  const fileType = mode & 0o170000;
+
+  switch (fileType) {
+    case 0o140000: // Socket
+      return 'socket';
+    case 0o010000: // FIFO (named pipe)
+      return 'fifo';
+    case 0o060000: // Block device
+      return 'blockDevice';
+    case 0o020000: // Character device
+      return 'charDevice';
+    case 0o120000: // Symlink
+      return 'symlink';
+    default:
+      return null;
+  }
+}
+
+/**
+ * Apply color and icon to a filename for display
+ *
+ * @param {string} name - The filename or directory name
+ * @param {Object} options - Display options
+ * @param {boolean} options.isDir - Whether this is a directory
+ * @param {boolean} options.expanded - Whether the directory is expanded
+ * @param {boolean} options.isSymlink - Whether this is a symbolic link
+ * @param {boolean} options.hasError - Whether this node has an error
+ * @param {number|null} options.mode - The file mode (for executables and special file types)
+ * @param {boolean} options.noIcons - If true, don't show emoji icons
+ * @returns {string} The formatted name with icon and color
+ */
+export function formatName(name, options = {}) {
+  const {
+    isDir = false,
+    expanded = false,
+    isSymlink = false,
+    hasError = false,
+    mode = null,
+    noIcons = false,
+  } = options;
+
+  // Detect special file types from mode
+  const fileType = detectFileType(mode);
+
+  // Don't double-detect symlinks (they may already be detected)
+  const finalFileType = fileType === 'symlink' ? null : fileType;
+
+  const icon = getIcon(name, isDir, expanded, isSymlink, hasError, finalFileType, { noIcons });
+  const style = getStyle(name, mode, isDir, isSymlink, hasError, finalFileType);
+  const styledName = style(name);
+
+  return `${icon} ${styledName}`;
+}
+
+/**
+ * Get all supported file extensions
+ *
+ * @returns {string[]} Array of supported extensions
+ */
+export function getSupportedExtensions() {
+  return Object.keys(EXTENSION_ICONS);
+}
+
+/**
+ * Get all special filenames
+ *
+ * @returns {string[]} Array of special filenames with custom icons
+ */
+export function getSpecialFiles() {
+  return Object.keys(SPECIAL_FILE_ICONS);
+}