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

Author: Christopher J. Brody

.github/workflows/nodejs.yml

@@ -0,0 +1,40 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master, brodybits-* ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      # ref:
+      # - https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow#configuring-a-build-matrix
+      # - https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix
+      matrix:
+        os:
+        - macos-latest
+        - windows-latest
+        node-version:
+        - 8.x
+        - 10.x
+        - 12.x
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm i
+    - run: npm run build --if-present
+    - run: npm test
+      env:
+        CI: true

.github/workflows/pr-merge.yml

@@ -0,0 +1,21 @@
+# original source:
+# https://github.com/marketplace/actions/pull-request-merge-command#installation
+name: 'Merge command'
+
+on: issue_comment
+
+jobs:
+  merge-command:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v1
+
+    - name: Merge command
+      uses: Goobles/gh-actions-merge-command@v1
+      with:
+        allow_ff: false
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -27,6 +27,7 @@ Temporary Items
 
 node_modules
 npm-debug.log
+yarn-error.log
 
 # Stryker mutator output
 .stryker-tmp

.travis.yml

@@ -28,20 +28,15 @@ This tool based on [`react-native-create-library`](https://www.npmjs.com/package
 ### General status
 
 - **React Native versions supported:**
-  - recommended: `0.60`, `0.61-rc` (see known quirks and issues below)
-  - outdated: `0.59`
-- Known quirks & issues on React Native 0.60(+):
-  - [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
+  - recommended: `0.61`
+  - minimum (outdated): `0.60`
 - Platform fork support
-  - tvOS platform support
+  - tvOS platform fork
     - 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))
+    - requires the [`react-native-tvos`](https://www.npmjs.com/package/react-native-tvos) fork, with minimum version of 0.60 ref:  [react-native-community/react-native-tvos#11](https://github.com/react-native-community/react-native-tvos/issues/11)), [issue #95](https://github.com/brodybits/create-react-native-module/issues/95)
     - 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
-  - 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))
+- Out-of-tree platforms
+  - Windows - no longer supported for reasons discussed in issues [#23](https://github.com/brodybits/create-react-native-module/issues/23) and [#43](https://github.com/brodybits/create-react-native-module/issues/43) (existing Windows C# template is kept in `unsupported-platforms` for now (at least) and further discussion would be welcome in a new issue on GitHub)
   - 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))
 
@@ -54,8 +49,10 @@ Why not use `react-native new-library`? Unfortunately that command doesn't creat
 
 ### Alternatives
 
