Merge pull request #9 from brodybits/0.4.0-updates

0.4.0 updates

Author: Chris Brody

README.md

@@ -60,29 +60,30 @@ Usage: create-react-native-module [options] <name>
 
 Options:
 
-  --help                                    output usage information
-  --prefix <prefix>                         The prefix for the library (Default: ``)
+  -V, --version                             output the version number
+  --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, ignored if --module-name is specified (Default: `react-native`)
+  --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`)
-  --platforms <platforms>                   Platforms the library will be created for. (comma separated; default: `ios,android`)
-  --github-account <github_account>         The github account where the library is hosted (Default: `github_account`)
-  --author-name <name>                      The author's name (Default: `Your Name`)
-  --author-email <email>                    The author's email (Default: `yourname@email.com`)
-  --license <license>                       The license type of this library (Default: `Apache-2.0`)
-  --view                                    Generate the module as a very simple native view component (Default: `false`)
-  --generate-example <shouldGenerate>       Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally (Default: `false`)
+  --platforms <platforms>                   Platforms the library module will be created for - comma separated (Default: `ios,android`)
+  --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: `yourname@email.com`)
+  --license <license>                       The license type (Default: `Apache-2.0`)
+  --view                                    Generate the module as a very simple native view component
+  --generate-example                        Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally
+  -h, --help                                output usage information
 ```
 
 ## Programmatic usage
 
 ```javascript
-const createLibrary = require('create-react-native-module');
+const createLibraryModule = require('create-react-native-module');
 
-createLibrary({
-  name: 'MyFancyLibrary'
+createLibraryModule({
+  name: 'MyFancyLibraryModule'
 }).then(() => {
-  console.log('Oh yay! My library has been created!');
+  console.log('Oh yay! My library module has been created!');
 })
 ```
 
@@ -91,7 +92,7 @@ createLibrary({
 ```javascript
 {
   name: String, /* The name of the library (Default: Library) */
-  prefix: String, /* The prefix for the library (Default: RN) */
+  prefix: String, /* The prefix for the library (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) */
   platforms: Array, /* Platforms the library will be created for. (Default: ['ios', 'android']) */
@@ -100,15 +101,11 @@ createLibrary({
   authorName: String, /* The author's name (Default: `Your Name`) */
   authorEmail: String, /* The author's email (Default: `yourname@email.com`) */
   license: String, /* The license type of this library (Default: `Apache-2.0`) */
-  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`) */
+  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) */
 }
 ```
 
-## SOME KNOWN ISSUES
-
-- CLI does not show the correct path of the generated library module
-
 ## Behavior not tested or supported
 
 - Windows platform support
@@ -123,7 +120,7 @@ __Create the module with no view:__
 create-react-native-module --prefix CB --package-identifier io.mylibrary --generate-example AliceHelper
 ```
 
-The module would be generated in the `react-native-alice-helper` subdirectory, and the example test app would be in `react-native-alice-helper/example`. (Note that this tool will show an incorrect project name when it is finished.)
+The module would be generated in the `react-native-alice-helper` subdirectory, and the example test app would be in `react-native-alice-helper/example`.
 
 Then go into the example app subdirectory:
 
