@@ -16,7 +16,7 @@ within 5 parent directories relative to the current file when
16
16
17
17
It support ES, AMD and CommonJS module import types.
18
18
19
- CONFIGURATION *vim-npr-targets *
19
+ CONFIGURATION *vim-npr-configuration *
20
20
21
21
Resolve directories are defined on a project-by-project basis,
22
22
allowing you to specify custom resolution directories uniquely.
@@ -33,11 +33,40 @@ of such array is below.
33
33
34
34
If the resolve key does not exist in the package, vim-npr will
35
35
attempt to resolve it in common directories. These are,
36
- "src", "test", "public" and "lib " by default.
36
+ "src", "lib", " test", "public" and "node_modules " by default.
37
37
38
38
Please note, that defining any resolve key will override the
39
39
defaults.
40
40
41
+ Max Levels g:vim_npr_max_levels
42
+
43
+ The maximum number of levels that the plugin will traverse
44
+ upwards in an attempt to resolve the package.json file within
45
+ the project. This can be overridden if your project requires
46
+ larger traversal.
47
+
48
+ File Names g:vim_npr_file_names
49
+
50
+ A list of strings that will be appended to the file path for
51
+ each resolution directory check. These will determine which
52
+ file ultimately gets resolved, this can also help modify the
53
+ path to add default file check names, e.g. index.js.
54
+
55
+ File Types g:vim_npr_file_types
56
+
57
+ A list of file extensions that the plugin will allow itself to
58
+ execute on. This however won't ensure that the includeexpr
59
+ variable has be set in the current buffer.
60
+
61
+ Default Dirs g:vim_npr_default_dirs
62
+
63
+ A list of default directories that the plugin will attempt
64
+ resolution within if it cannot find a resolve key in the
65
+ package.json file within the project. If a package.json file
66
+ is not found at all however, the plugin will throw an error
67
+ as it cannot be certain which directory is the top level for
68
+ the project it is currently within.
69
+
41
70
MAPPINGS *vim-npr-mappings*
42
71
43
72
The plugin works by extending the original functionality of *gf*.
0 commit comments