Use the new no-circular-dependencies ESLint rule in the library (#159)

wix-incubator · Jul 10, 2024 · 625c5b8 · 625c5b8
1 parent d33f71b
commit 625c5b8
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 39 deletions.
diff --git a/packages/eslint-plugin-obsidian/src/index.ts b/packages/eslint-plugin-obsidian/src/index.ts
@@ -1,7 +1,9 @@
 const { unresolvedProviderDependenciesGenerator } = require('./rules/unresolvedProviderDependencies');
+const { noCircularDependenciesGenerator } = require('./rules/noCircularDependency');
 
 module.exports = {
  rules: {
  'unresolved-provider-dependencies': unresolvedProviderDependenciesGenerator(),
+ 'no-circular-dependencies': noCircularDependenciesGenerator(),
  },
 };
diff --git a/...ependency/circularDependenciesDetector.ts → ...ependency/circularDependenciesDetector.ts b/...ependency/circularDependenciesDetector.ts → ...ependency/circularDependenciesDetector.ts
diff --git a/...rc/rules/circularDependency/createRule.ts → .../rules/noCircularDependency/createRule.ts b/...rc/rules/circularDependency/createRule.ts → .../rules/noCircularDependency/createRule.ts
diff --git a/...rules/circularDependency/errorReporter.ts → ...les/noCircularDependency/errorReporter.ts b/...rules/circularDependency/errorReporter.ts → ...les/noCircularDependency/errorReporter.ts
@@ -10,7 +10,7 @@ export class ErrorReporter {
  if (error && node && path) {
  this.context.reportError(
  node,
- 'circular-dependencies',
+ 'no-circular-dependencies',
  {
  firstDependency: path[0],
  path: path.join(' -> '),

diff --git a/.../rules/circularDependency/graphHandler.ts → ...ules/noCircularDependency/graphHandler.ts b/.../rules/circularDependency/graphHandler.ts → ...ules/noCircularDependency/graphHandler.ts
diff --git a/...ian/src/rules/circularDependency/index.ts → ...n/src/rules/noCircularDependency/index.ts b/...ian/src/rules/circularDependency/index.ts → ...n/src/rules/noCircularDependency/index.ts
@@ -3,25 +3,25 @@ import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
 import { create } from './createRule';
 import {Context} from '../../dto/context';
 
-type Rule = TSESLint.RuleModule<'circular-dependencies', []>;
+type Rule = TSESLint.RuleModule<'no-circular-dependencies', []>;
 
 const createRule = ESLintUtils.RuleCreator(
  (name) => `https://wix-incubator.github.io/obsidian/docs/documentation/meta/eslint#${name}`,
 );
 
-export const circularDependenciesGenerator = () => {
+export const noCircularDependenciesGenerator = () => {
  return createRule({
- create: (context: RuleContext<'circular-dependencies', []>) => {
+ create: (context: RuleContext<'no-circular-dependencies', []>) => {
  return create(new Context(context));
  },
- name: 'circular-dependencies',
+ name: 'no-circular-dependencies',
  meta: {
  docs: {
  description: 'Dependencies must be defined in the graph or its subgraphs.',
  recommended: 'strict',
  },
  messages: {
- 'circular-dependencies': 'Circular dependency detected starting from {{firstDependency}}: {{path}}',
+ 'no-circular-dependencies': 'Circular dependency detected starting from {{firstDependency}}: {{path}}',
  },
  schema: [],
  type: 'problem',

diff --git a/packages/eslint-plugin-obsidian/tests/circularDependencies/circularDependencies.test.ts b/packages/eslint-plugin-obsidian/tests/circularDependencies/circularDependencies.test.ts
diff --git a/packages/eslint-plugin-obsidian/tests/noCircularDependencies/circularDependencies.test.ts b/packages/eslint-plugin-obsidian/tests/noCircularDependencies/circularDependencies.test.ts
@@ -0,0 +1,32 @@
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import { noCircularDependenciesGenerator } from '../../src/rules/noCircularDependency';
+import {
+ circularDependencyBetween3Providers,
+ circularDependencyBetweenSomeOfTheProviders,
+ invalidGraph,
+} from 'eslint-plugin-obsidian/tests/noCircularDependencies/code/invalidGraphs';
+import { validGraph } from 'eslint-plugin-obsidian/tests/noCircularDependencies/code/validGraphs';
+
+const ruleTester = new RuleTester();
+
+ruleTester.run(
+ 'no-circular-dependencies',
+ noCircularDependenciesGenerator(),
+ {
+ valid: [validGraph],
+ invalid: [
+ {
+ code: invalidGraph,
+ errors: [{ messageId: 'no-circular-dependencies' }],
+ },
+ {
+ code: circularDependencyBetween3Providers,
+ errors: [{ messageId: 'no-circular-dependencies' }],
+ },
+ {
+ code: circularDependencyBetweenSomeOfTheProviders,
+ errors: [{ messageId: 'no-circular-dependencies' }],
+ },
+ ],
+ },
+);
diff --git a/...ircularDependencies/code/invalidGraphs.ts → ...ircularDependencies/code/invalidGraphs.ts b/...ircularDependencies/code/invalidGraphs.ts → ...ircularDependencies/code/invalidGraphs.ts
diff --git a/.../circularDependencies/code/validGraphs.ts → ...oCircularDependencies/code/validGraphs.ts b/.../circularDependencies/code/validGraphs.ts → ...oCircularDependencies/code/validGraphs.ts
diff --git a/packages/react-obsidian/.eslintrc.json b/packages/react-obsidian/.eslintrc.json
@@ -29,7 +29,8 @@
  ],
  "rules": {
  "no-console":"off",
- "obsidian/unresolved-provider-dependencies": 2,
+ "obsidian/unresolved-provider-dependencies": "error",
+ "obsidian/no-circular-dependencies": "warn",
  "@stylistic/max-len": [
  "error",
  {