@@ -182,7 +179,7 @@ __Create the module with an extremely simple view:__
 create-react-native-module --prefix CB --package-identifier io.mylibrary --view --generate-example CarolWidget
 ```
 
-The module would be generated in the `react-native-alice-helper` subdirectory, and the example test app would be in `react-native-alice-helper/example`. (Note that this tool will show an incorrect project name when it is finished.)
+The module would be generated in the `react-native-carol-widget` subdirectory, and the example test app would be in `react-native-carol-widget/example`.
 
 Then go into the example app subdirectory:
 

cli.js

@@ -9,6 +9,7 @@ const pkg = require('./package.json');
 updateNotifier({ pkg }).notify();
 
 program
+  .version(pkg.version)
   .usage(command.usage)
   .description(command.description)
   .action(function runAction () {

command.js

@@ -1,6 +1,8 @@
 const emoji = require('node-emoji');
 
-const createLibrary = require('./lib');
+const normalizedOptions = require('./normalized-options');
+
+const createLibraryModule = require('./lib');
 
 module.exports = {
   name: 'create-library',
@@ -21,7 +23,14 @@ module.exports = {
     const generateExample = options.generateExample;
 
     const beforeCreation = Date.now();
-    createLibrary({
+
+    // NOTE: There is a trick where the new normalizedOptions()
+    // from normalized-options.js is applied by both command.js & lib.js.
+    // This is to ensure that the CLI gets the correct module name for the
+    // final log message, and that the exported programmatic
+    // function can be completely tested from using the CLI.
+
+    const createOptions = normalizedOptions({
       name,
       prefix,
       moduleName,
@@ -34,13 +43,17 @@ module.exports = {
       license,
       view,
       generateExample,
-    }).then(() => {
+    });
+
+    const rootModuleName = createOptions.moduleName;
+
+    createLibraryModule(createOptions).then(() => {
       console.log(`
-${emoji.get('books')}  Created library module ${name} in \`./${name}\`.
+${emoji.get('books')}  Created library module ${rootModuleName} in \`./${rootModuleName}\`.
 ${emoji.get('clock9')}  It took ${Date.now() - beforeCreation}ms.
-${emoji.get('arrow_right')}  To get started type \`cd ./${name}\` and run \`npm install\``);
+${emoji.get('arrow_right')}  To get started type \`cd ./${rootModuleName}\` and run \`npm install\``);
     }).catch((err) => {
-      console.error(`Error while creating library module ${name}`);
+      console.error(`Error while creating library module ${rootModuleName}`);
 
       if (err.stack) {
         console.error(err.stack);
@@ -49,44 +62,44 @@ ${emoji.get('arrow_right')}  To get started type \`cd ./${name}\` and run \`npm
   },
   options: [{
     command: '--prefix [prefix]',
-    description: 'The prefix for the library module (Default: ``)',
+    description: 'The prefix for the library module',
     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: '--module-prefix [modulePrefix]',
-    description: 'The module prefix for the library module, ignored if --module-name is specified (Default: `react-native`)',
+    description: 'The module prefix for the library module, ignored if --module-name is specified',
     default: 'react-native',
   }, {
     command: '--package-identifier [packageIdentifier]',
-    description: '(Android only!) The package name for the Android module (Default: `com.reactlibrary`)',
+    description: '(Android only!) The package name for the Android module',
     default: 'com.reactlibrary',
   }, {
     command: '--platforms <platforms>',
-    description: 'Platforms the library module will be created for. (comma separated; default: `ios,android`)',
+    description: 'Platforms the library module will be created for - comma separated',
     default: 'ios,android',
   }, {
     command: '--github-account [githubAccount]',
-    description: 'The github account where the library module is hosted (Default: `github_account`)',
+    description: 'The github account where the library module is hosted',
     default: 'github_account',
   }, {
     command: '--author-name [authorName]',
-    description: 'The author\'s name (Default: `Your Name`)',
+    description: 'The author\'s name',
     default: 'Your Name',
   }, {
     command: '--author-email [authorEmail]',
-    description: 'The author\'s email (Default: `yourname@email.com`)',
+    description: 'The author\'s email',
     default: 'yourname@email.com',
   }, {
     command: '--license [license]',
-    description: 'The license type (Default: `Apache-2.0`)',
+    description: 'The license type',
     default: 'Apache-2.0',
   }, {
     command: '--view',
-    description: 'Generate the module as a very simple native view component (Default: `false`)',
+    description: 'Generate the module as a very simple native view component',
   }, {
     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 (Default: `false`)',
+    description: 'Generate an example project and links the library module to it, requires both react-native-cli and yarn to be installed globally',
   }]
 };