Docs Request-Feature/Issues

Table Of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Setup
• License
• Acknowledgements

About The Project

This plugin (Penvim) has 4 purposes:

1. change current working directory to project's root directory.
2. load config defined in project's root directory
3. detect indentation of Source Code and set indentation related config according to detected indentation (Working on it...)
4. set option according to Language's Standard Style Guide (Working on it...)

Getting Started

Install PenVim using your favorite package manager.

Prerequisites

• neovim 0.6+

Installation

using vim-plug

Plug 'shaeinst/penvim'

or using packer.nvim

use {'shaeinst/penvim'}

Setup

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

Full Configuration

require("penvim").setup({
    project_env = {
        enable = true,
        config_name = '.__nvim__.lua'
    },
    rooter = {
        enable = true,
        patterns = {'.__nvim__.lua', '.git', 'node_modules', '.sln', '.svn'}
    },
})

To-Do

• Implement indentor (indentaion detector)
• implement to set option according to Language's Standard Style Guide
• optimize code

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgements

• for README