https://github.com/sergioribera/vim-files

This is a simple plugin to create directories and files from vim, and even using templates
https://github.com/sergioribera/vim-files

neovim neovim-plugin nvim nvim-plugin vim vim-plugin vim-plugins

Last synced: 18 days ago
JSON representation

This is a simple plugin to create directories and files from vim, and even using templates

• Host: GitHub
• URL: https://github.com/sergioribera/vim-files
• Owner: SergioRibera
• Created: 2021-01-19T05:29:30.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-31T07:29:33.000Z (11 months ago)
• Last Synced: 2023-12-31T08:25:55.462Z (11 months ago)
• Topics: neovim, neovim-plugin, nvim, nvim-plugin, vim, vim-plugin, vim-plugins
• Language: Vim Script
• Homepage:
• Size: 304 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vim-Files

This is a simple plugin to create directories and files from vim, and even using templates

## Installation

Plug:

``` Vim

Plug 'SergioRibera/vim-files'

```

The other way would be cloning the repository.

## Instructions

### Variables

|               Name               |           Default Value           |                                                                                                                                  Description                                                                                                                                 |

|:--------------------------------:|:---------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|

|        g:vimFilesOpenMode        |                 0                 | This variable allows you to indicate which will be the opening method for the created file, being: `0` to open it in a Tab, `1` to open in vertical split, `2` to open in horizontal split, `3`  to open it in the current window and `4` so as not to open it automatically |

| g:vimFilesThemplatesRootPathFile | '~/.config/nvim/themplates/files' | This variable indicates the path in which the file templates must be searched                                                                                                                                                                                                |

| g:vimFilesThemplatesRootPathDir  | '~/.config/nvim/themplates/dirs'  | This variable indicates the path in which the folder structure templates should be searched.                                                                                                                                                                                 |

| g:vimFilesThemplatesDir          | { }                               | This variable is a dictionary, which contains the name of the template and its file, which will contain, separated by lines, the directories to be created, example: {'react': 'react / native.txt'}                                                                         |

| g:vimFilesThemplatesFiles        | { }                               | This variable is a dictionary, which contains the name of the template and its file, example: {'py-comp': 'python / component.txt'}                                                                                                                                          |

|g:vimFiles_AutoConfirmDeleteFolder|            v:false                |    |

### Functions

to see the updated details of changes and added features, please follow [this link](https://sergioribera.gitbook.io/generic-tools/vim-nvim-plugins/vim-files/functions)

### Examples

With vim open in the path `~/Projects/test`, I call the `VimFiles#CreateDir()` function, and enter `python/component`, the result is that now I have this complete path `~/Projects/test/python/component`





![Graphical Explication Directory Create](https://raw.githubusercontent.com/SergioRibera/vim-files/main/doc/dir.gif)





With vim open in the path `~/Projects/test`, I call the `VimFiles#CreateFile()` function, and enter `python/view/User.py`, the result is that now the file is created and also opened, if not have the necessary folders created, the function will create them automatically and recursively





![Graphical Explication File Create](https://raw.githubusercontent.com/SergioRibera/vim-files/main/doc/file.gif)

### Example Configurations

``` Vim

" Dictioinary of Dir Themplates

let g:vimFilesThemplatesDir = {

    \ 'react-native': 'react/native.txt',

    \ 'html-bootstrap': 'web/html/bootstrap.txt'

    \}

" Dictionary of Files Themplates

let g:vimFilesThemplatesFiles = {

    \ 'react-component': 'react/component.txt'

    \}

" Simple Created Relative Directory

noremap cd :call VimFiles#CreateDir()

" Simple Created Relative File

noremap cf :call VimFiles#CreateFile()

" Create Directories based in themplate

noremap cdd :call VimFiles#CreateDirThemplate()

" Create File based in themplate

noremap cff :call VimFiles#CreateFileThemplate()

```

### **Please report all bugs and problems**

Thanks for install this tool, for see more visit [my web](https://sergioribera.com) (Very soon I will add an app store)

## Donate

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Q5Q321D62)

[![](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/SergioRibera)

[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/SergioRibera)

#### Made with the ❤️ by [SergioRibera](https://sergioribera.com)