Add lint for index imports (#1787)

Author: ChesterSim

.eslintrc.js

@@ -37,7 +37,16 @@ module.exports = {
 						// Restrict importing BN from bn.js
 						"group": ["bn.js"],
 						"message": "Import BN from @drift-labs/sdk instead",
-					}
+					},
+					{
+						// Prevent imports from index files within the same package
+						group: [
+							'**/index',
+							'**/index.ts',
+						],
+						message:
+							'Do not import from index file within the same package. Import directly from source files instead. This prevents barrel imports.',
+					},
 				],
 			},
 		],

sdk/src/events/types.ts

@@ -21,7 +21,7 @@ import {
 	FuelSeasonRecord,
 	InsuranceFundSwapRecord,
 	TransferProtocolIfSharesToRevenuePoolRecord,
-} from '../index';
+} from '../types';
 import { EventEmitter } from 'events';
 
 export type EventSubscriptionOptions = {

sdk/src/math/insurance.ts

@@ -1,6 +1,7 @@
 import { PERCENTAGE_PRECISION, ZERO } from '../constants/numericConstants';
-import { BN, SpotMarketAccount, SpotBalanceType } from '../index';
 import { getTokenAmount } from '../math/spotBalance';
+import { BN } from '@coral-xyz/anchor';
+import { SpotBalanceType, SpotMarketAccount } from '../types';
 
 export function nextRevenuePoolSettleApr(
 	spotMarket: SpotMarketAccount,

sdk/src/math/oracles.ts

@@ -1,4 +1,11 @@
-import { AMM, OracleGuardRails, isVariant } from '../types';
+import {
+	AMM,
+	HistoricalOracleData,
+	OracleGuardRails,
+	OracleSource,
+	PerpMarketAccount,
+	isVariant,
+} from '../types';
 import { OraclePriceData } from '../oracles/types';
 import {
 	BID_ASK_SPREAD_PRECISION,
@@ -9,13 +16,8 @@ import {
 	FIVE_MINUTE,
 	PERCENTAGE_PRECISION,
 } from '../constants/numericConstants';
-import {
-	BN,
-	HistoricalOracleData,
-	OracleSource,
-	PerpMarketAccount,
-} from '../index';
 import { assert } from '../assert/assert';
+import { BN } from '@coral-xyz/anchor';
 
 export function oraclePriceBands(
 	market: PerpMarketAccount,

sdk/src/orderSubscriber/OrderSubscriber.ts

@@ -13,12 +13,13 @@ import { PollingSubscription } from './PollingSubscription';
 import { WebsocketSubscription } from './WebsocketSubscription';
 import StrictEventEmitter from 'strict-event-emitter-types';
 import { EventEmitter } from 'events';
-import { calculateOrderBaseAssetAmount, ZERO } from '../index';
 import { BN } from '@coral-xyz/anchor';
 import { ProtectMakerParamsMap } from '../dlob/types';
 import { decodeUser } from '../decode/user';
 import { grpcSubscription } from './grpcSubscription';
 import { isUserProtectedMaker } from '../math/userStatus';
+import { calculateOrderBaseAssetAmount } from '../math/orders';
+import { ZERO } from '../constants/numericConstants';
 
 export class OrderSubscriber {
 	driftClient: DriftClient;

sdk/tests/bn/test.ts

@@ -1,4 +1,3 @@
-import { BN, numberToSafeBN } from '../../src/index';
 import { expect } from 'chai';
 import { BigNum } from '../../src/factory/bigNum';
 import {
@@ -7,6 +6,8 @@ import {
 	BASE_PRECISION_EXP,
 	TEN_THOUSAND,
 } from '../../src/constants/numericConstants';
+import { BN } from '@coral-xyz/anchor';
+import { numberToSafeBN } from '../../src/math/utils';
 
 // if you used the '@types/mocha' method to install mocha type definitions, uncomment the following line
 // import 'mocha';