Merge branch 'dev' of https://github.com/brodybits/create-react-native-module into with-native-section

Author: Christopher J. Brody

README.md

@@ -34,8 +34,13 @@ This tool based on [`react-native-create-library`](https://www.npmjs.com/package
   - [issue #99](https://github.com/brodybits/create-react-native-module/issues/99) - additional `pod install` step needed for RN 0.60 on iOS
   - [issue #29](https://github.com/brodybits/create-react-native-module/issues/29) - View does not work with RN 0.60 on Android (quick patch needed)
   - React Native 0.60(+) currently not supported by Expo or react-native-windows
+- Platform fork support
+  - tvOS platform support
+    - requires use of `--tvos-enabled` option as documented below
+    - requires the [`react-native-tvos`](https://www.npmjs.com/package/react-native-tvos) fork (see discussion in [react-native-community/react-native-tvos#11](https://github.com/react-native-community/react-native-tvos/issues/11))
+    - unstable with very limited testing, with limited if any active support from the primary maintainer [@brodybits](https://github.com/brodybits) (see [issue #127](https://github.com/brodybits/create-react-native-module/issues/127))
+    - minimum react-native-tvos version is 0.60 (see [issue #95](https://github.com/brodybits/create-react-native-module/issues/95))
 - Out-of-tree platform support
-  - tvOS platform support - unstable with very limited testing, minimum react-native-tvos version is 0.60 (see [issue #95](https://github.com/brodybits/create-react-native-module/issues/95))
   - Windows - unstable (not tested, see [issue #23](https://github.com/brodybits/create-react-native-module/issues/23)); now deprecated and may be removed in the near future (see [issue #43](https://github.com/brodybits/create-react-native-module/issues/43))
   - for future consideration: macOS (see [issue #94](https://github.com/brodybits/create-react-native-module/issues/94))
 - Node.js pre-10 support is deprecated and will be removed in the near future (see [issue #38](https://github.com/brodybits/create-react-native-module/issues/38))
@@ -94,17 +99,19 @@ Options:
   --prefix <prefix>                         The prefix for the library module (Default: ``)
   --module-name <moduleName>                The module library package name to be used in package.json. Default: react-native-(name in param-case)
   --module-prefix <modulePrefix>            The module prefix for the library module, ignored if --module-name is specified (Default: `react-native`)
-  --package-identifier <packageIdentifier>  (Android only!) The package name for the Android module (Default: `com.reactlibrary`)
+  --package-identifier <packageIdentifier>  [Android] The Java package identifier used by the Android module (Default: `com.reactlibrary`)
   --platforms <platforms>                   Platforms the library module will be created for - comma separated (Default: `ios,android`)
+  --tvos-enabled                            Generate the module with tvOS build enabled (requires react-native-tvos fork, with minimum version of 0.60, and iOS platform to be enabled)
   --github-account <githubAccount>          The github account where the library module is hosted (Default: `github_account`)
   --author-name <authorName>                The author's name (Default: `Your Name`)
   --author-email <authorEmail>              The author's email (Default: `[email protected]`)
   --license <license>                       The license type (Default: `MIT`)
   --view                                    Generate the module as a very simple native view component
-  --use-cocoapods                           Generate a library with a sample podspec and third party pod usage example
+  --use-apple-networking                    [iOS] Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code
   --generate-example                        Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally
   --example-name <exampleName>              Name for the example project (default: `example`)
   --example-react-native-version <version>  React Native version for the generated example project (default: `[email protected]`)
+  --write-example-podfile                   [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile
   -h, --help                                output usage information
 ```
 
@@ -129,16 +136,18 @@ createLibraryModule({
   moduleName: String, /* The module library package name to be used in package.json. Default: react-native-(name in param-case) */
   modulePrefix: String, /* The module prefix for the library, ignored if moduleName is specified (Default: react-native) */
   platforms: Array | String, /* Platforms the library will be created for. (Default: ['android', 'ios']) */
-  packageIdentifier: String, /* (Android only!) The package name for the Android module (Default: com.reactlibrary) */
+  packageIdentifier: String, /* [Android] The Java package identifier used by the Android module (Default: com.reactlibrary) */
+  tvosEnabled: Boolean, /* Generate the module with tvOS build enabled (requires react-native-tvos fork, with minimum version of 0.60, and iOS platform to be enabled) */
   githubAccount: String, /* The github account where the library is hosted (Default: `github_account`) */
   authorName: String, /* The author's name (Default: `Your Name`) */
   authorEmail: String, /* The author's email (Default: `[email protected]`) */
   license: String, /* The license type of this library (Default: `MIT`) */
-  useCocoapods: Boolean, /* Generate a library with a sample podspec and third party pod usage example (Default: false) */
+  useAppleNetworking: Boolean, /* [iOS] Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code (Default: false) */
   view: Boolean, /* Generate the module as a very simple native view component (Default: false) */
   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) */
   exampleName: String, /* Name for the example project (Default: `example`) */
   exampleReactNativeVersion: String, /* React Native version for the generated example project (Default: `[email protected]`) */
+  writeExamplePodfile: Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile (Default: false) */
 }
 ```
 

lib/cli-command.js

@@ -4,7 +4,7 @@ const normalizedOptions = require('./normalized-options');
 
 const createLibraryModule = require('./lib');
 
-const postCreateInstructions = ({ moduleName, useCocoapods, exampleName }) => {
+const postCreateInstructions = ({ moduleName, exampleName, writeExamplePodfile }) => {
   return `
 ====================================================
 YOU'RE ALL SET!
@@ -13,11 +13,10 @@ To build and run iOS example project, do:
 ----
 cd ${moduleName}/${exampleName}
 yarn
-${useCocoapods ? `cd ios
-pod install
+cd ios
+pod install # ${writeExamplePodfile ? `required` : `required starting with React Native 0.60`}
 cd ..
-`
-    : ``}react-native run-ios
+react-native run-ios
 ----
 `;
 };
@@ -69,12 +68,15 @@ ${postCreateInstructions(createOptions)}`);
     default: 'react-native',
   }, {
     command: '--package-identifier [packageIdentifier]',
-    description: '(Android only!) The package name for the Android module',
+    description: '[Android] The Java package identifier used by the Android module',
     default: 'com.reactlibrary',
   }, {
     command: '--platforms <platforms>',
     description: 'Platforms the library module will be created for - comma separated',
     default: 'ios,android',
+  }, {
+    command: '--tvos-enabled',
+    description: 'Generate the module with tvOS build enabled (requires react-native-tvos fork, with minimum version of 0.60, and iOS platform to be enabled)',
   }, {
     command: '--github-account [githubAccount]',
     description: 'The github account where the library module is hosted',
@@ -95,8 +97,8 @@ ${postCreateInstructions(createOptions)}`);
     command: '--view',
     description: 'Generate the module as a very simple native view component',
   }, {
-    command: '--use-cocoapods',
-    description: 'Generate a library with a sample podspec and third party pod usage example',
+    command: '--use-apple-networking',
+    description: '[iOS] Use `AFNetworking` dependency as a sample in the podspec & use it from the iOS code',
   }, {
     command: '--generate-example',
     description: 'Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally',
@@ -108,5 +110,8 @@ ${postCreateInstructions(createOptions)}`);
     command: '--example-react-native-version [exampleReactNativeVersion]',
     description: 'React Native version for the generated example project',
     default: '[email protected]',
+  }, {
+    command: '--write-example-podfile',
+    description: '[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile',
   }]
 };

lib/lib.js

@@ -27,7 +27,6 @@ const DEFAULT_GITHUB_ACCOUNT = 'github_account';
 const DEFAULT_AUTHOR_NAME = 'Your Name';
 const DEFAULT_AUTHOR_EMAIL = '[email protected]';
 const DEFAULT_LICENSE = 'MIT';
-const DEFAULT_USE_COCOAPODS = false;
 const DEFAULT_GENERATE_EXAMPLE = false;
 const DEFAULT_EXAMPLE_NAME = 'example';
 const DEFAULT_EXAMPLE_REACT_NATIVE_VERSION = '[email protected]';
@@ -70,15 +69,17 @@ const generateWithNormalizedOptions = ({
   packageIdentifier = DEFAULT_PACKAGE_IDENTIFIER,
   namespace,
   platforms = DEFAULT_PLATFORMS,
+  tvosEnabled = false,
   githubAccount = DEFAULT_GITHUB_ACCOUNT,
   authorName = DEFAULT_AUTHOR_NAME,
   authorEmail = DEFAULT_AUTHOR_EMAIL,
   license = DEFAULT_LICENSE,
   view = false,
-  useCocoapods = DEFAULT_USE_COCOAPODS,
+  useAppleNetworking = false,
   generateExample = DEFAULT_GENERATE_EXAMPLE,
   exampleName = DEFAULT_EXAMPLE_NAME,
   exampleReactNativeVersion = DEFAULT_EXAMPLE_REACT_NATIVE_VERSION,
+  writeExamplePodfile = false,
 }, {
   fs = fsExtra, // (this can be mocked out for testing purposes)
   execa = execaDefault, // (this can be mocked out for testing purposes)
@@ -101,14 +102,16 @@ const generateWithNormalizedOptions = ({
   modulePrefix: ${modulePrefix}
   packageIdentifier: ${packageIdentifier}
   platforms: ${platforms}
+  tvosEnabled: ${tvosEnabled}
   githubAccount: ${githubAccount}
   authorName: ${authorName}
   authorEmail: ${authorEmail}
   license: ${license}
   view: ${view}
-  useCocoapods: ${useCocoapods}
+  useAppleNetworking: ${useAppleNetworking}
   generateExample: ${generateExample}
   exampleName: ${exampleName}
+  writeExamplePodfile: ${writeExamplePodfile}
   `);
 
   // QUICK LOCAL INJECTION overwite of existing execSync / commandSync call from
@@ -158,12 +161,13 @@ const generateWithNormalizedOptions = ({
           packageIdentifier,
           namespace,
           platforms,
+          tvosEnabled,
           githubAccount,
           authorName,
           authorEmail,
           license,
           view,
-          useCocoapods,
+          useAppleNetworking,
           generateExample,
           exampleName,
         };
@@ -200,8 +204,9 @@ const generateWithNormalizedOptions = ({
             name: className,
             moduleName,
             view,
-            useCocoapods,
+            useAppleNetworking,
             exampleName,
+            writeExamplePodfile,
           };
 
           return Promise.all(

package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-native-module",
-  "version": "0.11.1-dev",
+  "version": "0.11.2-dev",
   "description": "Tool to create a React Native library module or view module with a single command",
   "bin": "bin/cli.js",
   "main": "lib/lib.js",
@@ -55,10 +55,10 @@
     "@stryker-mutator/html-reporter": "^2.1.0",
     "@stryker-mutator/javascript-mutator": "^2.1.0",
     "@stryker-mutator/jest-runner": "^2.1.0",
-    "eslint": "^6.3.0",
+    "eslint": "^6.4.0",
     "eslint-config-standard": "^14.1.0",
     "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^9.2.0",
+    "eslint-plugin-node": "^10.0.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "jest": "^24.9.0",

stryker.conf.js

@@ -1,6 +1,7 @@
 module.exports = config => {
   config.set({
     mutator: 'javascript',
+    mutate: ['lib/**/*.js', 'templates/**/*.js'],
     packageManager: 'yarn',
     reporters: ['html', 'clear-text', 'progress'],
     testRunner: 'jest',

templates/example.js

@@ -114,13 +114,13 @@ module.exports = [{
   })();
 `
 }, {
-  name: ({ useCocoapods, exampleName }) =>
-    useCocoapods ? `${exampleName}/ios/Podfile` : undefined,
+  name: ({ exampleName, writeExamplePodfile }) =>
+    writeExamplePodfile ? `${exampleName}/ios/Podfile` : undefined,
   content: ({ moduleName, exampleName }) => `platform :ios, '10.0'
 
 	target '${exampleName}' do
 		rn_path = '../node_modules/react-native'
-	
+
 		pod 'yoga', path: "#{rn_path}/ReactCommon/yoga/yoga.podspec"
 		pod 'DoubleConversion', :podspec => "#{rn_path}/third-party-podspecs/DoubleConversion.podspec"
 		pod 'Folly', :podspec => "#{rn_path}/third-party-podspecs/Folly.podspec"
@@ -144,7 +144,7 @@ module.exports = [{
 			'RCTGeolocation',
 			'DevSupport'
 		]
-	
+
 		pod '${moduleName}', :path => '../../${moduleName}.podspec'
 	end
 `,

templates/general.js

@@ -1,51 +1,7 @@
 module.exports = [{
   name: () => 'README.md',
-  content: ({ moduleName, packageIdentifier, name, namespace, platforms }) => {
-    let manualInstallation = '';
-
-    if (platforms.indexOf('ios') >= 0) {
-      manualInstallation += `
-#### iOS
-
-1. In XCode, in the project navigator, right click \`Libraries\` ➜ \`Add Files to [your project's name]\`
-2. Go to \`node_modules\` ➜ \`${moduleName}\` and add \`${name}.xcodeproj\`
-3. In XCode, in the project navigator, select your project. Add \`lib${name}.a\` to your project's \`Build Phases\` ➜ \`Link Binary With Libraries\`
-4. Run your project (\`Cmd+R\`)<
-`;
-    }
-
-    if (platforms.indexOf('android') >= 0) {
-      manualInstallation += `
-#### Android
-
-1. Open up \`android/app/src/main/java/[...]/MainApplication.java\`
-  - Add \`import ${packageIdentifier}.${name}Package;\` to the imports at the top of the file
-  - Add \`new ${name}Package()\` to the list returned by the \`getPackages()\` method
-2. Append the following lines to \`android/settings.gradle\`:
-  	\`\`\`
-  	include ':${moduleName}'
-  	project(':${moduleName}').projectDir = new File(rootProject.projectDir, 	'../node_modules/${moduleName}/android')
-  	\`\`\`
-3. Insert the following lines inside the dependencies block in \`android/app/build.gradle\`:
-  	\`\`\`
-      compile project(':${moduleName}')
-  	\`\`\`
-`;
-    }
-
-    if (platforms.indexOf('windows') >= 0) {
-      manualInstallation += `
-#### Windows
-[Read it! :D](https://github.com/ReactWindows/react-native)
-
-1. In Visual Studio add the \`${name}.sln\` in \`node_modules/${moduleName}/windows/${name}.sln\` folder to their solution, reference from their app.
-2. Open up your \`MainPage.cs\` app
-  - Add \`using ${namespace}.${name};\` to the usings at the top of the file
-  - Add \`new ${name}Package()\` to the \`List<IReactPackage>\` returned by the \`Packages\` method
-`;
-    }
-
-    return `# ${moduleName}
+  content: ({ moduleName, name }) =>
+    `# ${moduleName}
 
 ## Getting started
 
@@ -55,19 +11,14 @@ module.exports = [{
 
 \`$ react-native link ${moduleName}\`
 
-### Manual installation
-
-${manualInstallation}
-
 ## Usage
 \`\`\`javascript
 import ${name} from '${moduleName}';
 
 // TODO: What to do with the module?
 ${name};
 \`\`\`
-`;
-  },
+`,
 }, {
   name: () => 'package.json',
   content: ({ moduleName, packageIdentifier, platforms, githubAccount, authorName, authorEmail, license }) => {

templates/ios.js

@@ -1,6 +1,6 @@
 module.exports = platform => [{
   name: ({ moduleName }) => `${moduleName}.podspec`,
-  content: ({ moduleName, githubAccount, authorName, authorEmail, useCocoapods }) => `require "json"
+  content: ({ moduleName, tvosEnabled, githubAccount, authorName, authorEmail, useAppleNetworking }) => `require "json"
 
 package = JSON.parse(File.read(File.join(__dir__, "package.json")))
 
@@ -15,14 +15,14 @@ Pod::Spec.new do |s|
   s.license      = "MIT"
   # s.license    = { :type => "MIT", :file => "FILE_LICENSE" }
   s.authors      = { "${authorName}" => "${authorEmail}" }
-  s.platforms    = { :ios => "9.0", :tvos => "10.0" }
+  s.platforms    = { :ios => "9.0"${tvosEnabled ? `, :tvos => "10.0"` : ``} }
   s.source       = { :git => "https://github.com/${githubAccount}/${moduleName}.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,swift}"
   s.requires_arc = true
 
   s.dependency "React"
-	${useCocoapods ? `s.dependency 'AFNetworking', '~> 3.0'` : ``}
+	${useAppleNetworking ? `s.dependency 'AFNetworking', '~> 3.0'` : ``}
   # s.dependency "..."
 end
 
@@ -39,9 +39,9 @@ end
 }, {
   // implementation of module without view:
   name: ({ name, view }) => !view && `${platform}/${name}.m`,
-  content: ({ name, useCocoapods }) => `#import "${name}.h"
+  content: ({ name, useAppleNetworking }) => `#import "${name}.h"
 
-${useCocoapods ? `#import <AFNetworking/AFNetworking.h>
+${useAppleNetworking ? `#import <AFNetworking/AFNetworking.h>
 ` : ``}
 @implementation ${name}
 
@@ -50,7 +50,7 @@ RCT_EXPORT_MODULE()
 RCT_EXPORT_METHOD(sampleMethod:(NSString *)stringArgument numberParameter:(nonnull NSNumber *)numberArgument callback:(RCTResponseSenderBlock)callback)
 {
     // TODO: Implement some actually useful functionality
-	${useCocoapods
+	${useAppleNetworking
     ? `AFHTTPSessionManager *manager = [AFHTTPSessionManager manager];
 	manager.responseSerializer.acceptableContentTypes = [NSSet setWithObject:@"text/plain"];
 	[manager GET:@"https://httpstat.us/200" parameters:nil progress:nil success:^(NSURLSessionTask *task, id responseObject) {