-
Notifications
You must be signed in to change notification settings - Fork 332
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add folder_include_patterns and file_include_patterns #129
base: sublime-text-3
Are you sure you want to change the base?
Changes from 1 commit
7b837fb
d7a90ee
08c7c94
db0e6bf
60e14c7
7df8c43
021f5be
6a55b35
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -223,11 +223,52 @@ and ``build_systems``, for project-specific build systems. | |
|
||
|
||
**Folders** | ||
Each folder must have a ``path``, | ||
and may optionally have a ``folder_exclude_patterns`` | ||
and ``file_exclude_patterns`` setting. | ||
The path may be relative to the project directory, | ||
or an absolute path. | ||
Each folder must have a ``path``, that may be absolute or | ||
relative. In the latter case it will be relative to the | ||
project directory. | ||
|
||
There are also the optional properties ``folder_include_patterns``, | ||
``file_include_patterns``, ``folder_exclude_patterns`` | ||
and ``file_exclude_patterns``. They all admit an array of strings | ||
as values, and understand basic globbing syntax, such as "*.html". | ||
|
||
The ones that include files and folders, work by excluding | ||
everything first, so that in the end only what they specify | ||
gets shown. After those, the ones that exclude folders apply, | ||
though with lesser precedence. | ||
|
||
Note that a pattern that includes any folder in the project | ||
directory will not automatically include every of it's sub-folders, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. *its |
||
but including theese will include any other descendants. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This paragraph does not make 100% sense to me. Mind explaining? Also *these Edit: It appears you are explaining it below but it doesn't completely get through. I think we need to reword this. |
||
|
||
For example, consider adding the following to a folder: | ||
|
||
.. sourcecode:: javascript | ||
{ | ||
"folders": | ||
[ | ||
{ | ||
"path": ".", | ||
"folder_include_patterns": ["foo"] | ||
} | ||
} | ||
|
||
If the folder "foo" is included, that will by itself include | ||
any other folder whose name starts with foo, whether it is in | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. double spaces here |
||
the project folder, or inside some other folder. But, the folder | ||
"bar" inside the "folder "foo" that resides in the project folder | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. -" So, do you mean a folder Do it like so: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not being able to make |
||
will not be included automatically, whereas another folder called | ||
"bar" or any other name in some other "foo" folder nested deeper | ||
**wll** be included by this definition. If you want to include | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. *will |
||
every sub-folder form a folder residing in the project folder, | ||
you can use something like "["foo", foo/*]". | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use literal blocks for this: |
||
|
||
Note also that a rule like the one in the prevous example would | ||
not let us exclude an already included "foo" sub-folder through | ||
the use of "folder_exclude_patterns", no matter the specificity | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Here and below, please make use of literal blocks, so |
||
of the rule (for example "baz/bar/foo"). Consider that includes | ||
have precedence over includes. | ||
|
||
Folders may also be given a ``name`` | ||
that will appear in the side bar. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are referring to the "patterns" here, not the settings. While it can be interpreted to be the patterns, explicitly mentioning it is better. (It confused me at first.)
Same for the second part of this paragraph.