Skip to content

Commit e5520aa

Browse files
committed
add "Why AutoSource" section
1 parent 454bf0b commit e5520aa

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

readme.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ To prevent arbitrary code execution attacks, AutoSource will prompt you to appro
1010

1111
In this gif I answered "no" to the prompt so that it was not sourced, then opened the `.vimrc` file that was cloned with the repo to see the _very_ malicious code inside.
1212

13+
## Why AutoSource
14+
I work on many projects, some personal and others for work. Each project has its' own standards and requirements, which means I can't configure VIM to handle a given language in a single way. I'll also commonly hop into different repos to tweak something (e.g. an API response), then hop back to what I was originally doing (e.g. writing some client code that consumes said API endpoint).
15+
16+
I wrote AutoSource because the available options (`exrc` and other plugins) didn't have either the functionality or security features that I wanted. AutoSource is configurable, unobtrusive, and secure.
17+
1318
## Installation
1419
### Plug
1520
**[Home Page](https://github.com/junegunn/vim-plug)**
@@ -43,7 +48,7 @@ AutoSource will also look for `.vimrc.lua` files and source them with `:luafile`
4348
### `g:autosource_hashdir`
4449
**Default:** `$HOME/.autosource_hashes`
4550

46-
This directory is where AutoSource stores the hashes of your files. These hases are used to check for changes so the plugin can prompt you for re-approval.
51+
This directory is where AutoSource stores the hashes of your files. These hashes are used to check for changes so the plugin can prompt you for re-approval.
4752

4853
### `g:autosource_disable_autocmd`
4954
**Default:** `0`
@@ -103,5 +108,10 @@ Approves the current file.
103108
## Planned Work
104109
Features are being tracked in the [issues page](https://github.com/jenterkin/vim-autosource/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement). If you would like to request a feature feel free to create an issue with the `enhancement` tag.
105110

111+
## Similar Projects
112+
- [exrc.vim](https://github.com/ii14/exrc.vim)
113+
- [local_vimrc](https://github.com/LucHermitte/local_vimrc)
114+
- [vim-projectlocal](https://github.com/krisajenkins/vim-projectlocal)
115+
106116
## Supported Operating Systems
107117
AutoSource currently only supports MacOS and Linux. Windows is not actively tested. If you would like to add Windows support, PRs are welcome.

0 commit comments

Comments
 (0)