https://github.com/abstract-ide/penvim

Project's root directory and documents Indentation detector with project based config loader
https://github.com/abstract-ide/penvim

indent lua-plugin neovim neovim-plugin rooter

Last synced: 4 days ago
JSON representation

Project's root directory and documents Indentation detector with project based config loader

• Host: GitHub
• URL: https://github.com/abstract-ide/penvim
• Owner: Abstract-IDE
• License: mit
• Created: 2022-04-05T10:04:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-07-23T09:12:33.000Z (over 2 years ago)
• Last Synced: 2024-05-23T00:14:31.170Z (6 months ago)
• Topics: indent, lua-plugin, neovim, neovim-plugin, rooter
• Language: Lua
• Homepage:
• Size: 32.2 KB
• Stars: 50
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        





  
PenVim


  


    project's root directory and documents indentation detector with project based config loader

    


    


    


  




  Docs

  Request-Feature/Issues

  

  ![Contributors](https://img.shields.io/github/contributors/shaeinst/penvim?color=dark-green) ![Issues](https://img.shields.io/github/issues/shaeinst/penvim) ![License](https://img.shields.io/github/license/shaeinst/penvim) ![Forks](https://img.shields.io/github/forks/shaeinst/penvim?style=social) ![Stargazers](https://img.shields.io/github/stars/shaeinst/penvim?style=social)



## Table Of Contents

* [About the Project](#about-the-project)

* [Examples](#examples-)

* [Getting Started](#getting-started)

  * [Prerequisites](#prerequisites)

  * [Installation](#installation)

* [Setup](#setup)

* [License](#license)

* [Acknowledgements](#acknowledgements)

## About The Project

This plugin (Penvim) has 4 purposes:

1. change current working directory to project's root directory.

2. detect indentation of Document (Source Code) and set indentation related config according to detected indentation

3. load config defined in project's root directory

4. set options according to Language's Standard Style Guide (not implemented yet...)

## Getting Started

Install PenVim using your favorite package manager.

### Prerequisites

* neovim >= 0.7

### Installation

using ```vim-plug```

```lua

Plug 'Abstract-IDE/penvim'

```

or using packer.nvim

```lua

use {'Abstract-IDE/penvim'}

```

## Setup

```lua

require("penvim").setup() -- use defaults

```

#### Full Configuration

```lua

require("penvim").setup({

	rooter = {

		enable = true, -- enable/disable rooter

		patterns = {'.__nvim__.lua', '.git', 'node_modules'}

	},

	indentor = {

		enable = true, -- enable/disable indentor

		indent_length = 4, -- tab indent width

		accuracy = 5, -- positive integer. higher the number, the more accurate result (but affects the startup time)

		disable_types = {

			'help','dashboard','dashpreview','NvimTree','vista','sagahover', 'terminal',

		},

	},

	project_env = {

		enable = true, -- enable/disable project_env

		config_name = '.__nvim__.lua' -- config file name

	},

})

```

## Examples :

	

		sample, config defined in project's root directory

	

```lua

-- .__nvim__.lua

return {

	-- for all file types

	all = {

		tabstop = 4, -- spaces per tab

		cursorline = true, -- highlight current line

		relativenumber = true, -- show relative line number

		number = true, -- show line numbers

	},

	-- for filetype lua

	lua = {	

		smarttab = true, -- / indent/dedent in leading whitespace

		softtabstop = 4,

		shiftwidth = 4, -- spaces per tab (when shifting), when using the >> or << commands, shift lines by 4 spaces

	},

	

	-- for filetype python and javascript

	py_js = {

		tabstop = 4, -- spaces per tab

		wrap = false, -- don't automatically wrap on load

	}

}

```

## To-Do

* testing

* implement to set option according to Language's Standard Style Guide

* optimize code

## License

Distributed under the MIT License. See [LICENSE](https://github.com/shaeinst/penvim/blob/main/LICENSE) for more information.

## Acknowledgements

* for [README](https://readme.shaankhan.dev/)