fix(transformers): fix filter transformer when used with diff

enables configuration of default transformer to persist when used with a non-"terminal format" transformer, e.g., `diff -t filter` now works by retaining the table's default configuration (since `filter` is not a valid output format).
IBM · Jan 28, 2020 · 077ce49 · 077ce49
1 parent bbc9ceb
commit 077ce49
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 13 deletions.
diff --git a/packages/cli/src/commands/diff.js b/packages/cli/src/commands/diff.js
@@ -126,7 +126,10 @@ export const handler = argv => {
 
   fromTransformerChain(argv.transform, config)
     .pipe(
-      transform(source, {beginWith: 'object'}),
+      transform(source, {
+        beginWith: 'object',
+        defaultTransformerConfig: config.transformer.table
+      }),
       toOutput(argv.output, {color: argv.color})
     )
     .subscribe();

diff --git a/packages/cli/src/commands/inspect.js b/packages/cli/src/commands/inspect.js
@@ -92,6 +92,12 @@ export const handler = argv => {
     });
 
   fromTransformerChain(transformer, config)
-    .pipe(transform(source, {beginWith: 'object'}), toOutput(output, {color}))
+    .pipe(
+      transform(source, {
+        beginWith: 'object',
+        defaultTransformerConfig: config.transformer.table
+      }),
+      toOutput(output, {color})
+    )
     .subscribe();
 };
diff --git a/packages/cli/src/commands/list-rules.js b/packages/cli/src/commands/list-rules.js
@@ -53,13 +53,17 @@ export const handler = argv => {
     })),
     share()
   );
-  fromTransformerChain(
-    argv.transform,
-    mergeCommandConfig('list-rules', argv, DEFAULT_LIST_RULES_CONFIG)
-  )
+
+  const config = mergeCommandConfig(
+    'list-rules',
+    argv,
+    DEFAULT_LIST_RULES_CONFIG
+  );
+  fromTransformerChain(argv.transform, config)
     .pipe(
       transform(source, {
-        beginWith: 'object'
+        beginWith: 'object',
+        defaultTransformerConfig: config.transform.table
       }),
       toOutput(argv.output, {color: argv.color})
     )

diff --git a/packages/core/src/observable.js b/packages/core/src/observable.js
@@ -493,6 +493,7 @@ export function isPluginRegistered(pluginId) {
  * @property {string} beginWith - Begin transformer chain with this type
  * @property {string} endWith - End transformer chain with this type
  * @property {string} defaultTransformer - Default transformer
+ * @property {object} defaultTransformerConfig - Default transformer config
  */
 
 /**

diff --git a/packages/transformers/src/index.js b/packages/transformers/src/index.js
@@ -92,16 +92,14 @@ export const toTransformer = () => observable =>
 
 /**
  *
- * @param {Object} [opts] - Options
- * @param {string} [opts.beginWith=report] - Begin transform pipe with this type
- * @param {string} [opts.endWith=string] - End transform pipe with this type
- * @param {string} [opts.defaultTransformer] - Default transformer
+ * @param {Partial<TransformOptions>} [opts]
  * @returns {OperatorFunction<Transformer,Transformer>}
  */
 export const validateTransformerChain = ({
   beginWith = 'report',
   endWith = 'string',
-  defaultTransformer = DEFAULT_TRANSFORMER
+  defaultTransformer = DEFAULT_TRANSFORMER,
+  defaultTransformerConfig = {}
 } = {}) => observable =>
   observable.pipe(
     toArray(),
@@ -125,7 +123,9 @@ export const validateTransformerChain = ({
         }
 
         if (!transformers[transformers.length - 1].canEndWith(endWith)) {
-          transformers.push(loadTransformer(defaultTransformer));
+          transformers.push(
+            loadTransformer(defaultTransformer, defaultTransformerConfig)
+          );
         }
 
         let nextTransformer = transformers[++idx];
@@ -197,3 +197,12 @@ export const compatibleTransforms = sourceType =>
 /**
  * @typedef {{id: string, config: object}} TransformerConfig
  */
+
+/**
+ * for {@link validateTransformerChain}
+ * @typedef {object} TransformOptions
+ * @property {string} beginWith - Begin transformer chain with this type
+ * @property {string} endWith - End transformer chain with this type
+ * @property {string} defaultTransformer - Default transformer
+ * @property {object} defaultTransformerConfig - Default transformer config
+ */