You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ja...@apache.org on 2019/03/01 13:00:13 UTC
[cordova-docs] branch master updated: Add podspec (#892)
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 42d725b Add podspec (#892)
42d725b is described below
commit 42d725b7b87a147fff2b1dbec0dd14a06559c15b
Author: Ken Naito <fi...@gmail.com>
AuthorDate: Fri Mar 1 22:00:08 2019 +0900
Add podspec (#892)
---
www/docs/en/dev/plugin_ref/spec.md | 83 ++++++++++++++++++++++++++++++++++++++
1 file changed, 83 insertions(+)
diff --git a/www/docs/en/dev/plugin_ref/spec.md b/www/docs/en/dev/plugin_ref/spec.md
index 76ca52c..3a3b6db 100644
--- a/www/docs/en/dev/plugin_ref/spec.md
+++ b/www/docs/en/dev/plugin_ref/spec.md
@@ -584,6 +584,89 @@ Another example of using Windows-specific attributes to add a reference to WinMD
target-dir="component\x86" arch="x86" versions=">=10.0" />
```
+## podspec (==iOS==)
+Identifies the CocoaPods `Podfile` that provides the dependencies in which the plugin depends on.
+
+This element contains a `<config>` and a `<pods>` tag.
+
+### config
+The `<config>` element identifies the source urls in which the CocoaPods specs are retrieved from.
+
+This element contains one or more `<source>` tags.
+
+#### source
+Attributes(type) | Description
+---------------- | ------------
+url | *Required* <br> The source url of pods spec.
+
+### pods
+The `<pods>` element identifies CocoaPods libraries.
+
+This element contains a `<pod>` tag for each CocoaPods libraries.
+
+Attributes(type) | Description
+---------------- | ------------
+use-frameworks(string) | Default: false <br/> If `true`, the `use_frameworks!` attribute is declared in the Podfile.
+inhibit-all-warnings(string) | Default: false <br/> If `true`, the `inhibit_all_warnings!` attribute is declared in the Podfile.
+
+#### pod
+
+Attributes(type) | Description
+---------------- | ------------
+name | *Required*<br/> Pod name
+spec | Pod spec
+swift-version | Specify swift version of the CocoaPods library
+git | Pod `git` option.
+branch | Pod `branch` option.
+tag | Pod `tag` option.
+commit | Pod `commit` option.
+configurations | Pod `configurations` option. For multiple values, separate them with a comma.
+http | Pod `http` option.
+path | Pod `path` option. Pod located on the local file system.
+options | Pod options declared in raw format. If declared, the other Pod options are overwritten.<br/>Example: `options=":git => 'https://github.com/Alamofire/Alamofire.git', :tag => '3.1.1'"`
+
+Examples:
+
+```
+ <podspec>
+ <config>
+ <source url="https://github.com/brightcove/BrightcoveSpecs.git" />
+ <source url="https://github.com/CocoaPods/Specs.git"/>
+ </config>
+ <pods use-frameworks="true">
+ <pod name="AFNetworking" spec="~> 3.2" />
+ <pod name="SDWebImage" spec="~> 4.0" />
+ <pod name="Eureka" swift-version="3.3" />
+ <pod name="AcknowList" />
+ <pod name="Brightcove-Player-Core" spec="~> 6.3.4" />
+ <pod name="Foobar1" git="git@github.com:hoge/foobar1.git" configurations="Debug"/>
+ <pod name="Foobar2" git="git@github.com:hoge/foobar2.git" branch="next" configurations="Debug,Release"/>
+ <pod name="FoobarSwift" swift-version="4.1" />
+ </pods>
+ </podspec>
+```
+
+This example leads `Podfile`
+
+```
+# DO NOT MODIFY -- auto-generated by Apache Cordova
+source 'https://github.com/brightcove/BrightcoveSpecs.git'
+source 'https://github.com/CocoaPods/Specs.git'
+platform :ios, '9.0'
+use_frameworks!
+target 'HelloCordova' do
+ project 'HelloCordova.xcodeproj'
+ pod 'AFNetworking', '~> 3.2'
+ pod 'SDWebImage', '~> 4.0'
+ pod 'Eureka'
+ pod 'AcknowList'
+ pod 'Brightcove-Player-Core', '~> 6.3.4'
+ pod 'Foobar1', :git => 'git@github.com:hoge/foobar1.git', :configurations => ['Debug']
+ pod 'Foobar2', :branch => 'next', :git => 'git@github.com:hoge/foobar2.git', :configurations => ['Debug','Release']
+ pod 'FoobarSwift'
+end
+```
+
## info
Additional information provided to users. This is useful when you require extra steps that can't be easily automated or are beyond the CLI's scope. The contents of this tag gets printed out when the CLI installs the plugin.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org