-- [`react-native-create-library`](https://www.npmjs.com/package/react-native-create-library)
-- [`react-native-create-bridge`](https://github.com/peggyrayzis/react-native-create-bridge)
+- [`brodybits/react-native-module-init`](https://github.com/brodybits/react-native-module-init) - new interactive CLI that uses the templates from this utiity
+- [`react-native-community/bob`](https://github.com/react-native-community/bob) - opinionated, interactive library CLI that is designed to support both native libraries and libraries with web support
+
+__Outdated alternatives:__ see [acknowledgements](#acknowledgements) below
 
 ## Installation
 
@@ -96,9 +93,10 @@ Usage: create-react-native-module [options] <name>
 Options:
 
   -V, --version                             output the version number
-  --prefix <prefix>                         The prefix for the library module (Default: ``)
+  --prefix <prefix>                         The prefix of the native library module, ignored if --class-name is specified (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`)
+  --class-name <className>                  The name of the native object to be exported by the JavaScript and by the native code. Default: (prefix)(name in PascalCase)
+  --module-prefix <modulePrefix>            The native module prefix for the library module package name, ignored if --module-name is specified (Default: `react-native`)
   --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)
@@ -110,7 +108,7 @@ Options:
   --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: `react-native@0.59`)
+  --example-react-native-version <version>  React Native version for the generated example project (default: `react-native@latest`)
   --write-example-podfile                   [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile
   -h, --help                                output usage information
 ```
@@ -132,9 +130,10 @@ createLibraryModule({
 ```javascript
 {
   name: String, /* The name of the library (Default: Library) */
-  prefix: String, /* The prefix for the library (Default: ``) */
+  prefix: String, /* The prefix of the native library module, ignored if className is specified (Default: ``) */
   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) */
+  className: String, /* The name of the native object to be exported by the JavaScript and by the native code. Default: (prefix)(name in PascalCase) */
+  modulePrefix: String, /* The native module prefix for the library module package name, ignored if moduleName is specified (Default: react-native) */
   platforms: Array | String, /* Platforms the library will be created for. (Default: ['android', 'ios']) */
   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) */
@@ -146,15 +145,11 @@ createLibraryModule({
   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: `react-native@0.59`) */
+  exampleReactNativeVersion: String, /* React Native version for the generated example project (Default: `react-native@latest`) */
   writeExamplePodfile: Boolean, /* [iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile (Default: false) */
 }
 ```
 
-## Behavior not tested or supported
-
-- Windows platform support
-
 ## Examples
 
 ### Example module with no view
@@ -175,12 +170,16 @@ cd react-native-alice-helper/example
 
 #### Running the example app
 
-__Within the example test app subdirectory:__
+**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
+
+__Extra notes:__
+
+_Within the example test app subdirectory:_
 
 It is *recommended* to start the Metro Bundler manually (within `react-native-alice-helper/example`), which would run in the foreground:
 
 ```
-npm start
+yarn start
 ```
 
 Otherwise, React Native will open its own window to run the Metro Bundler.
@@ -199,7 +198,7 @@ ANDROID_HOME=~/Library/Android/sdk react-native run-android
 
 For iOS:
 
-Extra installation step needed on React Native 0.60(+) (see [issue #28](https://github.com/brodybits/create-react-native-module/issues/28)):
+Extra installation step needed _in case of clean checkout only_:
 
 ```
 cd ios && pod install && cd ..
@@ -217,7 +216,7 @@ or do the following command to open the iOS project in Xcode:
 open ios/example.xcodeproj
 ```
 
-__Expected result:__
+#### Expected result
 
 The example app shows the following indications:
 
@@ -242,17 +241,26 @@ Then go into the example app subdirectory:
 cd react-native-carol-widget/example
 ```
 
-__Within the example test app subdirectory:__
+#### Running the view example app
+
+**Recommended:** Follow the instructions shown in the end of the console log output, which are more likely to be up-to-date.
+
+__Some extra notes:__
+
+_Within the example test app subdirectory:_
 
 It is *recommended* to start the Metro Bundler manually as described above (within `react-native-carol-widget/example`):
 
 ```
-npm start
+yarn start
 ```
 
 To run on Android: do `react-native run-android` as described for the other example above.
 
-To run on iOS: do `pod install` in `ios` subdirectory for React Native 0.60(+) (see above), then do `react-native run-ios` or `open ios/example.xcodeproj` as described for the other example above.
+To run on iOS (as described above):
+
+- _in case of clean checkout **only**_: do `pod install` in `ios` subdirectory
+- do `react-native run-ios` or `open ios/example.xcodeproj`
 
 __Expected result:__
 

README.md

@@ -1,31 +1,46 @@
 const emoji = require('node-emoji');
 
+const logSymbols = require('log-symbols');
+
 const normalizedOptions = require('./normalized-options');
 
 const createLibraryModule = require('./lib');
 
-const postCreateInstructions = ({ moduleName, exampleName, writeExamplePodfile }) => {
-  return `
+const postCreateInstructions = ({
+  moduleName,
+  platforms,
+  generateExample,
+  exampleName
+}) => `
 ====================================================
 YOU'RE ALL SET!
-
-To build and run iOS example project, do:
-----
-cd ${moduleName}/${exampleName}
-yarn
-cd ios
-pod install # ${writeExamplePodfile ? `required` : `required starting with React Native 0.60`}
-cd ..
-react-native run-ios
-----
-`;
-};
+` + (generateExample
+    ? `
+${emoji.get('bulb')} check out the example app in ${moduleName}/${exampleName}
+${emoji.get('bulb')} recommended: run Metro Bundler in a new shell
+${logSymbols.info} (cd ${moduleName}/${exampleName} && yarn start)
+${emoji.get('bulb')} enter the following commands to run the example app:
+${logSymbols.info} cd ${moduleName}/${exampleName}
+${platforms.split(',').map(platform =>
+  `${logSymbols.info} react-native run-${platform}`
+).join(`
+`)}
+${logSymbols.warning} first steps in case of a clean checkout
+${logSymbols.info} run Yarn in ${moduleName}/${exampleName}/ios
+${logSymbols.info} (cd ${moduleName}/${exampleName} && yarn)
+${logSymbols.info} do \`pod install\` for iOS in ${moduleName}/${exampleName}/ios
+${logSymbols.info} cd ${moduleName}/${exampleName}
+${logSymbols.info} (cd ios && pod install)
+`
+    : `
+${emoji.get('bulb')} next time consider using \`--generate-example\` to add a generated example!
+`);
 
 module.exports = {
   name: 'create-library',
   description: 'creates a React Native library module for one or more platforms',
   usage: '[options] <name>',
-  func: (args, config, options) => {
+  action: (args, options) => {
     const name = args[0];
 
     const beforeCreation = Date.now();
@@ -57,14 +72,17 @@ ${postCreateInstructions(createOptions)}`);
   },
   options: [{
     command: '--prefix [prefix]',
-    description: 'The prefix for the library module',
+    description: 'The prefix of the native library module, ignored if --class-name is specified',
     default: '',
   }, {
     command: '--module-name [moduleName]',
     description: 'The module library package name to be used in package.json. Default: react-native-(name in param-case)',
+  }, {
+    command: '--class-name [className]',
+    description: 'The name of the native object to be exported by the JavaScript and by the native code. Default: (prefix)(name in PascalCase)',
   }, {
     command: '--module-prefix [modulePrefix]',
-    description: 'The module prefix for the library module, ignored if --module-name is specified',
+    description: 'The native module prefix for the library module package name, ignored if --module-name is specified',
     default: 'react-native',
   }, {
     command: '--package-identifier [packageIdentifier]',
@@ -109,7 +127,7 @@ ${postCreateInstructions(createOptions)}`);
   }, {
     command: '--example-react-native-version [exampleReactNativeVersion]',
     description: 'React Native version for the generated example project',
-    default: 'react-native@0.59',
+    default: 'react-native@latest',
   }, {
     command: '--write-example-podfile',
     description: '[iOS] EXPERIMENTAL FEATURE NOT SUPPORTED: write (or overwrite) example ios/Podfile',

lib/cli-command.js

@@ -1,17 +1,20 @@
+const pkg = require('./../package.json');
+require('please-upgrade-node')(pkg);
+
 const program = require('commander');
+
 const updateNotifier = require('update-notifier');
 
 const command = require('./cli-command');
-const pkg = require('./../package.json');
 
 updateNotifier({ pkg }).notify();
 
 program
   .version(pkg.version)
   .usage(command.usage)
   .description(command.description)
-  .action(function runAction () {
-    command.func(arguments, {}, this.opts());
+  .action(function programAction (_, args) {
+    command.action(args, this.opts());
   });
 
 (command.options || [])