Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions
Fastlane plugin to work with xcconfig files
https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions
apple buck fastlane fastlane-plugin ios macosx xcconfig xcode
Last synced: 2 months ago
JSON representation
Fastlane plugin to work with xcconfig files
- Host: GitHub
- URL: https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions
- Owner: mgrebenets
- License: mit
- Created: 2019-02-21T03:04:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-08-24T08:03:37.000Z (over 5 years ago)
- Last Synced: 2024-03-23T09:13:22.815Z (10 months ago)
- Topics: apple, buck, fastlane, fastlane-plugin, ios, macosx, xcconfig, xcode
- Language: HTML
- Size: 772 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xcconfig_actions plugin
[](https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions)
[](https://rubygems.org/gems/fastlane-plugin-xcconfig_actions)
[](https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions)
[](https://circleci.com/gh/mgrebenets/fastlane-plugin-xcconfig_actions)
[](https://travis-ci.org/mgrebenets/fastlane-plugin-xcconfig_actions)
[](https://coveralls.io/github/mgrebenets/fastlane-plugin-xcconfig_actions)
[](http://inch-ci.org/github/mgrebenets/fastlane-plugin-xcconfig_actions)
## Getting Started
This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-xcconfig_actions`, add it to your project by running:
```bash
fastlane add_plugin xcconfig_actions
```
## About xcconfig_actions
Adds actions to fastlane to work with xcconfig files.
### read_xcconfig
The `read_xcconfig` action reads contents of xcconfig file the same way Xcode would do, meaning
- Support for resolving variable references like `$(VAR)`
- Support for nested variable references like `$(VAR1_$(VAR2))`
- Support for `#include "other.xcconfig"` statements
- Support for project/target level inheritance mechanism
- Support for `XCODE_VERSION_MAJOR` build setting
See [this xcconfig guide](https://pewpewthespells.com/blog/xcconfig_guide.html) for detailed explanation.
Things **not supported** at the moment:
- Conditional variable assignment, such as `FOO[sdk=macosx*] = 1`
- Use of `` in include paths
The build settings are also saved as a dictionary under `SharedValues::XCCONFIG_ACTIONS_BUILD_SETTINGS` key in current `lane_context`.
### build_settings_to_flags
Map build settings to Clang Cxx/Objective-C compiler, Swift compiler and Linker flags.
This action is useful when you plan to reuse xcconfigs with other tools, such as [Buck](https://buckbuild.com/), and you want to translate xcconfigs into the compiler/linker flags.
Build flags can be printed to standard output or saved to file.
The flags are also available via lane context as `lane_context[SharedValues::XCCONFIG_ACTIONS_BUILD_FLAGS]`.
The result is a dictionary with following keys:
- `compiler_flags` for Clang CXX/Objective-C compiler.
- `swift_compiler_flags` for Swift compiler.
- `linker_flags` for Clang linker.
#### Unofficial Build Settings References
The following are unofficial build settings references.
Unlike official help page, these pages contain extra information, such as build settings cross-reference and compiler and linker flags mapping.
- [Xcode 11.0 Beta 6 Build Settings](lib/fastlane/plugin/xcconfig_actions/helper/xcspecs/11.0/README.md)
- [Xcode 10.3 Build Settings](lib/fastlane/plugin/xcconfig_actions/helper/xcspecs/10.3/README.md)
- [Xcode 10.2.1 Build Settings](lib/fastlane/plugin/xcconfig_actions/helper/xcspecs/10.2.1/README.md)
- [Xcode 10.2 Build Settings](lib/fastlane/plugin/xcconfig_actions/helper/xcspecs/10.2/README.md)
- [Xcode 10.1 Build Settings](lib/fastlane/plugin/xcconfig_actions/helper/xcspecs/10.1/README.md)
#### References
- [Xcode Build Settings](https://help.apple.com/xcode/mac/10.2/#/itcaec37c2a6)
- [LLVM Clang Command Line Options](https://clang.llvm.org/docs/ClangCommandLineReference.html)
- [LLVM Clang Diagnostics](https://clang.llvm.org/docs/DiagnosticsReference.html)
- [GCC Warning Options](https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html)
- https://gist.github.com/fabiopelosin/4560417
- [Xcode Build System](https://pewpewthespells.com/blog/xcode_build_system.html)
#### Caveats
Flags like `-sdk iphoneos` and `-isysroot iphoneos` may not be suitable for all use cases.
These settings only get generated if you add `SDKROOT = iphoneos` to your xcconfigs, so don't define `SDKROOT` in xcconfigs and leave it to build tool.
##### Code Coverage
Flags like `CLANG_ENABLE_CODE_COVERAGE` will not have effect if set to `YES`.
This flag needs to be accompanied by changes in Xcode scheme UI to enable code coverage.
When used from command just setting `CLANG_ENABLE_CODE_COVERAGE=YES` has no effect either, instead the `-enableCodeCoverage YES` option has to be used.
In case of `CLANG_ENABLE_CODE_COVERAGE` add `CLANG_COVERAGE_MAPPING = YES` to xcconfigs to get proper flags mapping.
#### Known Issues
- [ ] The flags like `-std=gnu++14` are added to `compiler_flags` but are not applicable for C/Objective-C code.
Most tools have differentiation between C flags (C and Objective-C) and Cxx flags (C++/Objective-C++).
The solution would be to return 2 sets of flags for C and Cxx families, instead of just one `compiler_flags` option.
- [ ] [Build setting transformations](http://codeworkshop.net/posts/xcode-build-setting-transformations) like `$(PRODUCT_NAME:c99extidentifer)` are [not supported yet](https://github.com/mgrebenets/fastlane-plugin-xcconfig_actions/issues/1).
- [ ] Xcconfig includes are resolved **before** variable references. For example:
```c
#include "A.xcconfig"
VAR = A
#include "B.xcconfig" // Contains "VAR = B" statement.
// Resolved value of `VAR` is "B".
```
Will be resolved in the following order:
```c
#include "A.xcconfig"
#include "B.xcconfig"
VAR = A
// Resolved value of `VAR` is "A"!
```
This will cause issues if value of `VAR` is set in `B.xcconfig`.
### validate_xcconfig
Validate xcconfig using set of very opinionated rules:
- All included files must exist
- Include flow is unidirectional, i.e. top-down only:
```c
#include "../level_up.xcconfig" // ERROR: File is in parent directory.
```
- Files do not include other files on the same level:
```c
#include "same_level.xcconfig" // ERROR: Included file is on the same level.
```
- Files do not include other files more than 1 level down
```c
#include "level1/level2/level2.xcconfig" // ERROR: 2 levels down: level1/level2.
```
- Duplicated includes are not allowed
```c
#include "other.xcconfig"
#include "other.xcconfig" // ERROR: Duplicated include.
```
- Circular includes are not allowed
```c
// example.xcconfig file
#include "example.xcconfig" // ERROR: Include self creates circular include.
```
Things **not supported** at the moment:
- Use of `` in include paths
#### Rules Explanation
Xcconfigs are too easy to get out of hand.
Ability to use arbitrary include paths complicates usage of xcconfigs in quite a few ways:
- Hard to track where the variables are declared and then overwritten
- Xcode does not always report an error when a file is missing, but silently fails to resolve variables instead
These rules introduce convention to organizing xcconfigs.
The end goal is to make config files more manageable.
This helps greatly when configs are used in Xcode combined with project-level and target-level inheritance.
## Example
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and
```shell
# Read xcconfig example.
bundle exec fastlane read
# Map build settings to build flags.
bundle exec fastlane build_flags
# Validate xcconfig example.
bundle exec fastlane validate
```
## Run tests for this plugin
To run both the tests, and code style validation, run
```shell
rake
```
To automatically fix many of the styling issues, use
```shell
rubocop -a
```
## Issues and Feedback
For any other issues and feedback about this plugin, please submit it to this repository.
## Troubleshooting
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
## Using _fastlane_ Plugins
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
## About _fastlane_
_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).