Skip to content

Commit 2b82efb

Browse files
author
Chris Brody
authored
Update description of --use-cocoapods option (#166)
according to the reality and show that this is an `EXPERIMENTAL FEATURE NOT SUPPORTED` as a quick fix solution
1 parent de87f99 commit 2b82efb

File tree

7 files changed

+8
-8
lines changed

7 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Options:
101101
--author-email <authorEmail> The author's email (Default: `[email protected]`)
102102
--license <license> The license type (Default: `MIT`)
103103
--view Generate the module as a very simple native view component
104-
--use-cocoapods Generate a library with a sample podspec and third party pod usage example
104+
--use-cocoapods [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec; use it from the iOS code & add `ios/Podfile` to generated example
105105
--generate-example Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally
106106
--example-name <exampleName> Name for the example project (default: `example`)
107107
--example-react-native-version <version> React Native version for the generated example project (default: `[email protected]`)
@@ -134,7 +134,7 @@ createLibraryModule({
134134
authorName: String, /* The author's name (Default: `Your Name`) */
135135
authorEmail: String, /* The author's email (Default: `[email protected]`) */
136136
license: String, /* The license type of this library (Default: `MIT`) */
137-
useCocoapods: Boolean, /* Generate a library with a sample podspec and third party pod usage example (Default: false) */
137+
useCocoapods: Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec; use it from the iOS code & add `ios/Podfile` to generated example (Default: false) */
138138
view: Boolean, /* Generate the module as a very simple native view component (Default: false) */
139139
generateExample: Boolean, /* Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally (Default: false) */
140140
exampleName: String, /* Name for the example project (Default: `example`) */

lib/cli-command.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ ${postCreateInstructions(createOptions)}`);
9696
description: 'Generate the module as a very simple native view component',
9797
}, {
9898
command: '--use-cocoapods',
99-
description: 'Generate a library with a sample podspec and third party pod usage example',
99+
description: '[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use `AFNetworking` dependency as a sample in the podspec; use it from the iOS code & add `ios/Podfile` to generated example',
100100
}, {
101101
command: '--generate-example',
102102
description: 'Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally',

tests/integration/cli/help/__snapshots__/cli-help.test.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Options:
1717
--author-email [authorEmail] The author's email (default: \\"[email protected]\\")
1818
--license [license] The license type (default: \\"MIT\\")
1919
--view Generate the module as a very simple native view component
20-
--use-cocoapods Generate a library with a sample podspec and third party pod usage example
20+
--use-cocoapods [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use \`AFNetworking\` dependency as a sample in the podspec; use it from the iOS code & add \`ios/Podfile\` to generated example
2121
--generate-example Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally
2222
--example-name [exampleName] Name for the example project (default: \\"example\\")
2323
--example-react-native-version [exampleReactNativeVersion] React Native version for the generated example project (default: \\"[email protected]\\")

tests/integration/cli/noargs/__snapshots__/cli-noargs.test.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Options:
1717
--author-email [authorEmail] The author's email (default: \\"[email protected]\\")
1818
--license [license] The license type (default: \\"MIT\\")
1919
--view Generate the module as a very simple native view component
20-
--use-cocoapods Generate a library with a sample podspec and third party pod usage example
20+
--use-cocoapods [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use \`AFNetworking\` dependency as a sample in the podspec; use it from the iOS code & add \`ios/Podfile\` to generated example
2121
--generate-example Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally
2222
--example-name [exampleName] Name for the example project (default: \\"example\\")
2323
--example-react-native-version [exampleReactNativeVersion] React Native version for the generated example project (default: \\"[email protected]\\")

tests/with-injection/cli/command/object/__snapshots__/lib-cli-command-object-text.test.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Object {
5656
},
5757
Object {
5858
"command": "--use-cocoapods",
59-
"description": "Generate a library with a sample podspec and third party pod usage example",
59+
"description": "[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use \`AFNetworking\` dependency as a sample in the podspec; use it from the iOS code & add \`ios/Podfile\` to generated example",
6060
},
6161
Object {
6262
"command": "--generate-example",

tests/with-mocks/cli/program/with-defaults/for-android/__snapshots__/cli-program-with-defaults-for-android.test.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Array [
123123
"option": Object {
124124
"args": Array [
125125
"--use-cocoapods",
126-
"Generate a library with a sample podspec and third party pod usage example",
126+
"[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use \`AFNetworking\` dependency as a sample in the podspec; use it from the iOS code & add \`ios/Podfile\` to generated example",
127127
[Function],
128128
undefined,
129129
],

tests/with-mocks/cli/program/with-missing-args/__snapshots__/cli-program-with-missing-args.test.js.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Array [
121121
"option": Object {
122122
"args": Array [
123123
"--use-cocoapods",
124-
"Generate a library with a sample podspec and third party pod usage example",
124+
"[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: Use \`AFNetworking\` dependency as a sample in the podspec; use it from the iOS code & add \`ios/Podfile\` to generated example",
125125
[Function],
126126
undefined,
127127
],

0 commit comments

Comments
 (0)