Shifty - Multi-Language REPL for Neovim

A powerful multi-language REPL (Read-Eval-Print Loop) plugin for Neovim that allows you to execute code blocks in various programming languages directly from your editor.

📖 Table of Contents

• Current Language Support
• How It Works
• Features
• Requirements
• Quick Start
• Installation
• Usage
  • Commands
  • Keymaps
  • Code Block Detection
• Configuration
• Supported Languages
• Troubleshooting
• Contributing
• License

Current Language Support:

How It Works

---

Features

• 🚀 Multi-language support: Execute code in Python, JavaScript, Lua, Rust, Java, C, and more
• 📊 Real-time output: View execution results in a floating window
• 🔄 History tracking: Keep track of all executed code and results
• ⚡ Fast execution: Optimized for quick code testing and experimentation
• 🛡️ Safe execution: Built-in safety measures for secure code execution

Requirements

• Neovim 0.7.0 or higher
• Various language runtimes (Python, Node.js, etc.) depending on your needs

Quick Start

1. Install the plugin using your preferred package manager (see Installation Guide)
2. Configure Shifty in your Neovim config
3. Open a file with code blocks (like test_installation.md)
4. Use :ShiftyToggle or your configured keymap to open the REPL window
5. Place your cursor in a code block and use :ShiftyRun to execute it

Installation

For detailed installation instructions, see the Installation Guide.

Quick Installation Examples

Lazy.nvim:

{
  "TuringProblem/shifty-vim",
  config = function()
    require("shifty").setup({
      keymaps = {
        toggle = "<leader>st",
        run = "<leader>sr",
        clear = "<leader>sc",
      }
    })
  end,
}

vim-plug:

Plug 'TuringProblem/shifty-vim'

Packer:

use {
  'TuringProblem/shifty-vim',
  config = function()
    require("shifty").setup({
      keymaps = {
        toggle = "<leader>st",
        run = "<leader>sr",
        clear = "<leader>sc",
      }
    })
  end
}

Quick Start

1. Install the plugin using your preferred package manager
2. Add the setup configuration to your Neovim config
3. Open a file with code blocks (like a markdown file)
4. Use :ShiftyToggle or your configured keymap to open the REPL window
5. Place your cursor in a code block and use :ShiftyRun to execute it

Usage

Commands

• :Shifty or :ShiftyToggle - Toggle the Shifty window
• :ShiftyRun - Run the code block at cursor position
• :ShiftyClear - Clear the output window
• :ShiftyClose - Close the Shifty window
• :ShiftyInfo - Show system information and available languages

Keymaps

The plugin will automatically set up keymaps if configured:

• <leader>st - Toggle Shifty window
• <leader>sr - Run current code block
• <leader>sc - Clear output

Code Block Detection

Shifty automatically detects code blocks in various formats:

Markdown code blocks:

```python
print("Hello, World!")
```

Fenced code blocks:

```javascript
console.log("Hello from JavaScript!");
```

Language-specific files: Just place your cursor anywhere in a Python, JavaScript, Lua, etc. file and run the command.

Configuration

Default Configuration

require("shifty").setup({
  keymaps = {
    toggle = "<leader>st",
    run = "<leader>sr",
    clear = "<leader>sc",
    close = "<leader>sx",
  },
  languages = {
    -- Language-specific configurations
    python = {
      command = "python3",
      args = {"-u"},
      timeout = 5000,
    },
    javascript = {
      command = "node",
      args = {},
      timeout = 3000,
    },
    lua = {
      command = "lua",
      args = {},
      timeout = 2000,
    },
    java = {
      command = "javac",
      args = {"-d", "/tmp"},
      run_command = "java",
      run_args = {"-cp", "/tmp"},
      timeout = 10000,
    },
    rust = {
      command = "rustc",
      args = {"-o", "/tmp/rust_out", "-"},
      run_command = "/tmp/rust_out",
      timeout = 10000,
    },
  },
  execution = {
    timeout = 5000,
    capture_print = true,
    safe_mode = true,
  },
  ui = {
    window_width = 80,
    window_height = 20,
    border = "rounded",
  }
})

Supported Languages

• Python (python, py)
• JavaScript (javascript, js, node)
• Lua (lua)
• Rust (rust, rs)
• Java (java, javac)
• C (c, cc, cpp)
• Shell (bash, sh, zsh)

Troubleshooting

Language not found

If a language isn't working, check:

1. The language runtime is installed and in your PATH
2. The language configuration is correct
3. Run :ShiftyInfo to see available languages

Execution timeout

If code execution times out:

1. Increase the timeout in the language configuration
2. Check if the code has infinite loops
3. Verify the language runtime is working

Permission errors

For compiled languages, ensure:

1. Write permissions in the temporary directory
2. The compiler is properly installed
3. The output directory is writable

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.