Add no-cycle eslint rule (#247)

* Enable no-cycle eslint rule

* Fix cyclic imports

* Change no-cycle to error

* Add changeset

Author: nicholas-l

.changeset/angry-points-live.md

@@ -0,0 +1,5 @@
+---
+"react-resource-router": patch
+---
+
+Remove cyclic imports and add eslint rule to stop future issues

.eslintrc.js

@@ -45,6 +45,7 @@ module.exports = {
     'react-hooks/exhaustive-deps': 'warn',
     'react-hooks/rules-of-hooks': 'error',
     semi: 'off',
+    'import/no-cycle': 'error',
   },
   overrides: [
     {

examples/routing-with-resources/about.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
 
+// eslint-disable-next-line import/no-cycle
 import { homeRoute } from './routes';
 
 import { Link, useQueryParam } from 'react-resource-router';

examples/routing-with-resources/home.tsx

@@ -1,5 +1,6 @@
 import React from 'react';
 
+// eslint-disable-next-line import/no-cycle
 import { aboutRoute } from './routes';
 
 import { Link } from 'react-resource-router';

examples/routing-with-resources/routes.tsx

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-cycle */
 import { About, aboutResource } from './about';
 import { Home, homeResource } from './home';
 

src/resources/controllers/resource-store/utils/get-resources-for-next-location/index.ts

@@ -1,4 +1,4 @@
-import { RouterContext } from '../../../../../index';
+import { type RouterContext } from '../../../../../index';
 import {
   ResourceStoreContext,
   RouteResource,

src/resources/controllers/use-resource/index.ts

@@ -1,19 +1,21 @@
 import { useCallback, useMemo } from 'react';
 import { createHook } from 'react-sweet-state';
 
+import { type RouterContext } from '../../../common/types';
 import {
-  RouterContext,
   RouterStore,
   useRouterStoreActions,
+} from '../../../controllers/router-store';
+import {
   type EntireRouterState,
   type AllRouterActions,
-} from '../../../index';
+} from '../../../controllers/router-store/types';
 import {
   RouteResource,
   RouteResourceResponse,
   RouteResourceUpdater,
   UseResourceHookResponse,
-} from '../../index';
+} from '../../common/types';
 import { useResourceStore, useResourceStoreActions } from '../resource-store';
 
 type UseResourceOptions = {

src/resources/plugin/index.ts

@@ -1,4 +1,4 @@
-import { Plugin, RouterContext } from '../../index';
+import type { Plugin, RouterContext } from '../../index';
 import type {
   ResourceStoreContext,
   RouteResourceResponse,