refactor(logging): use info for some more log output (#418)

* refactor: use info for some more log output * update some test scripts * update test snapshots
brody4hire · Feb 18, 2021 · d3e8047 · d3e8047
1 parent 784e07c
commit d3e8047
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 32 deletions.
diff --git a/lib/cli-command.js b/lib/cli-command.js
@@ -1,4 +1,4 @@
-const { log, error } = require('console');
+const { info, error } = require('console');
 
 const emoji = require('node-emoji');
 
@@ -71,7 +71,7 @@ module.exports = {
     const rootModuleName = createOptions.moduleName;
 
     return createLibraryModule(createOptions).then(() => {
-      log(`
+      info(`
 ${emoji.get('books')}  Created library module ${rootModuleName} in \`./${rootModuleName}\`.
 ${emoji.get('clock9')}  It took ${Date.now() - beforeCreation}ms.
 ${postCreateInstructions(createOptions)}`);

diff --git a/lib/lib.js b/lib/lib.js
@@ -4,7 +4,7 @@ const path = require('path');
 
 // External imports:
 
-const { log, info, warn, error } = require('console');
+const { info, warn, error } = require('console');
 
 // default execa object
 const execaDefault = require('execa');
@@ -274,7 +274,7 @@ exampleReactNativeVersion: ${exampleReactNativeVersion}
 
               // pod tool is needed at this point for iOS
               try {
-                log(
+                info(
                   `check for valid pod version in ${iosExampleAppProjectPath}`);
 
                 commandSync('pod --version', podCommandOptions);
@@ -283,7 +283,7 @@ exampleReactNativeVersion: ${exampleReactNativeVersion}
                 throw (e);
               }
 
-              log(`running pod install in ${iosExampleAppProjectPath}`);
+              info(`running pod install in ${iosExampleAppProjectPath}`);
 
               try {
                 commandSync('pod install', podCommandOptions);

diff --git a/...gus-platforms/bogus-name/__snapshots__/cli-command-with-bogus-platforms-name.test.js.snap b/...gus-platforms/bogus-name/__snapshots__/cli-command-with-bogus-platforms-name.test.js.snap
@@ -137,7 +137,7 @@ yarn-error.log
 ",
   },
   Object {
-    "log": Array [
+    "info": Array [
       "
 📚  Created library module react-native-alice-bobbi in \`./react-native-alice-bobbi\`.
 🕘  It took XXX.

diff --git a/...ith-logging/with-bogus-platforms/bogus-name/cli-command-with-bogus-platforms-name.test.js b/...ith-logging/with-bogus-platforms/bogus-name/cli-command-with-bogus-platforms-name.test.js
@@ -18,14 +18,13 @@ jest.mock('fs-extra', () => ({
 }));
 jest.mock('console', () => ({
   info: (...args) => {
-    mockpushit({ info: [].concat(args) });
-  },
-  log: (...args) => {
     mockpushit({
       // TBD EXTRA WORKAROUND HACK for non-deterministic elapsed time in log
-      log: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
+      info: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
     });
   },
+  // console.log is no longer expected
+  // log: (...args) => ...
   warn: (...args) => {
     mockpushit({ warn: [].concat(args) });
   },

diff --git a/...platforms/empty-string/__snapshots__/cli-command-with-empty-platforms-string.test.js.snap b/...platforms/empty-string/__snapshots__/cli-command-with-empty-platforms-string.test.js.snap
@@ -137,7 +137,7 @@ yarn-error.log
 ",
   },
   Object {
-    "log": Array [
+    "info": Array [
       "
 📚  Created library module react-native-alice-bobbi in \`./react-native-alice-bobbi\`.
 🕘  It took XXX.

diff --git a/...logging/with-bogus-platforms/empty-string/cli-command-with-empty-platforms-string.test.js b/...logging/with-bogus-platforms/empty-string/cli-command-with-empty-platforms-string.test.js
@@ -18,14 +18,13 @@ jest.mock('fs-extra', () => ({
 }));
 jest.mock('console', () => ({
   info: (...args) => {
-    mockpushit({ info: [].concat(args) });
-  },
-  log: (...args) => {
     mockpushit({
       // TBD EXTRA WORKAROUND HACK for non-deterministic elapsed time in log
-      log: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
+      info: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
     });
   },
+  // console.log is no longer expected
+  // log: (...args) => ...
   warn: (...args) => {
     mockpushit({ warn: [].concat(args) });
   },

diff --git a/...i/command/action-func/with-logging/with-error/cli-command-with-logging-with-error.test.js b/...i/command/action-func/with-logging/with-error/cli-command-with-logging-with-error.test.js
@@ -16,14 +16,13 @@ jest.mock('fs-extra', () => ({
 }));
 jest.mock('console', () => ({
   info: (...args) => {
-    mockpushit({ info: [].concat(args) });
-  },
-  log: (...args) => {
     mockpushit({
       // TBD EXTRA WORKAROUND HACK for non-deterministic elapsed time in log
-      log: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
+      info: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
     });
   },
+  // console.log is no longer expected
+  // log: (...args) => ...
   warn: (...args) => {
     mockpushit({ warn: [].concat(args) });
   },

diff --git a/...ith-example/with-logging/__snapshots__/cli-program-with-example-with-logging.test.js.snap b/...ith-example/with-logging/__snapshots__/cli-program-with-example-with-logging.test.js.snap
@@ -1180,7 +1180,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "check for valid pod version in ./react-native-test-package/example/ios",
     ],
   },
@@ -1192,7 +1192,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "running pod install in ./react-native-test-package/example/ios",
     ],
   },
@@ -1204,7 +1204,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "
 📚  Created library module react-native-test-package in \`./react-native-test-package\`.
 🕘  It took XXX.

diff --git a/...mocks/cli/program/with-example/with-logging/cli-program-with-example-with-logging.test.js b/...mocks/cli/program/with-example/with-logging/cli-program-with-example-with-logging.test.js
@@ -73,14 +73,13 @@ jest.mock('execa', () => ({
 }));
 jest.mock('console', () => ({
   info: (...args) => {
-    mockpushit({ info: [].concat(args) });
-  },
-  log: (...args) => {
     mockpushit({
       // TBD EXTRA WORKAROUND HACK for non-deterministic elapsed time in log
-      log: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
+      info: args.map(line => line.replace(/It took.*s/g, 'It took XXX'))
     });
   },
+  // console.log is no longer expected
+  // log: (...args) => ...
   warn: (...args) => {
     mockpushit({ warn: [].concat(args) });
   },

diff --git a/...e/with-logging/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap b/...e/with-logging/with-defaults/__snapshots__/create-with-example-with-defaults.test.js.snap
@@ -966,7 +966,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "check for valid pod version in ./react-native-alice-bobbi/example/ios",
     ],
   },
@@ -978,7 +978,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "running pod install in ./react-native-alice-bobbi/example/ios",
     ],
   },

diff --git a/...null-options/with-null-prefix/__snapshots__/create-with-example-with-options.test.js.snap b/...null-options/with-null-prefix/__snapshots__/create-with-example-with-options.test.js.snap
@@ -966,7 +966,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "check for valid pod version in ./react-native-alice-bobbi/example/ios",
     ],
   },
@@ -978,7 +978,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "running pod install in ./react-native-alice-bobbi/example/ios",
     ],
   },

diff --git a/...ple/with-logging/with-options/__snapshots__/create-with-example-with-options.test.js.snap b/...ple/with-logging/with-options/__snapshots__/create-with-example-with-options.test.js.snap
@@ -1071,7 +1071,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "check for valid pod version in ./react-native-alice-bobbi/demo/ios",
     ],
   },
@@ -1083,7 +1083,7 @@ const styles = StyleSheet.create({
     },
   },
   Object {
-    "log": Array [
+    "info": Array [
       "running pod install in ./react-native-alice-bobbi/demo/ios",
     ],
   },