fix(core): rules do not run when told not to run; closes #102

- fix doc generation
- downgrade `typedoc-plugin-markdown`

package.json

@@ -62,7 +62,7 @@
     "sync-monorepo-packages": "^0.3.2",
     "syncpack": "^5.6.10",
     "typedoc": "^0.16.11",
-    "typedoc-plugin-markdown": "^2.4.2",
+    "typedoc-plugin-markdown": "2.2.17",
     "typescript": "^3.9.7",
     "unexpected": "^11.15.1",
     "unexpected-rxjs": "^0.2.4",

packages/core/src/observable.js

@@ -117,29 +117,6 @@ function toReport(opts = {}) {
     );
 }
 
-/**
- *
- * @param {object} [config] - Raw rule configuration
- * @returns {import('rxjs').OperatorFunction<import('@report-toolkit/inspector/src/rule').RuleDefinition,import('@report-toolkit/inspector/src/rule-config').RuleConfig>}
- */
-function toRuleConfig(config = {}) {
-  const ruleIdsCount = _.getOr(0, 'rules.length', config);
-  return ruleDefs =>
-    ruleDefs.pipe(
-      pipeIf(
-        !ruleIdsCount,
-        debug(() => 'enabling all rules by default')
-      ),
-      pipeIf(
-        ruleIdsCount,
-        filter(({id}) => Boolean(_.get(id, config.rules)))
-      ),
-      map(ruleDefinition =>
-        inspector.createRule(ruleDefinition).toRuleConfig(config)
-      )
-    );
-}
-
 /**
  *
  * @param {Partial<DiffOptions>} [opts]
@@ -163,6 +140,30 @@ function toReportDiff(opts = {}) {
     );
 }
 
+/**
+ *
+ * @param {object} [config] - Raw rule configuration
+ * @hidden
+ * @returns {import('rxjs').OperatorFunction<import('@report-toolkit/inspector/src/rule').RuleDefinition,import('@report-toolkit/inspector/src/rule-config').RuleConfig>}
+ */
+export function toRuleConfig(config = {}) {
+  const hasEnabledRules = _.some(Boolean, config.rules || {});
+  return ruleDefs =>
+    ruleDefs.pipe(
+      pipeIf(
+        !hasEnabledRules,
+        debug(() => 'enabling all rules by default')
+      ),
+      pipeIf(
+        hasEnabledRules,
+        filter(({id}) => Boolean(_.get(id, config.rules)))
+      ),
+      map(ruleDefinition =>
+        inspector.createRule(ruleDefinition).toRuleConfig(config)
+      )
+    );
+}
+
 /**
  * Returns the difference between two reports.
  *

packages/core/test/observable.spec.js

@@ -20,12 +20,10 @@ const REPORT_002_FILEPATH = require.resolve(
 );
 
 describe('@report-toolkit/core:observable', function () {
-  let sandbox;
   /**
    * @type {import('../src/observable')}
    */
   let core;
