Circular dependency error when using recommended

[woodrunner]

Describe the bug
When I lint a project of mine that contains your recommended plugin I get a circular dependency error:

nx run bo-modules-empty-modules:lint

Linting "bo-modules-empty-modules"...

NX Converting circular structure to JSON

--> starting at object with constructor 'Object'
| property '@smarttools/rxjs' -> object with constructor 'Object'
| property 'configs' -> object with constructor 'Object'
| property 'recommended' -> object with constructor 'Object'
--- property 'plugins' closes the circle
Referenced from: /Users/davinja/Documents/WgkProjects/front-end/tools/eslint-plugin-wgk/typescript/eslintrc.js

If I manually add the recommended rules to my project it works. So this means that the problem is located in your library.

const rxjsRules = {
  '@smarttools/rxjs/no-async-subscribe': 'error',
  ...
};

module.exports = [
  {
    plugins: {
      '@smarttools/rxjs': rxjs,
    },
    rules: {
      ...rxjsRules,
    },
  },
];

I located the circular dependency by logging a util.inspect for your library:

const util = require('util');
const rxjs = require('@smarttools/eslint-plugin-rxjs');

console.log(util.inspect(rxjs, { depth: null }));

In this output you can see the cause of the circular dependency:

configs: {
  recommended: {
    plugins: { '@smarttools/rxjs': [Circular *1] }, // Circular reference
    rules: {
      // rules here...
    }
  }
}

The plugins key in the recommended configuration is set to { '@smarttools/rxjs': [Circular *1] } which refers back to the main plugin object (rxjs) itself.

I fixed this issue by removing this redundant plugins property both index.ts and recommended.ts.

index.ts:

if (plugin.configs) {
  Object.assign(plugin.configs, {
    recommended: {
      name: '@smarttools/rxjs/recommended',
      rules: {
        ...recommended.rules,
      },
    },
    'recommended-legacy': recommended,
  });
}

recommended.ts:

import { Linter } from '@typescript-eslint/utils/ts-eslint';

export = {
  rules: {
    '@smarttools/rxjs/no-async-subscribe': 'error',
    ...
  } as Linter.RulesRecord,
};

Repro
Version of @smarttools/eslint-plugin-rxjs you are using: 1.0.13

[DaveMBush]

I tried to replicate the problem here https://github.com/DaveMBush/eslint-plugin-rxjs/tree/dmb/circular-dependency-error-when-using-recommended/49/tests/using-recommended and I don't see the circular dependency issue (even though I admit it is probably there). I would like to be able to produce a test that replicates this issue, but for that I need to know more about what you are doing. Could you create a small sample in a repository I can access so I can create the test please?

[woodrunner]

I reproduced the error on this stackblitz:
https://stackblitz.com/~/github.com/woodrunner/angular-eslint-bug?branch=recommended-circular-bug

I think it has something to do with the external eslintrc.js file of mine.

[DaveMBush]

This has been addressed in 1.0.16