Git Product home page Git Product logo

telescope-git-submodules.nvim's Introduction

telescope-git-submodules.nvim

A customizable Telescope extension to list the git submodules of your current project and interact with them through the git TUI of your choice.

features.mp4

Features

  • List the git submodules of the currently opened project
  • Preview the files changes for each submodule directly in Telescope
  • Run the git TUI (or command) of your choice when selecting a submodule in Telescope
  • Bypass Telescope if only one repo/submodule would be displayed in Telescope

Installation

Using lazy.nvim

return {
	"nvim-telescope/telescope.nvim",
	dependencies = {
		{
			"agoodshort/telescope-git-submodules.nvim",
			dependencies = "akinsho/toggleterm.nvim",
		},
	},
	config = function()
		require("telescope").load_extension("git_submodules")
	end,
}

Configuration

The extension comes with the following defaults:

require("telescope").setup({
	extensions = {
		git_submodules = {
			git_cmd = "lazygit",
			terminal_id = 9,
		},
	},
})

Extension Specs

Property Type Default Value Description
git_cmd string? "lazygit" git TUI command of your choice
terminal_id number? 9 Terminal ID toggleterm will use

Roadmap

  • Keymap to trigger :DiffView for the highlighted submodule
  • Support additional terminal plugins (e.g., nvim-terminal)

Acknowledgements

Inspired by lazygit.nvim

telescope-git-submodules.nvim's People

Contributors

agoodshort avatar github-actions[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.