refactor!: rename --view to --is-view; update help & doc (#439)

Chris Brody · web-flow · commit 310ec78709a1 · 2021-03-17T14:38:05.000-04:00
* refactor!: rename --view option to --is-view
* update view tests
* document --is-view as EXPERIMENTAL, with limited testing
* update help text for --is-view option with Status: EXPERIMENTAL (...)
* update test snapshot

BREAKING CHANGE: affects any user generating a view module from either
the CLI or the programmatic usage API.
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ Options:
 
   -V, --version                             output the version number
   --package-name <packageName>              The full package name to be used in package.json. Default: react-native-(name in param-case)
-  --view                                    Generate the package as a very simple native view component
+  --is-view                                 Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.
   --object-class-name                       The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase)
   --native-package-id <nativePackageId>     [Android] The native Java package identifier used for Android (Default: `com.reactlibrary`)
   --platforms <platforms>                   Platforms the library module will be created for - comma separated (Default: `ios,android`)
@@ -130,7 +130,7 @@ createLibraryModule({
 {
   name: String, /* The name of the library (mandatory) */
   packageName: String, /* The full package name to be used in package.json. Default: react-native-(name in param-case) */
-  view: Boolean, /* Generate the package as a very simple native view component (Default: false) */
+  isView: Boolean, /* Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing. (Default: false) */
   objectClassName: String, /* The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase) */
   platforms: Array | String, /* Platforms the library will be created for. (Default: ['android', 'ios']) */
   nativePackageId: String, /* [Android] The native Java package identifier used for Android (Default: `com.reactlibrary`) */
@@ -227,10 +227,12 @@ The example app shows the following indications:
 
 ### Example view module
 
+EXPERIMENTAL feature with limited testing
+
 __Create the module with an extremely simple view:__
 
 ```console
-create-react-native-module --package-identifier io.mylibrary --view --generate-example CarolWidget
+create-react-native-module --package-identifier io.mylibrary --is-view --generate-example CarolWidget
 ```
 
 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`.
diff --git a/lib/cli-command.js b/lib/cli-command.js
@@ -87,8 +87,8 @@ ${postCreateInstructions(createOptions)}`);
     command: '--package-name [packageName]',
     description: 'The full package name to be used in package.json. Default: react-native-(name in param-case)',
   }, {
-    command: '--view',
-    description: 'Generate the package as a very simple native view component',
+    command: '--is-view',
+    description: 'Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.',
   }, {
     command: '--object-class-name [objectClassName]',
     description: 'The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase)',
diff --git a/lib/lib.js b/lib/lib.js
@@ -79,7 +79,7 @@ const generateWithNormalizedOptions = ({
   authorName = DEFAULT_AUTHOR_NAME,
   authorEmail = DEFAULT_AUTHOR_EMAIL,
   license = DEFAULT_LICENSE,
-  view = false,
+  isView = false,
   useAppleNetworking = false,
   generateExample = DEFAULT_GENERATE_EXAMPLE,
   exampleFileLinkage = false,
@@ -105,7 +105,7 @@ const generateWithNormalizedOptions = ({
 
                         name: ${name}
            full package name: ${packageName}
-                     is view: ${view}
+                     is view: ${isView}
            object class name: ${objectClassName}
      Android nativePackageId: ${nativePackageId}
                    platforms: ${platforms}
@@ -169,7 +169,7 @@ const generateWithNormalizedOptions = ({
           authorName,
           authorEmail,
           license,
-          view,
+          isView,
           useAppleNetworking,
         };
 
@@ -205,7 +205,7 @@ const generateWithNormalizedOptions = ({
           const templateArgs = {
             packageName,
             objectClassName,
-            view,
+            isView,
             useAppleNetworking,
             exampleFileLinkage,
             exampleName,
diff --git a/templates/android.js b/templates/android.js
@@ -160,11 +160,11 @@ afterEvaluate { project ->
 `,
 }, {
   // for module without view:
-  name: ({ objectClassName, nativePackageId, view }) =>
-    !view &&
+  name: ({ objectClassName, nativePackageId, isView }) =>
+    !isView &&
       `${platform}/src/main/java/${nativePackageId.split('.').join('/')}/${objectClassName}Module.java`,
-  content: ({ objectClassName, nativePackageId, view }) =>
-    !view &&
+  content: ({ objectClassName, nativePackageId, isView }) =>
+    !isView &&
       `// ${objectClassName}Module.java
 
 package ${nativePackageId};
@@ -197,11 +197,11 @@ public class ${objectClassName}Module extends ReactContextBaseJavaModule {
 `,
 }, {
   // manager for view:
-  name: ({ objectClassName, nativePackageId, view }) =>
-    view &&
+  name: ({ objectClassName, nativePackageId, isView }) =>
+    isView &&
       `${platform}/src/main/java/${nativePackageId.split('.').join('/')}/${objectClassName}Manager.java`,
-  content: ({ objectClassName, nativePackageId, view }) =>
-    view &&
+  content: ({ objectClassName, nativePackageId, isView }) =>
+    isView &&
       `// ${objectClassName}Manager.java
 
 package ${nativePackageId};
@@ -233,11 +233,11 @@ public class ${objectClassName}Manager extends SimpleViewManager<View> {
 `,
 }, {
   // package for module without view:
-  name: ({ objectClassName, nativePackageId, view }) =>
-    !view &&
+  name: ({ objectClassName, nativePackageId, isView }) =>
+    !isView &&
       `${platform}/src/main/java/${nativePackageId.split('.').join('/')}/${objectClassName}Package.java`,
-  content: ({ objectClassName, nativePackageId, view }) =>
-    !view &&
+  content: ({ objectClassName, nativePackageId, isView }) =>
+    !isView &&
       `// ${objectClassName}Package.java
 
 package ${nativePackageId};
@@ -265,11 +265,11 @@ public class ${objectClassName}Package implements ReactPackage {
 `,
 }, {
   // package for manager for view:
-  name: ({ objectClassName, nativePackageId, view }) =>
-    view &&
+  name: ({ objectClassName, nativePackageId, isView }) =>
+    isView &&
       `${platform}/src/main/java/${nativePackageId.split('.').join('/')}/${objectClassName}Package.java`,
-  content: ({ objectClassName, nativePackageId, view }) =>
-    view &&
+  content: ({ objectClassName, nativePackageId, isView }) =>
+    isView &&
       `// ${objectClassName}Package.java
 
 package ${nativePackageId};
diff --git a/templates/example.js b/templates/example.js
@@ -189,7 +189,7 @@ module.exports = {
 `,
 }, {
   name: ({ exampleName }) => `${exampleName}/App.js`,
-  content: ({ packageName, objectClassName, view }) =>
+  content: ({ packageName, objectClassName, isView }) =>
     `/**
  * Sample React Native App
  *
@@ -203,7 +203,7 @@ module.exports = {
 import React, { Component } from 'react';
 import { Platform, StyleSheet, Text, View } from 'react-native';
 import ${objectClassName} from '${packageName}';` +
-    (!view
+    (!isView
       ? `
 
 export default class App extends Component<{}> {
diff --git a/templates/general.js b/templates/general.js
@@ -77,7 +77,7 @@ ${objectClassName};
   }
 }, {
   // for module without view:
-  name: ({ view }) => !view && 'index.js',
+  name: ({ isView }) => !isView && 'index.js',
   content: ({ objectClassName }) =>
     `// main index.js
 
@@ -89,7 +89,7 @@ export default ${objectClassName};
 `,
 }, {
   // for module with view:
-  name: ({ view }) => view && 'index.js',
+  name: ({ isView }) => isView && 'index.js',
   content: ({ objectClassName }) =>
     `// main index.js
 
diff --git a/templates/ios.js b/templates/ios.js
@@ -34,7 +34,7 @@ end
 `,
 }, {
   // header for module without view:
-  name: ({ objectClassName, view }) => !view && `${platform}/${objectClassName}.h`,
+  name: ({ objectClassName, isView }) => !isView && `${platform}/${objectClassName}.h`,
   content: ({ objectClassName }) => `// ${objectClassName}.h
 
 #import <React/RCTBridgeModule.h>
@@ -45,7 +45,7 @@ end
 `,
 }, {
   // implementation of module without view:
-  name: ({ objectClassName, view }) => !view && `${platform}/${objectClassName}.m`,
+  name: ({ objectClassName, isView }) => !isView && `${platform}/${objectClassName}.m`,
   content: ({ objectClassName, useAppleNetworking }) => `// ${objectClassName}.m
 
 #import "${objectClassName}.h"
@@ -79,7 +79,7 @@ RCT_EXPORT_METHOD(sampleMethod:(NSString *)stringArgument numberParameter:(nonnu
 `,
 }, {
   // header for module with view:
-  name: ({ objectClassName, view }) => view && `${platform}/${objectClassName}.h`,
+  name: ({ objectClassName, isView }) => isView && `${platform}/${objectClassName}.h`,
   content: ({ objectClassName }) => `// ${objectClassName}.h
 
 #import <React/RCTViewManager.h>
@@ -90,7 +90,7 @@ RCT_EXPORT_METHOD(sampleMethod:(NSString *)stringArgument numberParameter:(nonnu
 `,
 }, {
   // implementation of module with view:
-  name: ({ objectClassName, view }) => view && `${platform}/${objectClassName}.m`,
+  name: ({ objectClassName, isView }) => isView && `${platform}/${objectClassName}.m`,
   content: ({ objectClassName }) => `// ${objectClassName}.m
 
 #import "${objectClassName}.h"
diff --git a/tests/integration/cli/create/view/cli-create-with-view.test.js b/tests/integration/cli/create/view/cli-create-with-view.test.js
@@ -15,7 +15,7 @@ test('CLI creates correct view module package artifacts on file system using `--
   // remove test artifacts just in case:
   await fs.remove(modulePackageName);
 
-  await execa.command(`node ${path.resolve('bin/cli.js')} --view ${name}`);
+  await execa.command(`node ${path.resolve('bin/cli.js')} --is-view ${name}`);
 
   const filesUnsorted = await readdirs(modulePackageName);
 
diff --git a/tests/integration/cli/help/__snapshots__/cli-help.test.js.snap b/tests/integration/cli/help/__snapshots__/cli-help.test.js.snap
@@ -8,7 +8,7 @@ creates a React Native library module for one or more platforms
 Options:
   -V, --version                                                 output the version number
   --package-name [packageName]                                  The full package name to be used in package.json. Default: react-native-(name in param-case)
-  --view                                                        Generate the package as a very simple native view component
+  --is-view                                                     Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.
   --object-class-name [objectClassName]                         The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase)
   --native-package-id [nativePackageId]                         [Android] The native Java package identifier used for Android (default: \\"com.reactlibrary\\")
   --platforms <platforms>                                       Platforms the library module will be created for - comma separated (default: \\"ios,android\\")
diff --git a/tests/integration/cli/noargs/__snapshots__/cli-noargs.test.js.snap b/tests/integration/cli/noargs/__snapshots__/cli-noargs.test.js.snap
@@ -8,7 +8,7 @@ creates a React Native library module for one or more platforms
 Options:
   -V, --version                                                 output the version number
   --package-name [packageName]                                  The full package name to be used in package.json. Default: react-native-(name in param-case)
-  --view                                                        Generate the package as a very simple native view component
+  --is-view                                                     Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.
   --object-class-name [objectClassName]                         The name of the object class to be exported by both JavaScript and native code. Default: (name in PascalCase)
   --native-package-id [nativePackageId]                         [Android] The native Java package identifier used for Android (default: \\"com.reactlibrary\\")
   --platforms <platforms>                                       Platforms the library module will be created for - comma separated (default: \\"ios,android\\")
diff --git a/tests/with-injection/cli/command/object/__snapshots__/lib-cli-command-object-text.test.js.snap b/tests/with-injection/cli/command/object/__snapshots__/lib-cli-command-object-text.test.js.snap
@@ -11,8 +11,8 @@ Object {
       "description": "The full package name to be used in package.json. Default: react-native-(name in param-case)",
     },
     Object {
-      "command": "--view",
-      "description": "Generate the package as a very simple native view component",
+      "command": "--is-view",
+      "description": "Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.",
     },
     Object {
       "command": "--object-class-name [objectClassName]",
diff --git a/tests/with-injection/create/view/with-defaults/create-view-with-defaults.test.js b/tests/with-injection/create/view/with-defaults/create-view-with-defaults.test.js
@@ -9,7 +9,7 @@ test('create alice-bobbi view module with defaults', () => {
 
   const options = {
     name: 'alice-bobbi',
-    view: true,
+    isView: true,
   };
 
   return lib(options, inject)
diff --git a/tests/with-injection/create/view/with-example/with-defaults/create-view-with-example-with-defaults.test.js b/tests/with-injection/create/view/with-example/with-defaults/create-view-with-example-with-defaults.test.js
@@ -10,7 +10,7 @@ test('create alice-bobbi view module with example, with defaults', () => {
   const options = {
     name: 'alice-bobbi',
     generateExample: true,
-    view: true,
+    isView: true,
   };
 
   return lib(options, inject)
diff --git a/tests/with-injection/create/view/with-example/with-options/create-view-with-example-with-options.test.js b/tests/with-injection/create/view/with-example/with-options/create-view-with-example-with-options.test.js
@@ -14,7 +14,7 @@ test('create alice-bobbi view module with example, with custom config options',
     authorName: 'Alice',
     authorEmail: 'contact@alice.me',
     license: 'ISC',
-    view: true,
+    isView: true,
     generateExample: true,
     exampleName: 'test-demo',
     exampleReactNativeTemplate: 'react-native@0.60',
diff --git a/tests/with-injection/create/view/with-options/for-android/lib-view-android-config-options.test.js b/tests/with-injection/create/view/with-options/for-android/lib-view-android-config-options.test.js
@@ -14,7 +14,7 @@ test('create alice-bobbi view module with config options for Android only', () =
     authorName: 'Alice',
     authorEmail: 'contact@alice.me',
     license: 'ISC',
-    view: true,
+    isView: true,
   };
 
   return lib(options, inject)
diff --git a/tests/with-injection/create/view/with-options/for-ios/create-view-with-options-for-ios.test.js b/tests/with-injection/create/view/with-options/for-ios/create-view-with-options-for-ios.test.js
@@ -15,7 +15,7 @@ test('create alice-bobbi view module with config options for iOS only', () => {
     authorName: 'Alice',
     authorEmail: 'contact@alice.me',
     license: 'ISC',
-    view: true,
+    isView: true,
   };
 
   return lib(options, inject)
diff --git a/tests/with-mocks/cli/program/with-defaults/for-android/__snapshots__/cli-program-with-defaults-for-android.test.js.snap b/tests/with-mocks/cli/program/with-defaults/for-android/__snapshots__/cli-program-with-defaults-for-android.test.js.snap
@@ -40,8 +40,8 @@ Array [
   Object {
     "option": Object {
       "args": Array [
-        "--view",
-        "Generate the package as a very simple native view component",
+        "--is-view",
+        "Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.",
         [Function],
         undefined,
       ],
diff --git a/tests/with-mocks/cli/program/with-example/with-logging/__snapshots__/cli-program-with-example-with-logging.test.js.snap b/tests/with-mocks/cli/program/with-example/with-logging/__snapshots__/cli-program-with-example-with-logging.test.js.snap
@@ -40,8 +40,8 @@ Array [
   Object {
     "option": Object {
       "args": Array [
-        "--view",
-        "Generate the package as a very simple native view component",
+        "--is-view",
+        "Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.",
         [Function],
         undefined,
       ],
diff --git a/tests/with-mocks/cli/program/with-missing-args/__snapshots__/cli-program-with-missing-args.test.js.snap b/tests/with-mocks/cli/program/with-missing-args/__snapshots__/cli-program-with-missing-args.test.js.snap
@@ -38,8 +38,8 @@ Array [
   Object {
     "option": Object {
       "args": Array [
-        "--view",
-        "Generate the package as a very simple native view component",
+        "--is-view",
+        "Generate the package as a very simple native view component. Status: EXPERIMENTAL, with limited testing.",
         [Function],
         undefined,
       ],
