Skip to content

docs(README): add Neovim installation section with LuaRocks path setup and manual git methods#23

Merged
aiya000 merged 17 commits intomainfrom
copilot/add-installation-section-readme
Mar 1, 2026
Merged

docs(README): add Neovim installation section with LuaRocks path setup and manual git methods#23
aiya000 merged 17 commits intomainfrom
copilot/add-installation-section-readme

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 2, 2025

  • Add a new subsection "With Neovim" under the "📦 Installation" section
  • Include installation instructions for popular Neovim package managers (lazy.nvim, packer.nvim, vim-plug)
  • Add LuaRocks path configuration instructions for Neovim
  • Include troubleshooting notes about Lua 5.1 compatibility
  • Add manual installation methods using git clone and git submodule for Neovim
  • Rename luarrow-repo to luarrow in manual installation examples
  • Clarify LuaRocks path setup applies to package manager installs only
  • Replace non-standard --lr-path/--lr-cpath flags with luarocks path parsing
  • Add vim.fn.executable check and pcall(require) validation
  • Fix unquoted LUA_PATH/LUA_CPATH regex fallback to match full line
  • Add trim_trailing_separators helper
  • Fix manual install src path to match main branch structure
  • Use luarocks path --lua-version 5.1 for Neovim-compatible paths
  • Raise a clear error when io.popen fails
  • Use luarocks install --lua-version 5.1 in package manager build commands
  • Capture pcall return value to avoid double-require
  • Fix malformed closing fence ````````` on the require('luarocks') snippet
  • Fix code fence info string lua:luarocks.lualua for correct syntax highlighting
  • Fix path typo ~/.config/nvim/l/ua/plugins.lua~/.config/nvim/lua/plugins.lua
Original prompt

This section details on the original issue you should resolve

<issue_title>Add a sub section to README.md for installing to Neovim</issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)

Note

Custom agent used: PR Creator Agent
An agent creates PullRequests when assigned to an issue


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI changed the title [WIP] Add installation instructions for Neovim to README.md docs(README): add Neovim installation section Nov 2, 2025
Copilot AI requested a review from aiya000 November 2, 2025 12:14
@aiya000 aiya000 marked this pull request as ready for review February 12, 2026 22:57
@aiya000 aiya000 requested a review from Copilot February 12, 2026 22:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Neovim-focused installation guidance to improve discoverability and onboarding for Neovim users who want to use luarrow from their editor config.

Changes:

  • Introduces a new “With Neovim” subsection under Installation
  • Adds example snippets for lazy.nvim, packer.nvim, and vim-plug
  • Adds a short snippet showing require('luarrow') usage from a Neovim config

@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Feb 12, 2026

@copilot apply changes based on the comments in this thread

Copilot AI changed the title docs(README): add Neovim installation section docs(README): add Neovim installation section with LuaRocks path setup Feb 12, 2026
@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Feb 22, 2026

@copilot
As an additional method, I would like to show you how to add this repository to the .config/nvim/lua directory using git submodule add or git-clone.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 22, 2026

@copilot
As an additional method, I would like to show you how to add this repository to the .config/nvim/lua directory using git submodule add or git-clone.

Added a new "Manually (git clone or git submodule)" subsection under "With Neovim" in commit e666072. It shows both methods and includes the init.lua snippet to add the src directory to package.path so require('luarrow') works directly from the cloned repo.

Copilot AI changed the title docs(README): add Neovim installation section with LuaRocks path setup docs(README): add Neovim installation section with LuaRocks path setup and manual git methods Feb 22, 2026
@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Feb 22, 2026

@copilot
As an additional method, I would like to show you how to add this repository to the .config/nvim/lua directory using git submodule add or git-clone.

Added a new "Manually (git clone or git submodule)" subsection under "With Neovim" in commit e666072. It shows both methods and includes the init.lua snippet to add the src directory to package.path so require('luarrow') works directly from the cloned repo.

@copilot
Nice! However, the name luarrow-repo might not be cool even as an example. I think simply luarrow would be fine.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 22, 2026

@copilot
As an additional method, I would like to show you how to add this repository to the .config/nvim/lua directory using git submodule add or git-clone.

...

Renamed luarrow-repo to luarrow in all three places (clone path, submodule path, and init.lua snippet) in commit c3aacea.

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 28, 2026

@copilot apply changes based on the comments in this thread

Applied both changes from the review in commit 93e624d:

  • luarocks path --lua-version 5.1 to ensure Lua 5.1 (Neovim/LuaJIT) compatible paths are returned
  • io.popen failure now raises a descriptive error ('Failed to run "luarocks path": ...') instead of silently returning

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Co-authored-by: Copilot <[email protected]>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Feb 28, 2026

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 28, 2026

@copilot apply changes based on the comments in this thread

Applied both changes from review #3869969712 in commit f5ba991:

  • Package manager build commands now use luarocks install --lua-version 5.1 luarrow directly, ensuring the package lands in the Lua 5.1 tree that luarocks path --lua-version 5.1 exposes to Neovim
  • pcall(require, 'luarrow') now captures the module as local ok, luarrow = pcall(...), and arrow/fun are read from luarrow.arrow/luarrow.fun — no double-require

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Mar 1, 2026

TODO: Check on my Neovim

…es in Lua snippets

- Change double quotes to single quotes in lazy.nvim and packer.nvim snippets
- Split LuaRocks setup into numbered steps (create luarocks.lua, require it, use luarrow)
- Add TIP admonition noting luarocks.lua is reusable for other packages
- Add NOTE admonition clarifying require() order in init.lua
- Add horizontal separators around the LuaRocks setup section
@aiya000
Copy link
Copy Markdown
Owner

aiya000 commented Mar 1, 2026

Checked.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.

Co-authored-by: Copilot <[email protected]>
@aiya000 aiya000 merged commit fc4a1e6 into main Mar 1, 2026
1 check passed
@aiya000 aiya000 deleted the copilot/add-installation-section-readme branch March 1, 2026 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a sub section to README.md for installing to Neovim

3 participants