ESLint plugin - initial refactor + reintroduce test of graph with a s…

…ubgraph (#141)

* Move tests to a dedicated folder

* Build obsidian before eslint plugin + fix tsconfig in eslint plugin

* Move testUtils to tests folder + fix eslint warning in IDE

* Properly exclude tests from dist

* oopsie woopsie

* Mock file path resolving in tests + reintroduce subgraph test

package.json

@@ -3,7 +3,7 @@
   "scripts": {
     "test": "yarn workspaces foreach run test --colors",
     "lint": "yarn workspaces foreach run lint",
-    "build": "yarn workspaces foreach run build"
+    "build": "yarn workspace react-obsidian build && yarn workspace eslint-plugin-obsidian build"
   },
   "workspaces": [
     "packages/*"

packages/eslint-plugin-obsidian/jest.config.js

@@ -3,7 +3,7 @@ const config = {
   resetMocks: true,
   resetModules: true,
   roots: [
-    'rules',
+    'tests'
   ],
   testEnvironment: 'jsdom',
 };

packages/eslint-plugin-obsidian/package.json

@@ -4,7 +4,7 @@
   "main": "dist/index.js",
   "version": "2.5.0",
   "scripts": {
-    "build": "npx tsc",
+    "build": "npx tsc --project tsconfig.prod.json",
     "test": "npx jest",
     "lint": "eslint rules --ignore-pattern '*.d.ts' --ext .ts,.tsx,.js"
   },
@@ -15,7 +15,8 @@
     "LICENSE"
   ],
   "peerDependencies": {
-    "eslint": "8.x.x"
+    "eslint": "8.x.x",
+    "react-obsidian": "2.x.x"
   },
   "dependencies": {
     "@typescript-eslint/parser": "6.6.x",
@@ -48,7 +49,6 @@
     "eslint-plugin-unused-imports": "3.1.x",
     "jest": "29.5.x",
     "jest-extended": "^4.0.0",
-    "react-obsidian": "2.x.x",
     "typescript": "^4.5.4"
   },
   "keywords": [

packages/eslint-plugin-obsidian/rules/framework/pathResolver.ts

@@ -0,0 +1,8 @@
+import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+import path = require('path') ;
+
+export class PathResolver {
+  public resolve(context: RuleContext<any, any>, relativeFilePath: string) {
+    return path.join(path.dirname(context.getFilename()), `${relativeFilePath}.ts`);
+  }
+}

packages/eslint-plugin-obsidian/rules/index.ts

@@ -1,7 +1,7 @@
-const { unresolvedProviderDependencies } = require('./unresolvedProviderDependencies');
+const { unresolvedProviderDependenciesGenerator } = require('./unresolvedProviderDependencies');
 
 module.exports = {
   rules: {
-    'unresolved-provider-dependencies': unresolvedProviderDependencies,
+    'unresolved-provider-dependencies': unresolvedProviderDependenciesGenerator(),
   },
 };

packages/eslint-plugin-obsidian/rules/unresolvedProviderDependencies/ASTFunctions.ts

@@ -1,8 +1,8 @@
 import { TSESTree } from '@typescript-eslint/types';
 import * as fs from 'fs';
 import { parse } from '@typescript-eslint/parser';
-import path = require('path') ;
 import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+import { PathResolver } from '../framework/pathResolver';
 
 export type MessageIds = 'unresolved-provider-dependencies';
 
@@ -30,6 +30,7 @@ export function getDependenciesFromSubgraphs(
   imports: TSESTree.ImportDeclaration[],
   subGraphs:string[],
   context:RuleContext<'unresolved-provider-dependencies', []>,
+  pathResolver: PathResolver,
 ) {
   const paths:Record<string, string>[] = [];
   const dependencies: string[] = [];
@@ -42,8 +43,8 @@ export function getDependenciesFromSubgraphs(
   });
   paths.forEach((el) => {
     // eslint-disable-next-line dot-notation
-    const filePath = path.join(path.dirname(context.getFilename()), `${el['path']}.ts`);
-    const fileContent = fs.readFileSync(filePath, 'utf8');
+    const filePath = pathResolver.resolve(context, el['path']);
+    const fileContent = fs.readFileSync(filePath, { encoding: 'utf8'});
     const fileAST = parse(
       fileContent,
       {

packages/eslint-plugin-obsidian/rules/unresolvedProviderDependencies/createFunction.ts → packages/eslint-plugin-obsidian/rules/unresolvedProviderDependencies/createRule.ts

@@ -8,8 +8,12 @@ import {
   getDecoratorName,
   getPropertyDeclarations,
 } from './ASTFunctions';
+import type { PathResolver } from '../framework/pathResolver';
 
-export function create(context: RuleContext<'unresolved-provider-dependencies', []>) {
+export function create(
+  context: RuleContext<'unresolved-provider-dependencies', []>,
+  pathResolver: PathResolver,
+) {
   const imports:TSESTree.ImportDeclaration[] = [];
   const dependencies:string[] = [];
 
@@ -24,7 +28,7 @@ export function create(context: RuleContext<'unresolved-provider-dependencies',
         if (decoratorNames.includes('Graph')) {
           const subGraphs = getSubGraphs(decorators);
           if (subGraphs.length > 0) {
-            dependencies.push(...getDependenciesFromSubgraphs(imports, subGraphs, context));
+            dependencies.push(...getDependenciesFromSubgraphs(imports, subGraphs, context, pathResolver));
           }
           dependencies.push(...mapFunctions(node));
           dependencies.push(...getPropertyDeclarations(node));

packages/eslint-plugin-obsidian/rules/unresolvedProviderDependencies/index.ts

@@ -1,26 +1,33 @@
 import { ESLintUtils, type TSESLint } from '@typescript-eslint/utils';
-import { create } from './createFunction';
+import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+import { create } from './createRule';
+import { PathResolver } from '../framework/pathResolver';
+
+type Rule = TSESLint.RuleModule<'unresolved-provider-dependencies', []>;
 
 const createRule = ESLintUtils.RuleCreator(
   (name) => `https://wix-incubator.github.io/obsidian/docs/documentation/meta/eslint#${name}`,
 );
 
-type Rule = TSESLint.RuleModule<'unresolved-provider-dependencies', []>;
-
-
-export const unresolvedProviderDependencies: Rule = createRule({
-  create,
-  name: 'unresolved-provider-dependencies',
-  meta: {
-    docs: {
-      description: 'Dependencies must be defined in the graph or its subgraphs.',
-      recommended: 'strict',
+export const unresolvedProviderDependenciesGenerator = (
+  pathResolver: PathResolver = new PathResolver(),
+) => {
+  return createRule({
+    create: (context: RuleContext<'unresolved-provider-dependencies', []>) => {
+      return create(context, pathResolver);
     },
-    messages: {
-      'unresolved-provider-dependencies': 'Dependency {{ dependencyName }} is unresolved.',
+    name: 'unresolved-provider-dependencies',
+    meta: {
+      docs: {
+        description: 'Dependencies must be defined in the graph or its subgraphs.',
+        recommended: 'strict',
+      },
+      messages: {
+        'unresolved-provider-dependencies': 'Dependency {{ dependencyName }} is unresolved.',
+      },
+      schema: [],
+      type: 'problem',
     },
-    schema: [],
-    type: 'problem',
-  },
-  defaultOptions: [],
-});
+    defaultOptions: [],
+  }) satisfies Rule;
+};

packages/eslint-plugin-obsidian/tests/stubs/PathResolverStub.ts

@@ -0,0 +1,14 @@
+import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+import path = require('path') ;
+import { PathResolver } from '../../rules/framework/pathResolver';
+
+export class PathResolverStub implements PathResolver {
+  public resolve(context: RuleContext<any, any>, relativeFilePath: string): string {
+    switch(relativeFilePath) {
+      case './subgraph':
+        return `${context.cwd}/tests/unresolvedProviderDependencies/testUtils/subgraph.ts`;
+      default:
+        return path.join(path.dirname(context.getFilename()), `${relativeFilePath}.ts`);
+    }
+  }
+}

packages/eslint-plugin-obsidian/tests/unresolvedProviderDependencies/unresolvedDependencies.test.ts

@@ -0,0 +1,23 @@
+import { RuleTester } from '@typescript-eslint/rule-tester';
+import { validGraphSimple, validGraphWithSubgraph } from './testUtils/validGraphs';
+import { unresolvedProviderDependenciesGenerator } from '../../rules/unresolvedProviderDependencies';
+import { invalidGraph } from '../../rules/unresolvedProviderDependencies/invalidGraphs';
+import { PathResolverStub } from '../stubs/PathResolverStub';
+
+const ruleTester = new RuleTester();
+
+ruleTester.run(
+  'unresolved-provider-dependencies',
+  unresolvedProviderDependenciesGenerator(new PathResolverStub()),
+  {
+    valid: [validGraphSimple, validGraphWithSubgraph],
+    invalid: [
+      {
+        code: invalidGraph,
+        errors: [{
+          messageId: 'unresolved-provider-dependencies',
+        }],
+      },
+    ],
+  }
+);

packages/eslint-plugin-obsidian/tsconfig.json

@@ -1,6 +1,7 @@
 {
   "include": [
     "rules/**/*",
+    "tests/**/*",
     ".eslintrc.js",
   ],
   "exclude": [

packages/eslint-plugin-obsidian/tsconfig.prod.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "**/*.test.*",
+    "tests"
+  ]
+}

yarn.lock

@@ -4054,10 +4054,10 @@ __metadata:
     jest: 29.5.x
     jest-extended: ^4.0.0
     lodash: ^4.17.21
-    react-obsidian: 2.x.x
     typescript: ^4.5.4
   peerDependencies:
     eslint: 8.x.x
+    react-obsidian: 2.x.x
   languageName: unknown
   linkType: soft
 
@@ -6836,7 +6836,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"react-obsidian@2.x.x, react-obsidian@workspace:packages/react-obsidian":
+"react-obsidian@workspace:packages/react-obsidian":
   version: 0.0.0-use.local
   resolution: "react-obsidian@workspace:packages/react-obsidian"
   dependencies: