nvim-context 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 854123562b94edd4488ded7a4f3614643ce7d850d87d7b9d40f0a4b98ae6a3b2
-  data.tar.gz: b4e831ff07e923e76657f89ac80e5fd81832260d7a677564f1f48210134cafee
+  metadata.gz: 7f3a92b390810e2ca6d9bb8b5ae1cdf8e7857d241030f45d862bd4394dd1b38c
+  data.tar.gz: 3cd54046591babf16e395dda269c277f42bc84b66116cfc41ac0d25751f178a5
 SHA512:
-  metadata.gz: 2f15ad5f0c76d4f62216b66e6e9153e53816288abd33016d9b5dbf6be0e3218a4fef3708a66f2027cc10c6148cd99bc9b84d61e2fb9572e371563adf4417d59d
-  data.tar.gz: e73ce86f7c1aef21dc030b4346483953d63fa240f5c8ff6a199ac32e0e5660764819d14b12a9ef29f4eaf338ae07ed1164f017045520bc9c3faf293b31d126af
+  metadata.gz: 05fb6b21b901b2eb8b3e9fda9e6b301f4be2c160c127d1e88a384787f4ebecf23ceb111f4afc7b55d59d52dd21389a4b47056ccf9c7854bb364b7f8c8f66567b
+  data.tar.gz: 6343f612a126c06c374da6b4d03579bbcf301d23d3636cbc2d6e977ce826a571a6cd85623054a0688e79d3ce6dd5eddc093924d01f3dbb2ed7ebe767b075e24c

data/AGENTS.md

@@ -1,4 +1,13 @@
 # AGENTS.md
+## Project overview
+`nvim-context` is a Ruby gem that bridges running Neovim instances and agentic
+coding tools. It extracts live context from the editor via a Unix socket
+connection and outputs JSON with cursor position, current file, visual
+selection and diagnostics.
+
+**Version**: 1.0.0
+**Ruby**: >= 3.4.0
+**Dependencies**: `neovim` gem (~> 0.10.0)
 
 ## Commands
 - **Test all**: `bundle exec rspec`
@@ -6,13 +15,68 @@
 - **Test integration**: `bundle exec rspec spec/integration/`
 - **Test single file**: `bundle exec rspec path/to/spec.rb`
 - **Lint**: `bundle exec rubocop`
-- **Ruby version**: 3.4.7
+- **Run tool**: `bin/nvim-context`
+- **Build gem**: `gem build nvim-context.gemspec`
+
+## Architecture
+### Entry point
+`bin/nvim-context` - CLI executable that calls `NvimContext::Fetcher.fetch` and
+prints JSON to stdout.
+
+### Core components (`lib/nvim_context/`)
+- `fetcher.rb` - Main entry point class with static `fetch` method. Orchestrates
+  data extraction, handles all error types, and returns JSON responses
+- `connector.rb` - Manages Neovim socket connection using the `neovim` gem.
+  Reads socket path from `NVIM_CONTEXT_SOCKET` env var or defaults to
+  `nvim-context.sock` in current directory
+- `data_extractor.rb` - Static methods to extract cursor position, current file
+  path, visual selection (with text content), and diagnostics from Neovim
+- `errors.rb` - Custom error classes: `ConnectionError` (socket failures) and
+  `ContextError` (Neovim operation failures)
+- `version.rb` - Gem version constant
+
+### Data Flow
+1. User runs `nvim-context` CLI
+2. `Fetcher.fetch` creates a `Connector` instance
+3. `Connector` attaches to Neovim via Unix socket
+4. `DataExtractor` methods query Neovim for context data
+5. JSON output returned to stdout (or error JSON on failure)
 
-## Code Style
-- Target Ruby 3.4, line length max 80 chars
-- Use double quotes for strings, frozen string literals
+### JSON output format
+Success:
+```json
+{
+  "cursor": { "line": 43, "col": 3 },
+  "file": "/path/to/file.rb",
+  "selection": null,
+  "diagnostics": []
+}
+```
+
+Error:
+```json
+{
+  "error": "Connection failed",
+  "details": "Failed to connect to Neovim socket: No such file"
+}
+```
+
+## Code style
+- Ruby 3.4, line length max 80 chars
+- Use double quotes for strings, frozen string literals enabled
 - Classes in `NvimContext` module with descriptive names
 - Private constants at class bottom with `private_constant`
 - Error handling with custom error classes in `errors.rb`
