From 1b92bd03d63711ed104f7f96713a98be2ad2f319 Mon Sep 17 00:00:00 2001 From: Yonas Kolb Date: Wed, 15 Nov 2017 01:35:37 +0100 Subject: [PATCH] add TargetSource.type documentation --- Docs/ProjectSpec.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Docs/ProjectSpec.md b/Docs/ProjectSpec.md index ff14ce4f..c644546c 100644 --- a/Docs/ProjectSpec.md +++ b/Docs/ProjectSpec.md @@ -63,7 +63,7 @@ Note that target names can also be changed by adding a `name` property to a targ ### Options - ⚪️ **carthageBuildPath**: `String` - The path to the carthage build directory. Defaults to `Carthage/Build`. This is used when specifying target carthage dependencies -- ⚪️ **createIntermediateGroups**: `Bool` - If this is specified and set to `true`, then intermediate groups will be created for every path component between the folder containing the source and the base path. For example, when enabled if a source path is specified as `Vendor/Foo/Hello.swift`, the group `Vendor` will created as a parent of the `Foo` group. +- ⚪️ **createIntermediateGroups**: `Bool` - If this is specified and set to `true`, then intermediate groups will be created for every path component between the folder containing the source and next existing group it finds or the base path. For example, when enabled if a source path is specified as `Vendor/Foo/Hello.swift`, the group `Vendor` will created as a parent of the `Foo` group. - ⚪️ **bundleIdPrefix**: `String` - If this is specified then any target that doesn't have an `PRODUCT_BUNDLE_IDENTIFIER` (via all levels of build settings) will get an autogenerated one by combining `bundleIdPrefix` and the target name: `bundleIdPrefix.name`. The target name will be stripped of all characters that aren't alphanumerics, hyphens, or periods. Underscores will be replace with hyphens. - ⚪️ **settingPresets**: `String` - This controls the settings that are automatically applied to the project and its targets. These are the same build settings that Xcode would add when creating a new project. Project settings are applied by config type. Target settings are applied by the product type and platform. By default this is set to `all` - `all`: project and target settings @@ -205,6 +205,10 @@ A source can be provided via a string (the path) or an object of the form: - 🔵 **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. +- ⚪️ **type**: `String`: This can be one of the following values + - `file`: a file reference with a parent group will be created (Default for files or directories with extensions) + - `group`: a group with all it's containing files. (Default for directories without extensions) + - `folder`: a folder reference. ```yaml @@ -221,6 +225,8 @@ targets: - "-Wextra" - path: MyOtherTargetSource3 compilerFlags: "-Werror -Wextra" + - path: Resources + type: folder ``` ### Dependency