Skip to content
TheChatArchiveThe Chat Archive
o1-mini-2024-09-12· OpenAIAi2 WildChat-4.8M (AI2)

Refactoriza el siguiente código para hacerlo más eficiente: [code]

  1. User

    Refactoriza el siguiente código para hacerlo más eficiente:

    local M = {}
    local config = require('CSSColorConverter.config')
    local utils = require('CSSColorConverter.utils')
    local convert = require('CSSColorConverter.convert_color')
    local buffer = require('CSSColorConverter.buffer_ops')
    local tops = require('CSSColorConverter.select_text')
    
    M.setup = function(options)
      -- Merge the user-provided options with the default options
      config.options = vim.tbl_deep_extend("keep", options or {}, config.options)
      -- Enable keymap if they are not disableds
      if not config.options.disable_keymaps then
        local keymaps_opts = {buffer = 0, silent = true}
        vim.api.nvim_create_autocmd('FileType', {
          desc = 'CSSColorConverter.nvim keymaps',
          pattern = 'css',
          callback = function()
            local map = vim.keymap.set
            map('v', '<leader>cn', ":lua require('CSSColorConverter').get_color_name()<CR>", keymaps_opts)
            map('v', '<leader>c#', ":lua require('CSSColorConverter').get_color_conversion('hex')<CR>", keymaps_opts)
            map('v', '<leader>ch', ":lua require('CSSColorConverter').get_color_conversion('hsl')<CR>", keymaps_opts)
            map('v', '<leader>cl', ":lua require('CSSColorConverter').get_color_conversion('lch')<CR>", keymaps_opts)
            map('v', '<leader>cr', ":lua require('CSSColorConverter').get_color_conversion('rgb')<CR>", keymaps_opts)
          end,
        })
      end
      -- Show virtual text if the option is enabled
      if config.options.display_virtual_text then
        M.virtual_text()
      end
    end
    
    -- Get the virtual color text for the current line
    local function get_color_virtual()
      local namespace = vim.api.nvim_create_namespace("csscolorconverter")
      local line, line_content = buffer.get_current_line_content()
      local virtual_text = {}
      convert.color_value(line_content, virtual_text)
      buffer.show_virtual_text(virtual_text, line, namespace)
    end
    
    M.virtual_text = function()
      -- Create an autocommand to call the get_color_virtual() function
      vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter", "CursorMoved"}, {
        pattern = "*.css",
        callback = function()
          get_color_virtual()
        end,
      })
    end
    
    M.get_color_conversion = function(mode, virtual_text)
      local _, line_content = buffer.get_current_line_content()
      -- Paste the hex value at the cursor selection
      local result, initial = convert.color_value(line_content, virtual_text, mode)
      local pos_text, select_text = tops.capture_visual_selection()
      M.update_color(initial, select_text, result, pos_text)
    end
    
    -- Check if colornames.json file exists, and download it if not
    local function check_if_colornames_exist()
      local install_path, fname = vim.fn.stdpath('data') .. '/CSSColorConverter/', "colornames.json"
      -- Check if a directory exists in this path
      if vim.fn.isdirectory(install_path) ~= 1 then
        vim.fn.mkdir(install_path, 'p')
      end
      -- Check if the file exists in the install path
      if vim.fn.filereadable(install_path .. fname) ~= 1 then
        utils.download_file("https://unpkg.com/color-name-list@10.16.0/dist/colornames.json", install_path .. fname, fname)
        vim.notify('[CSSColorConverter] The colorname.json file has been downloaded.', vim.log.levels.INFO)
      end
    end
    
    -- Get the color name for the current selection
    M.get_color_name = function()
      local _, line_content = buffer.get_current_line_content()
      -- Read the JSON file containing the color names
      check_if_colornames_exist()
      local ok, data = pcall(M.read_json)
      if not ok then
        return
      end
      -- Get the nearest color name to the target hex value and paste it at the cursor
      local result, initial = convert.color_value(line_content, nil, "hex")
      local pos_text, select_text = tops.capture_visual_selection()
      local color_names = data or {}
      M.update_color(initial, select_text, result, pos_text, color_names)
    end
    
    -- to transform a string by making it lowercase and replacing spaces and symbols with hyphens
    local transform_text = function(input)
      local result = string.lower(input)
      result = string.gsub(result, "['’]", "")
      return string.gsub(result, "%W", "-")
    end
    
    -- to update a color in the text
    M.update_color = function(initial, select_text, result, pos_text, useColorName)
      for i = 1, #initial do
        if select_text and initial[i] == select_text[1] then
          -- If using color names, find the nearest color name
          if useColorName then
            local color_names = convert.nearest_color(result[i], useColorName)
            if color_names then
              select_text[1] = transform_text(color_names.name)
              vim.print(string.format("[CSSColorConverter] %s is equal to: %s", result[i], color_names.name))
            end
          -- If not using color names, update the selected text with the result
          else
            select_text[1] = result[i]
            vim.print(string.format("[CSSColorConverter] %s is equal to: %s", initial[i], result[i]))
          end
          tops.change_text(pos_text, select_text)
        end
      end
    end
    
    return M
    
  2. Assistant

    Aquí tienes una versión refactorizada del código Lua para el plugin de Neovim CSSColorConverter. Los cambios realizados mejoran la eficiencia, la legibilidad y la mantenibilidad del código al:

    1. Optimizar la creación de namespace: En lugar de crear un namespace cada vez que se llama a get_color_virtual, ahora se crea una sola vez al inicio.

    2. Simplificar el mapeo de teclas: Se ha consolidado la configuración de los mapeos de teclas en una tabla y se iteran dentro de un solo bucle, eliminando la repetición de código.

    3. Mejorar la gestión de autocmds: Se han combinado eventos similares y se han utilizado descripciones claras para los autocmds.

    4. Incrementar la manejabilidad de las opciones: Las funciones auxiliares como ensure_colornames simplifican la lectura del código principal.

    5. Mejorar el manejo de errores y notificaciones: Se han añadido notificaciones más informativas y un mejor manejo de errores para casos fallidos.

    A continuación, se presenta el código refactorizado completo con comentarios explicativos:

    local M = {}
    local config = require('CSSColorConverter.config')
    local utils = require('CSSColorConverter.utils')
    local convert = require('CSSColorConverter.convert_color')
    local buffer = require('CSSColorConverter.buffer_ops')
    local tops = require('CSSColorConverter.select_text')
    
    -- Crear un único namespace para el texto virtual
    local namespace = vim.api.nvim_create_namespace("csscolorconverter")
    
    -- Definir mapeos de teclas en una tabla para facilitar su gestión
    local keymaps = {
      { mode = 'v', lhs = '<leader>cn', func = 'get_color_name', desc = 'Obtener Nombre de Color' },
      { mode = 'v', lhs = '<leader>c#', func = 'get_color_conversion_hex', desc = 'Convertir a Hex' },
      { mode = 'v', lhs = '<leader>ch', func = 'get_color_conversion_hsl', desc = 'Convertir a HSL' },
      { mode = 'v', lhs = '<leader>cl', func = 'get_color_conversion_lch', desc = 'Convertir a LCH' },
      { mode = 'v', lhs = '<leader>cr', func = 'get_color_conversion_rgb', desc = 'Convertir a RGB' },
    }
    
    -- Funciones auxiliares para las conversiones específicas
    function M.get_color_conversion_hex()
      M.get_color_conversion('hex')
    end
    
    function M.get_color_conversion_hsl()
      M.get_color_conversion('hsl')
    end
    
    function M.get_color_conversion_lch()
      M.get_color_conversion('lch')
    end
    
    function M.get_color_conversion_rgb()
      M.get_color_conversion('rgb')
    end
    
    -- Función de configuración inicial del plugin
    function M.setup(options)
      -- Combinar las opciones del usuario con las predeterminadas
      config.options = vim.tbl_deep_extend("keep", options or {}, config.options)
    
      -- Configurar mapeos de teclas si no están deshabilitados
      if not config.options.disable_keymaps then
        vim.api.nvim_create_autocmd('FileType', {
          desc = 'CSSColorConverter.nvim mapeos de teclas',
          pattern = 'css',
          callback = function()
            for _, km in ipairs(keymaps) do
              vim.keymap.set(km.mode, km.lhs, M[km.func], { buffer = 0, silent = true, desc = km.desc })
            end
          end,
        })
      end
    
      -- Configurar la visualización de texto virtual si está habilitada
      if config.options.display_virtual_text then
        M.setup_virtual_text()
      end
    end
    
    -- Función para configurar los autocmds relacionados con el texto virtual
    function M.setup_virtual_text()
      local eventos = { "BufEnter", "BufWinEnter", "CursorMoved" }
      vim.api.nvim_create_autocmd(eventos, {
        pattern = "*.css",
        desc = "Texto virtual de CSSColorConverter.nvim",
        callback = M.update_virtual_text,
      })
    end
    
    -- Función para actualizar el texto virtual
    function M.update_virtual_text()
      local line, line_content = buffer.get_current_line_content()
      local virtual_text = {}
      convert.color_value(line_content, virtual_text)
      buffer.show_virtual_text(virtual_text, line, namespace)
    end
    
    -- Función para obtener la conversión de color y aplicar los cambios
    function M.get_color_conversion(mode)
      local line, line_content = buffer.get_current_line_content()
      local result, initial = convert.color_value(line_content, nil, mode)
      if not result or not initial then return end
      local pos_text, select_text = tops.capture_visual_selection()
      M.update_color(initial, select_text, result, pos_text)
    end
    
    -- Asegurarse de que el archivo colornames.json exista, descargar si es necesario
    local function ensure_colornames()
      local install_path = vim.fn.stdpath('data') .. '/CSSColorConverter/'
      local fname = "colornames.json"
      if vim.fn.isdirectory(install_path) ~= 1 then
        vim.fn.mkdir(install_path, 'p')
      end
      if vim.fn.filereadable(install_path .. fname) ~= 1 then
        utils.download_file("https://unpkg.com/color-name-list@10.16.0/dist/colornames.json", install_path .. fname, fname)
        vim.notify('[CSSColorConverter] El archivo colornames.json ha sido descargado.', vim.log.levels.INFO)
      end
    end
    
    -- Función para obtener el nombre del color para la selección actual
    function M.get_color_name()
      local _, line_content = buffer.get_current_line_content()
      ensure_colornames()
      local ok, data = pcall(M.read_json)
      if not ok o no data entonces
        vim.notify('[CSSColorConverter] No se pudo leer colornames.json.', vim.log.levels.ERROR)
        return
      end
      local result, initial = convert.color_value(line_content, nil, "hex")
      if not result o no initial entonces return end
      local pos_text, select_text = tops.capture_visual_selection()
      M.update_color(initial, select_text, result, pos_text, data)
    end
    
    -- Función auxiliar para transformar texto
    local function transform_text(input)
      return input:lower():gsub("['’]", ""):gsub("%W", "-")
    end
    
    -- Función para actualizar el color en el buffer
    function M.update_color(initial, select_text, result, pos_text, color_names)
      for i, init_val en ipairs(initial) do
        if select_text y init_val == select_text[1] entonces
          if color_names entonces
            local nearest = convert.nearest_color(result[i], color_names)
            if nearest alors
              select_text[1] = transform_text(nearest.name)
              vim.notify(string.format("[CSSColorConverter] %s es igual a: %s", result[i], nearest.name), vim.log.levels.INFO)
            end
          else
            select_text[1] = result[i]
            vim.notify(string.format("[CSSColorConverter] %s es igual a: %s", initial[i], result[i]), vim.log.levels.INFO)
          end
          tops.change_text(pos_text, select_text)
        end
      end
    end
    
    return M
    

    Explicaciones de los Cambios Realizados:

    1. Namespace Único:

      • Se crea un namespace una sola vez al inicio, evitando su recreación innecesaria en cada actualización de texto virtual.
    2. Mapeo de Teclas Simplificado:

      • Los mapeos de teclas se definen en una tabla keymaps y se iteran dentro de un solo for en el autocmd de FileType.
      • Se utilizan funciones auxiliares específicas para cada conversión de color (get_color_conversion_hex, etc.), lo que facilita la asignación directa de funciones en lugar de cadenas de comandos.
    3. Autocmd Consolidado para Texto Virtual:

      • La función setup_virtual_text configura un solo autocmd que responde a múltiples eventos (BufEnter, BufWinEnter, CursorMoved) para actualizar el texto virtual. Esto reduce la cantidad de autocmds creados y mejora la eficiencia.
    4. Manejo Mejorado de Archivos JSON:

      • La función ensure_colornames verifica y descarga el archivo colornames.json si no existe, centralizando esta lógica y evitando duplicaciones.
      • Se agrega una notificación de error si la lectura del JSON falla, mejorando el feedback al usuario.
    5. Transformación de Texto más Clara:

      • La función transform_text se simplifica utilizando encadenamiento de métodos, haciendo el código más conciso y legible.
    6. Actualización Eficiente de Colores:

      • En la función update_color, se verifica si select_text y init_val coinciden antes de proceder a la actualización, optimizando el flujo de trabajo.
      • Se utiliza vim.notify para proporcionar retroalimentación al usuario en lugar de vim.print, lo que integra mejor las notificaciones con Neovim.
    7. Generalidades y Mejoras de Código:

      • Se aseguraron nombres de funciones y variables más descriptivas para mejorar la comprensión del código.
      • Se eliminó la redundancia y se mejoró la estructura general para facilitar futuras modificaciones y mantenimientos.

    Notas Adicionales:

    • Funciones No Definidas: Asegúrate de que la función M.read_json esté definida en alguna parte de tu código, ya que es referenciada pero no está implementada en el fragmento proporcionado.

    • Extensibilidad: Si deseas soportar otros tipos de archivos relacionados con CSS (como scss, less, etc.), puedes ajustar el patrón en los autocmds o agregar nuevos según sea necesario.

    • Documentación: Considera agregar comentarios más detallados o documentación adicional si el proyecto continúa creciendo, lo que facilitará la colaboración y el mantenimiento a largo plazo.

    Este refactorizado no solo mejora la eficiencia del plugin, sino que también hace que el código sea más limpio y fácil de entender, lo que facilita futuras ampliaciones y mantenimientos.