Clarify exclude rules for Target Source Object

Add a link to documentation for those who are not aware of "Global Patterns" (commonly known as `glob rules`). Also point out that these rules apply within the path of the target source object, not relative to where `project.yml` resides.
This commit is contained in:
Keehun
2019-01-03 11:09:07 -06:00
committed by GitHub
parent cf703cd66d
commit bd6c758af0
+1 -1
View File
@@ -270,7 +270,7 @@ A source can be provided via a string (the path) or an object of the form:
- [x] **path**: **String** - The path to the source file or directory.
- [ ] **name**: **String** - Can be used to override the name of the source file or directory. By default the last component of the path is used for the name
- [ ] **compilerFlags**: **[String]** or **String** - A list of compilerFlags to add to files under this specific path provided as a list or a space delimitted string. Defaults to empty.
- [ ] **excludes**: **[String]** - A list of global patterns representing the files to exclude.
- [ ] **excludes**: **[String]** - A list of [global patterns](https://en.wikipedia.org/wiki/Glob_(programming)) representing the files to exclude. These rules are relative to `path` and _not the directory where `project.yml` resides_.
- [ ] **optional**: **Bool** - Disable missing path check. Defaults to false.
- [ ] **buildPhase**: **String** - This manually sets the build phase this file or files in this directory will be added to, otherwise XcodeGen will guess based on the file extension. Note that `Info.plist` files will never be added to any build phases, no matter what this setting is. Possible values are:
- `sources` - Compile Sources phase