-  let subject;
 
   const msg001 = {
     filepath: REPORT_001_FILEPATH,
@@ -43,17 +41,22 @@ describe('@report-toolkit/core:observable', function () {
 
   let stubs;
 
+  let createRuleStub;
+
   beforeEach(function () {
-    sandbox = sinon.createSandbox();
+    createRuleStub = sinon
+      .stub()
+      .returns({toRuleConfig: sinon.stub().returns({some: 'config'})});
 
     stubs = {
       '@report-toolkit/inspector': {
-        inspectReports: sandbox
+        inspectReports: sinon
           .stub()
-          .returnsOperatorFunction(switchMapTo([msg001, msg002]))
+          .returnsOperatorFunction(switchMapTo([msg001, msg002])),
+        createRule: createRuleStub
       },
       '@report-toolkit/diff': {
-        diffReports: sandbox.stub().returnsOperatorFunction(
+        diffReports: sinon.stub().returnsOperatorFunction(
           switchMapTo([
             {
               oldValue: 45164,
@@ -73,7 +76,7 @@ describe('@report-toolkit/core:observable', function () {
       },
       '@report-toolkit/common': {
         config: {
-          parseConfig: sandbox.stub().returnsOperatorFunction(),
+          parseConfig: sinon.stub().returnsOperatorFunction(),
           BUILTIN_CONFIGS: config.BUILTIN_CONFIGS
         }
       }
@@ -83,7 +86,7 @@ describe('@report-toolkit/core:observable', function () {
   });
 
   afterEach(function () {
-    sandbox.restore();
+    sinon.restore();
   });
 
   describe('function', function () {
@@ -134,6 +137,8 @@ describe('@report-toolkit/core:observable', function () {
     });
 
     describe('inspect()', function () {
+      /** @type {typeof core.inspect} */
+      let subject;
       beforeEach(function () {
         subject = core.inspect;
       });
@@ -180,6 +185,9 @@ describe('@report-toolkit/core:observable', function () {
     });
 
     describe('use()', function () {
+      /** @type {typeof core.use} */
+      let subject;
+      /** @type {string} */
       let pluginPath;
 
       beforeEach(function () {
@@ -215,6 +223,7 @@ describe('@report-toolkit/core:observable', function () {
 
     describe('isPluginRegistered()', function () {
       let pluginPath;
+      /** @type {typeof core.isPluginRegistered} */
       let subject;
 
       beforeEach(function () {
@@ -240,6 +249,7 @@ describe('@report-toolkit/core:observable', function () {
     });
 
     describe('loadConfig()', function () {
+      /** @type {typeof core.loadConfig} */
       let subject;
       let cwd;
 
@@ -279,6 +289,7 @@ describe('@report-toolkit/core:observable', function () {
     });
 
     describe('fromTransformerChain()', function () {
+      /** @type {typeof core.fromTransformerChain} */
       let subject;
 
       beforeEach(function () {
@@ -337,6 +348,7 @@ describe('@report-toolkit/core:observable', function () {
     });
 
     describe('transform()', function () {
+      /** @type {typeof core.transform} */
       let subject;
 
       beforeEach(function () {
@@ -351,5 +363,29 @@ describe('@report-toolkit/core:observable', function () {
         );
       });
     });
+
+    describe('toRuleConfig()', function () {
+      /** @type {typeof core.toRuleConfig} */
+      let subject;
+
+      beforeEach(function () {
+        subject = core.toRuleConfig;
+      });
+
+      it('should generate a rule config for only enabled rules', async function () {
+        const ruleDefs = [
+          {id: 'foo', inspect: sinon.stub()},
+          {id: 'bar', inspect: sinon.stub()}
+        ];
+
+        await of(...ruleDefs)
+          .pipe(subject({rules: {foo: true, bar: false}}))
+          .toPromise();
+
+        expect(createRuleStub, 'to have no calls satisfying', [
+          ruleDefs[1]
+        ]).and('was called once');
+      });
+    });
   });
 });

packages/inspector/src/message.js

@@ -84,10 +84,14 @@ export const createMessage = (message, opts = {}) => {
  * @property {boolean} isAggregate - `true` if {@link Message} references multiple files
  * @property {Error} error - If present, an `Error` which was thrown by the Rule
  * @property {object} config - Rule configuration
- * @property {import('@report-toolkit/common/src/constants').ERROR|import('@report-toolkit/common/src/constants').WARNING|import('@report-toolkit/common/src/constants').INFO} severity - The severity of the {@link Message}
+ * @property {constants.ERROR|constants.WARNING|constants.INFO} severity - The severity of the {@link Message}
  * @property {string} message - The message text itself, if first param not passed to {@link Message.createMessage}.
  */
 
 /**
  * @typedef {string|Partial<MessageOptions>} RawMessage
  */
+
+/**
+ * @typedef {import('@report-toolkit/common/src/constants')} constants
+ */

packages/transformers/src/index.js

@@ -75,7 +75,7 @@ export const isKnownTransformer = id => Boolean(transformerModules[id]);
 export {Transformer};
 
 /**
- * @returns {OperatorFunction<TransformerConfig,Transformer>}
+ * @returns {OperatorFunction<TransformerConfig,Transformer<any,any>>}
  */
 export const toTransformer = () => observable =>
   observable.pipe(
@@ -91,7 +91,7 @@ export const toTransformer = () => observable =>
 /**
  *
  * @param {Partial<TransformOptions>} [opts]
- * @returns {OperatorFunction<Transformer,Transformer>}
+ * @returns {OperatorFunction<Transformer<any,any>,Transformer<any,any>>}
  */
 export const validateTransformerChain = ({
   beginWith = 'report',
@@ -148,7 +148,7 @@ export const validateTransformerChain = ({
  * @param {Observable<any>} source
  */
 export const runTransformer = source => /**
- * @param {Observable<Transformer>} observable
+ * @param {Observable<Transformer<any,any>>} observable
  */ observable =>
   observable.pipe(
     toArray(),

packages/transformers/src/transformer.js

@@ -66,8 +66,8 @@ class Transformer {
 
   /**
    * Pipe one Transformer to another
-   * @param {Transformer} transformer
-   * @returns {Transformer}
+   * @param {Transformer<any,any>} transformer
+   * @returns {Transformer<any,any>}
    */
   pipe(transformer) {
     if (!this.canPipeTo(transformer)) {
@@ -90,8 +90,8 @@ class Transformer {
 
   /**
    *
-   * @param {Transformer} transformer
-   * @returns {Transformer}
+   * @param {Transformer<any,any>} transformer
+   * @returns {Transformer<any,any>}
    */
   pipeFrom(transformer) {
     this._source = transformer;
@@ -100,7 +100,7 @@ class Transformer {
 
   /**
    * Returns `true` if this Transformer can pipe to another
-   * @param {Transformer} transformer - Transformer to compare
+   * @param {Transformer<any,any>} transformer - Transformer to compare
    */
   canPipeTo(transformer) {
     return _.includes(this.output, transformer.input);
@@ -182,5 +182,10 @@ export const createTransformer = Transformer.create;
 
 /**
  * @template T,U
- * @typedef {(opts?: object)=>import('rxjs/internal/types').OperatorFunction<T,U>} TransformFunction
+ * @typedef {import('rxjs/internal/types').OperatorFunction<T,U>} OperatorFunction<T,U>
+ */
+
+/**
+ * @template T,U
+ * @typedef {(opts?: object)=>OperatorFunction<T,U>} TransformFunction
  */

tsconfig.docs.json

@@ -12,18 +12,18 @@
     "packages/inspector/src/rule.d.ts",
     "packages/inspector/src/rule-config.d.ts",
     "packages/inspector/src/message.d.ts",
-    "packages/transformers/src/index.d.ts"
   ],
   "typedocOptions": {
     "exclude": [
+      "packages/common/diagnostic-report.d.ts",
       "packages/common/src/error*",
       "packages/common/src/debug*",
       "packages/common/src/index*",
       "packages/common/src/observable*",
       "packages/common/src/redact*",
       "packages/common/src/symbols*",
       "packages/common/src/util*",
-      "packages/diff,cli,fs,report-toolkit,config}/src/**/*",
+      "packages/diff,cli,fs,report-toolkit,config,transformers}/src/**/*",
       "packages/inspector/src/rules/*",
       "packages/inspector/src/ajv*",
       "packages/inspector/src/index*",