1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-04-14 15:19:12 +08:00

doc: project_rooter_automatically (#4129)

+ some other minor corrections
This commit is contained in:
Ben Anson 2021-03-13 01:36:32 +00:00 committed by GitHub
parent 5af5b0d508
commit c69e3af7af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1923,8 +1923,8 @@ is based on on `project_rooter_patterns` option, and the default value is:
project_rooter_patterns = ['.git/', '_darcs/', '.hg/', '.bzr/', '.svn/'] project_rooter_patterns = ['.git/', '_darcs/', '.hg/', '.bzr/', '.svn/']
``` ```
The project manager will find outermost directory by default, to find nearest directory, The project manager will find the outermost directory by default. To find the nearest directory instead,
you need to change `project_rooter_outermost` to `false`. you need to change `project_rooter_outermost` to `false`:
```toml ```toml
[options] [options]
@ -1932,8 +1932,8 @@ you need to change `project_rooter_outermost` to `false`.
project_rooter_outermost = false project_rooter_outermost = false
``` ```
Sometimes we want to ignore some directorys when detect the project root directory. Sometimes we want to ignore some directories when detecting the project root directory.
add a `!` prefix before the pattern. Add a `!` prefix before the pattern.
For example, ignore `node_packages/` directory: For example, ignore `node_packages/` directory:
```toml ```toml
@ -1942,6 +1942,14 @@ For example, ignore `node_packages/` directory:
project_rooter_outermost = false project_rooter_outermost = false
``` ```
You can also disable project root detection completely (i.e. vim will set the
root directory to the present working directory):
```toml
[options]
project_rooter_automatically = false
```
Project manager commands start with `p`: Project manager commands start with `p`:
| Key Bindings | Descriptions | | Key Bindings | Descriptions |