-- Use `attr_reader` for private attributes
-- RSpec with expect syntax, disable monkey patching
+- Use `attr_reader` for private instance variables
+- RSpec with expect syntax, monkey patching disabled
+- Follow Rubocop rules in `.rubocop.yml`
+
+## Testing
+- Unit tests mock the Neovim client
+- Integration tests require a running Neovim instance with socket
+- Test files mirror lib structure: `spec/lib/nvim_context/`
+
+## Integration examples
+The gem is designed for use with agentic coding tools like Claude Code,
+OpenCode, Amp Code, Codex, and Gemini. See README.md for integration examples
+including Claude Code skill configuration and OpenCode custom tool setup.

data/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

data/README.md

@@ -1,6 +1,7 @@
 # `nvim-context`
 ![CI](https://github.com/majjoha/nvim-context/workflows/CI/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/nvim-context.svg)](https://badge.fury.io/rb/nvim-context)
+
 `nvim-context` is a bridge between running Neovim instances and agentic coding
 tools. It extracts context from the editor via a Unix socket connection and
 outputs JSON with the cursor position, current file, visual selection and
@@ -10,6 +11,7 @@ It allows agentic coding tools running outside Neovim to answer questions such
 as:
 - What does this line do?
 - Can you convert the current line to uppercase?
+- What does the method under my cursor do?
 - Are these lines idiomatic Ruby?
 
 ## Motivation
@@ -17,10 +19,10 @@ While the Neovim community provides several plugins for integrating agentic
 coding assistants into the editor (see the [AI section in the Awesome Neovim
 repository](https://github.com/rockerboo/awesome-neovim?tab=readme-ov-file#ai)),
 it seems that few tools offer a way to let any agentic coding tool running
-*outside* Neovim retrieve the state in an agnostic manner.
+*outside* Neovim retrieve the state of the editor in an agnostic manner.
 
-The goal with `nvim-context` is to separate concerns, so OpenCode, Claude Code,
-Codex, Gemini, etc., can query the current state of a Neovim session by calling
+The goal with `nvim-context` is to separate concerns, so Amp Code, Claude Code,
+Codex, etc., can query the current state of a Neovim session by calling
 this tool. See the [Integration with agentic
 tools](#integration-with-agentic-tools) section below for suggestions on how to
 set this up.
@@ -49,10 +51,6 @@ nvim --listen $NVIM_CONTEXT_SOCKET
 If no environment variable is set, the tool defaults to `nvim-context.sock` in
 the current directory.
 
-> [!NOTE]  
-> To avoid cluttering your Git repository, consider adding `nvim-context.sock`
-> to your `.gitignore` file.
-
 ## Usage
 Once Neovim is running, you can retrieve the current context by running
 `nvim-context`.
@@ -71,94 +69,43 @@ selection (if any), and diagnostics in this format:
   "diagnostics": []
 }
 ```
-```
 
 ### Integration with agentic tools
 #### Amp Code
+```sh
+amp skill add majjoha/nvim-context/nvim-context
+```
 
 #### Claude Code
-<details>
-<summary>`~/.claude/skills/nvim-context/SKILL.md`</summary>
-```md
----
-name: nvim-context
-description: Get the current Neovim context as JSON (cursor position, current
-file, visual selection and diagnostics) to help answer questions about code at
-the current cursor position, visual selections and diagnostics. Use when users
-ask about "this line", "current file", "selection" or need context about their
-Neovim editor state.
----
-
-# Neovim context provider
-## Purpose
-Provides live context from the user's Neovim editor session to help answer
-context-aware questions about code.
-
-## How it works
-1. Executes the `nvim-context` tool to get the current editor state.
-2. Returns JSON data including cursor position, open file, visual selection and
-   diagnostics.
-3. Use this information to understand references like "this line", "the
-   selection", "current file", etc.
+```sh
+# Add the repository as a marketplace
+/plugin marketplace add majjoha/nvim-context
 
-## Usage examples
-- "What's wrong with this line?" → Check diagnostics at cursor
-- "Explain the selected code" → Analyze visual selection
-- "What file am I in?" → Return current file path
-- "Show me all errors" → List all LSP diagnostics
+# Install the plugin
+/plugin install nvim-context@nvim-context
+```
 
-## Technical Details
-The skill runs: `/Users/mathias/Dropbox/Kode/Ruby/nvim-context/bin/nvim-context`
+The plugin provides the `nvim-context` skill which gives Claude Code access to
+your live Neovim editor state.
 
-This provides JSON output like:
-```json
-{
-  "cursor": {
-    "line": 43,
-    "col": 3
-  },
-  "file": "/path/to/current/file.rb",
-  "selection": null,
-  "diagnostics": []
-}
-```
+#### Codex
+```sh
+$skill-installer install https://github.com/majjoha/nvim-context/tree/main/.codex/skills/nvim-context
 ```
-</details>
-
-### Codex
-TBD.
 
 #### Gemini
 TBD.
 
 #### OpenCode
-
 <details>
-<summary>`~/.config/opencode/tool/nvim-context.ts`</summary>
-```typescript
-// 
-import { execSync } from "child_process";
-
-export default {
-  description:
-    "Get the current Neovim context as JSON (cursor position, current file, visual selection and diagnostics)",
-  args: {},
-  async execute(args) {
-    try {
-      const output = execSync(
-        "/Users/mathias/Dropbox/Kode/Ruby/nvim-context/bin/nvim-context",
-        {
-          encoding: "utf8",
-          timeout: 5000,
-        },
-      );
-      return output.trim();
-    } catch (error) {
-      return `nvim-context unavailable: ${error.message}`;
-    }
-  },
-};
-```
+<summary><code>~/.config/opencode/command/nvim-context.md</code></summary>
+<pre>
+---
+description: Show current Neovim context
+---
+
+!`nvim-context`
+</pre>
 </details>
 
 ## Disclaimer

data/lib/nvim_context/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NvimContext
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nvim-context
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mathias Jean Johansen
@@ -23,69 +23,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.13.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.13.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.81.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.81.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.26.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.8.0
 description: |
-  `nvim-context` extracts live context from running Neovim instances via Unix
-  socket connections, providing AI coding tools with cursor position, current
-  file, visual selections, and diagnostics as JSON. It enables context-aware
-  assistance by giving agents awareness of your current Neovim editor state,
-  supporting questions like "What does this line do?" or analysis of selected
-  code.
+  `nvim-context` has been renamed to `nvim-control`. This final release
+  exists only to point users at the new gem. Install `nvim-control`
+  instead. See https://github.com/majjoha/nvim-control.
 email: mathias@mjj.io
 executables:
 - nvim-context
@@ -104,14 +45,17 @@ files:
 - lib/nvim_context/errors.rb
 - lib/nvim_context/fetcher.rb
 - lib/nvim_context/version.rb
-homepage: https://github.com/majjoha/nvim-context
+homepage: https://github.com/majjoha/nvim-control
 licenses:
 - ISC
 metadata:
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/majjoha/nvim-context
-  changelog_uri: https://github.com/majjoha/nvim-context/blob/main/CHANGELOG.md
-  bug_tracker_uri: https://github.com/majjoha/nvim-context/issues
+  source_code_uri: https://github.com/majjoha/nvim-control
+  bug_tracker_uri: https://github.com/majjoha/nvim-control/issues
+post_install_message: |
+  nvim-context has been renamed to nvim-control.
+  Please switch: gem install nvim-control
+  See https://github.com/majjoha/nvim-control
 rdoc_options: []
 require_paths:
 - lib
@@ -128,5 +72,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: Bridge between running Neovim instances and agentic coding tools.
+summary: 'DEPRECATED: renamed to nvim-control.'
 test_files: []

data/CLAUDE.md

@@ -1,38 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with
-code in this repository.
-
-## Commands
-- **Test all**: `bundle exec rspec`
-- **Test unit**: `bundle exec rspec --exclude-pattern "spec/integration/*"`
-- **Test integration**: `bundle exec rspec spec/integration/`
-- **Test single file**: `bundle exec rspec path/to/spec.rb`
-- **Lint**: `bundle exec rubocop`
-- **Run tool**: `bin/nvim-context`
-
-## Architecture
-This gem extracts context from a running Neovim instance via Unix socket
-connection. It outputs JSON with cursor position, current file, visual
-selection, and LSP diagnostics.
-
-### Core Components
-- `Connector` - Manages Neovim socket connection using the `neovim` gem. Uses
-  `NVIM_CONTEXT_SOCKET` env var or defaults to `nvim-context.sock`
-- `Fetcher` - Entry point that orchestrates data extraction and returns JSON.
-  Handles all error types and formats error responses
-- `DataExtractor` - Static methods to extract cursor, file, selection, and
-  diagnostics from Neovim client
-
-### Error Handling
-Custom errors in `errors.rb`: `ConnectionError` (socket failures) and
-`ContextError` (Neovim operation failures). Fetcher catches all errors and
-returns JSON error objects.
-
-## Code Style
-- Ruby 3.4, line length max 80 chars
-- Double quotes for strings, frozen string literals not enforced by Rubocop
-- Classes in `NvimContext` module
-- Private constants at class bottom with `private_constant`
-- Use `attr_reader` for private attributes
-- RSpec with expect syntax, monkey patching disabled