Merge pull request #2 from ElonVolo/rxjs

Adding support for logging rxjs pipe() stages

README.md

@@ -96,6 +96,45 @@ Passing in the __--named-functions-only__ flag to logitall command limits loggin
 
 This feature can be useful when you need an uncluttered, 50,000 ft view of what basic functions/methods are being called in your program.
 
+#### rxjs support
+
+logitall now has experimental support for adding logging statements to rxjs. When the --rxjs flag is passed to logitall, logging statements are inserted before and after each stage of an rxjs pipeline.
+
+For example, the following code:
+
+```
+import { of, pipe } from 'rxjs';
+import { map, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(
+    map(x => x + 1), 
+    filter(x => x > 2)
+);
+```
+
+is transformed into
+```
+import { of, pipe } from 'rxjs';
+import { map, tap, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(tap(x => {
+    console.log(
+        `[logitall]  Stage 0 value for rxjs pipe starting at line 4 in actual-rxjs-project/index.ts is:
+${x}\n`
+    );
+}), map(x => x + 1), tap(x => {
+    console.log(
+        `[logitall]  Stage 1 value for rxjs pipe starting at line 4 in actual-rxjs-project/index.ts is:
+${x}\n`
+    );
+}), filter(x => x > 2), tap(x => {
+    console.log(
+        `[logitall]  Final value for rxjs pipe starting at line 4 in actual-rxjs-project/index.ts is:
+${x}\n`
+    );
+}), );
+```
+
 #### Undoing logitall
 
 * The best, most safest way to use logitall is to make a complete duplicate of your project folder and run logitall on a copy of your code. 

__testfixtures__/rxjs-basic-existing-tap-import.input.ts

@@ -0,0 +1,7 @@
+import { of, pipe } from 'rxjs';
+import { map, tap, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(
+    map(x => x + 1), 
+    filter(x => x > 2)
+);

__testfixtures__/rxjs-basic-existing-tap-import.output.ts

@@ -0,0 +1,19 @@
+import { of, pipe } from 'rxjs';
+import { map, tap, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(tap(x => {
+    console.log(
+        `[logitall]  Stage 0 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic-existing-tap-import.input.ts is:
+${x}\n`
+    );
+}), map(x => x + 1), tap(x => {
+    console.log(
+        `[logitall]  Stage 1 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic-existing-tap-import.input.ts is:
+${x}\n`
+    );
+}), filter(x => x > 2), tap(x => {
+    console.log(
+        `[logitall]  Final value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic-existing-tap-import.input.ts is:
+${x}\n`
+    );
+}), );

__testfixtures__/rxjs-basic.input.ts

@@ -0,0 +1,7 @@
+import { of, pipe } from 'rxjs';
+import { map, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(
+    map(x => x + 1), 
+    filter(x => x > 2)
+);

__testfixtures__/rxjs-basic.output.ts

@@ -0,0 +1,20 @@
+import { tap } from "rxjs/operators";
+import { of, pipe } from 'rxjs';
+import { map, filter } from 'rxjs/operators';
+
+let myStream$ = of(7).pipe(tap(x => {
+    console.log(
+        `[logitall]  Stage 0 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic.input.ts is:
+${x}\n`
+    );
+}), map(x => x + 1), tap(x => {
+    console.log(
+        `[logitall]  Stage 1 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic.input.ts is:
+${x}\n`
+    );
+}), filter(x => x > 2), tap(x => {
+    console.log(
+        `[logitall]  Final value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-basic.input.ts is:
+${x}\n`
+    );
+}), );

__testfixtures__/rxjs-internal-tap-import.input.ts

@@ -0,0 +1,7 @@
+import { of, pipe } from 'rxjs';
+import { map, tap, filter } from 'rxjs/internal/operators';
+
+let myStream$ = of(7).pipe(
+    map(x => x + 1), 
+    filter(x => x > 2)
+);

__testfixtures__/rxjs-internal-tap-import.output.ts

@@ -0,0 +1,19 @@
+import { of, pipe } from 'rxjs';
+import { map, tap, filter } from 'rxjs/internal/operators';
+
+let myStream$ = of(7).pipe(tap(x => {
+    console.log(
+        `[logitall]  Stage 0 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-internal-tap-import.input.ts is:
+${x}\n`
+    );
+}), map(x => x + 1), tap(x => {
+    console.log(
+        `[logitall]  Stage 1 value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-internal-tap-import.input.ts is:
+${x}\n`
+    );
+}), filter(x => x > 2), tap(x => {
+    console.log(
+        `[logitall]  Final value for rxjs pipe starting at line 4 in __testfixtures__/rxjs-internal-tap-import.input.ts is:
+${x}\n`
+    );
+}), );

__tests__/transform-test.js

@@ -9,3 +9,6 @@ defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__'}, 'met
 defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__'}, 'method-instance', { 'parser': 'ts' });
 defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__'}, 'method-static', { 'parser': 'ts' });
 defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__'}, 'statement-expression', { 'parser': 'ts' });
+defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__', 'rxjs' : true }, 'rxjs-basic', { 'parser': 'ts' });
+defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__', 'rxjs' : true }, 'rxjs-basic-existing-tap-import', { 'parser': 'ts' });
+defineTest(__dirname + "../", 'transform', {'relpath': '__testfixtures__', 'rxjs' : true } , 'rxjs-internal-tap-import', { 'parser': 'ts' });

bin/logitall.js

@@ -11,6 +11,7 @@ commander
     .usage('(filepath | dirpath)')
     .option('--ignore-config <configfile>', 'a .gitignore-style list of file patterns to ignore')
     .option('--named-functions-only', 'only log non-anonymous functions and methods')
+    .option('--rxjs', 'support for adding logging to rxjs pipe stages')
     .arguments('<filepath>')
     .parse(process.argv)
 
@@ -35,7 +36,11 @@ if (commander.ignoreConfig) {
 }
 
 if (commander.namedFunctionsOnly) {
-    args.push('--named-functions-only')
+    args.push('--named-functions-only');
+}
+
+if (commander.rxjs) {
+    args.push('--rxjs');
 }
 
 args.push(`--relpath=${commander.args[2]}`);