chore: ban @trpc/*/src-style imports (trpc#5269)

argentlabs · Jan 6, 2024 · ad79cc8 · ad79cc8
1 parent 972c8be
commit ad79cc8
Show file tree

Hide file tree

Showing 86 changed files with 157 additions and 201 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -75,6 +75,18 @@ const config = {
       },
     ],
     'max-params': ['error', 3],
+    '@typescript-eslint/no-restricted-imports': [
+      'error',
+      {
+        patterns: [
+          {
+            group: ['@trpc/*/src'],
+            message: 'Remove the "`/src`" part of this import',
+            allowTypeImports: false,
+          },
+        ],
+      },
+    ],
   },
   overrides: [
     // {

diff --git a/.prettierignore b/.prettierignore
@@ -7,8 +7,6 @@ __generated__/
 dist/
 examples/next-big-router/src/server/routers/*.ts
 examples/.diagnostics/**/*
-packages/server/test/__packages.ts
-packages/tests/server/___packages.ts
 packages/tests/vendor/
 packages/coverage/
 pnpm-lock.yaml

diff --git a/package.json b/package.json
@@ -21,7 +21,7 @@
     "lint-fix": "turbo lint -- --fix && manypkg fix && pnpm format-fix",
     "format": "prettier \"**/*\" --ignore-unknown",
     "format-fix": "pnpm format --write --list-different",
-    "lint-prune": "! ts-prune | grep -v \"used in module\"",
+    "lint-prune": "! ts-prune | grep -v \"used in module\" | grep -v unstableInternalsExport.ts",
     "clean": "find . -name node_modules -o -name .turbo -o -name .next -o -name dist -o -name __generated__ -type d -prune | xargs rm -rf",
     "codegen:override-prisma": "tsx scripts/addPrismaOverrides.ts",
     "codegen:tests": "turbo codegen-tests",

diff --git a/packages/client/src/links/internals/createChain.test.ts b/packages/client/src/links/internals/createChain.test.ts
@@ -1,5 +1,5 @@
+import { AnyRouter } from '@trpc/server';
 import { observable } from '@trpc/server/observable';
-import { AnyRouter } from '@trpc/server/src';
 import { createChain } from './createChain';
 
 describe('chain', () => {

diff --git a/packages/client/src/links/internals/dedupeLink.test.ts b/packages/client/src/links/internals/dedupeLink.test.ts
@@ -1,6 +1,6 @@
 import { waitFor } from '@testing-library/dom';
-import { AnyRouter } from '@trpc/server/src';
-import { observable } from '@trpc/server/src/observable';
+import { AnyRouter } from '@trpc/server';
+import { observable } from '@trpc/server/observable';
 import { OperationLink } from '../..';
 import { createChain } from './createChain';
 import { dedupeLink } from './dedupeLink';

diff --git a/packages/server/src/unstableInternalsExport.ts b/packages/server/src/unstableInternalsExport.ts
@@ -1,3 +1,4 @@
+// ts-prune-ignore-next
 /**
  * These types have to be exported so users can generate their own types definitions files
  *

diff --git a/packages/tests/server/TRPCError.test.ts b/packages/tests/server/TRPCError.test.ts
@@ -1,4 +1,4 @@
-import { getTRPCErrorFromUnknown, TRPCError } from '@trpc/server/src';
+import { getTRPCErrorFromUnknown, TRPCError } from '@trpc/server';
 
 test('should extend original Error class', () => {
   const trpcError = new TRPCError({ code: 'FORBIDDEN' });

diff --git a/packages/tests/server/___packages.ts b/packages/tests/server/___packages.ts
diff --git a/packages/tests/server/___testHelpers.ts b/packages/tests/server/___testHelpers.ts
@@ -7,21 +7,17 @@ import {
   httpBatchLink,
   TRPCWebSocketClient,
   WebSocketClientOptions,
-} from '@trpc/client/src';
-import { WithTRPCConfig } from '@trpc/next/src';
-import { OnErrorFunction } from '@trpc/server/internals/types';
-import { AnyRouter as AnyNewRouter } from '@trpc/server/src';
+} from '@trpc/client';
+import { WithTRPCConfig } from '@trpc/next';
+import { AnyRouter as AnyNewRouter } from '@trpc/server';
 import {
   CreateHTTPHandlerOptions,
   createHTTPServer,
-} from '@trpc/server/src/adapters/standalone';
-import {
-  applyWSSHandler,
-  WSSHandlerOptions,
-} from '@trpc/server/src/adapters/ws';
+} from '@trpc/server/adapters/standalone';
+import { applyWSSHandler, WSSHandlerOptions } from '@trpc/server/adapters/ws';
+import { OnErrorFunction } from '@trpc/server/internals/types';
 import fetch from 'node-fetch';
 import { WebSocket, WebSocketServer } from 'ws';
-import './___packages';
 
 // This is a hack because the `server.close()` times out otherwise ¯\_(ツ)_/¯
 globalThis.fetch = fetch as any;

diff --git a/packages/tests/server/abortQuery.test.ts b/packages/tests/server/abortQuery.test.ts
@@ -1,5 +1,5 @@
 import { routerToServerAndClientNew, waitMs } from './___testHelpers';
-import { initTRPC } from '@trpc/server/src/core';
+import { initTRPC } from '@trpc/server/core';
 
 const t = initTRPC.create();
 

diff --git a/packages/tests/server/adapters/awsLambda.test.tsx b/packages/tests/server/adapters/awsLambda.test.tsx
@@ -1,5 +1,5 @@
-import { initTRPC } from '@trpc/server/src';
-import * as trpcLambda from '@trpc/server/src/adapters/aws-lambda';
+import { initTRPC } from '@trpc/server';
+import * as trpcLambda from '@trpc/server/adapters/aws-lambda';
 import type { APIGatewayProxyEvent, APIGatewayProxyEventV2 } from 'aws-lambda';
 import { z } from 'zod';
 import {

diff --git a/packages/tests/server/adapters/express.test.tsx b/packages/tests/server/adapters/express.test.tsx
@@ -1,11 +1,7 @@
 import http from 'http';
 import { Context, router } from './__router';
-import {
-  createTRPCClient,
-  httpBatchLink,
-  TRPCClientError,
-} from '@trpc/client/src';
-import * as trpcExpress from '@trpc/server/src/adapters/express';
+import { createTRPCClient, httpBatchLink, TRPCClientError } from '@trpc/client';
+import * as trpcExpress from '@trpc/server/adapters/express';
 import express from 'express';
 import fetch from 'node-fetch';
 

diff --git a/packages/tests/server/adapters/fastify.test.ts b/packages/tests/server/adapters/fastify.test.ts
@@ -9,14 +9,14 @@ import {
   TRPCLink,
   unstable_httpBatchStreamLink,
   wsLink,
-} from '@trpc/client/src';
+} from '@trpc/client';
 import { initTRPC } from '@trpc/server';
 import {
   CreateFastifyContextOptions,
   fastifyTRPCPlugin,
   FastifyTRPCPluginOptions,
-} from '@trpc/server/src/adapters/fastify';
-import { observable } from '@trpc/server/src/observable';
+} from '@trpc/server/adapters/fastify';
+import { observable } from '@trpc/server/observable';
 import fastify from 'fastify';
 import fp from 'fastify-plugin';
 import fetch from 'node-fetch';

diff --git a/packages/tests/server/adapters/fetch.test.ts b/packages/tests/server/adapters/fetch.test.ts
@@ -1,6 +1,6 @@
 // @vitest-environment miniflare
 /// <reference types="@cloudflare/workers-types" />
-import '../___packages';
+
 import { ReadableStream as MiniflareReadableStream } from 'stream/web';
 import { Response as MiniflareResponse } from '@miniflare/core';
 import {

diff --git a/packages/tests/server/adapters/next.test.ts b/packages/tests/server/adapters/next.test.ts
@@ -1,6 +1,6 @@
 import { EventEmitter } from 'events';
 import { initTRPC } from '@trpc/server';
-import * as trpcNext from '@trpc/server/src/adapters/next';
+import * as trpcNext from '@trpc/server/adapters/next';
 
 function mockReq({
   query,

diff --git a/packages/tests/server/adapters/standalone.test.ts b/packages/tests/server/adapters/standalone.test.ts
@@ -1,15 +1,11 @@
 import { AddressInfo } from 'net';
 import { networkInterfaces } from 'os';
-import {
-  createTRPCClient,
-  httpBatchLink,
-  TRPCClientError,
-} from '@trpc/client/src';
+import { createTRPCClient, httpBatchLink, TRPCClientError } from '@trpc/client';
 import { initTRPC, TRPCError } from '@trpc/server';
 import {
   CreateHTTPHandlerOptions,
   createHTTPServer,
-} from '@trpc/server/src/adapters/standalone';
+} from '@trpc/server/adapters/standalone';
 import fetch from 'node-fetch';
 import { z } from 'zod';
 

diff --git a/packages/tests/server/callRouter.test.ts b/packages/tests/server/callRouter.test.ts
@@ -1,4 +1,3 @@
-import './___packages';
 import { initTRPC } from '@trpc/server';
 
 // FIXME: should we deprecate this?

diff --git a/packages/tests/server/caller.test.ts b/packages/tests/server/caller.test.ts
@@ -1,5 +1,5 @@
 import { waitError } from './___testHelpers';
-import { initTRPC, TRPCError } from '@trpc/server/src';
+import { initTRPC, TRPCError } from '@trpc/server';
 import { z } from 'zod';
 
 const t = initTRPC

diff --git a/packages/tests/server/children.test.ts b/packages/tests/server/children.test.ts
@@ -1,5 +1,5 @@
 import { routerToServerAndClientNew } from './___testHelpers';
-import { initTRPC } from '@trpc/server/src';
+import { initTRPC } from '@trpc/server';
 
 test('children', async () => {
   const t = initTRPC.create();

diff --git a/packages/tests/server/clientInternals.test.ts b/packages/tests/server/clientInternals.test.ts
@@ -1,5 +1,5 @@
-import { getFetch } from '@trpc/client/src';
-import { getAbortController } from '@trpc/client/src/internals/getAbortController';
+import { getFetch } from '@trpc/client';
+import { getAbortController } from '@trpc/client/internals/getAbortController';
 
 describe('getAbortController() from..', () => {
   test('passed', () => {

diff --git a/packages/tests/server/createCaller.test.ts b/packages/tests/server/createCaller.test.ts
@@ -1,7 +1,6 @@
-import { z } from 'zod';
-import './___packages';
 import { ignoreErrors } from './___testHelpers';
-import { initTRPC } from '@trpc/server/src/core';
+import { initTRPC } from '@trpc/server/core';
+import { z } from 'zod';
 
 describe('with context', () => {
   const t = initTRPC.context<{ foo: 'foo' }>().create();

diff --git a/packages/tests/server/createClient.test.ts b/packages/tests/server/createClient.test.ts
@@ -1,4 +1,3 @@
-import './___packages';
 import { createTRPCClient, httpBatchLink } from '@trpc/client';
 
 global.fetch = vi.fn() as any;

diff --git a/packages/tests/server/createUntypedClient.test.ts b/packages/tests/server/createUntypedClient.test.ts
@@ -1,6 +1,6 @@
 import { ignoreErrors } from './___testHelpers';
-import { createTRPCUntypedClient } from '@trpc/client/src';
-import { Unsubscribable } from '@trpc/server/src/observable';
+import { createTRPCUntypedClient } from '@trpc/client';
+import { Unsubscribable } from '@trpc/server/observable';
 
 test('loosely typed parameters', () => {
   const client = createTRPCUntypedClient({

diff --git a/packages/tests/server/dataloader.test.ts b/packages/tests/server/dataloader.test.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-empty-function */
 import { waitError, waitMs } from './___testHelpers';
-import { dataLoader } from '@trpc/client/src/internals/dataLoader';
+import { dataLoader } from '@trpc/client/internals/dataLoader';
 
 describe('basic', () => {
   const fetchFn = vi.fn();

diff --git a/packages/tests/server/errorFormatting.test.ts b/packages/tests/server/errorFormatting.test.ts
@@ -6,7 +6,7 @@ import {
   initTRPC,
   TRPCError,
 } from '@trpc/server';
-import { DefaultErrorData } from '@trpc/server/src/error/formatter';
+import { DefaultErrorData } from '@trpc/server/error/formatter';
 import { konn } from 'konn';
 import { z, ZodError } from 'zod';
 

diff --git a/packages/tests/server/errors.test.ts b/packages/tests/server/errors.test.ts
@@ -7,13 +7,13 @@ import {
   httpLink,
   TRPCClientError,
   TRPCLink,
-} from '@trpc/client/src';
+} from '@trpc/client';
+import { initTRPC } from '@trpc/server';
+import { CreateHTTPContextOptions } from '@trpc/server/adapters/standalone';
+import { TRPCError } from '@trpc/server/error/TRPCError';
+import { getMessageFromUnknownError } from '@trpc/server/error/utils';
+import { OnErrorFunction } from '@trpc/server/internals/types';
 import { observable } from '@trpc/server/observable';
-import { initTRPC } from '@trpc/server/src';
-import { CreateHTTPContextOptions } from '@trpc/server/src/adapters/standalone';
-import { TRPCError } from '@trpc/server/src/error/TRPCError';
-import { getMessageFromUnknownError } from '@trpc/server/src/error/utils';
-import { OnErrorFunction } from '@trpc/server/src/internals/types';
 import { konn } from 'konn';
 import fetch from 'node-fetch';
 import { z, ZodError } from 'zod';

diff --git a/packages/tests/server/getRawInput.test.ts b/packages/tests/server/getRawInput.test.ts
@@ -1,6 +1,5 @@
-import { initTRPC, TRPCError } from '@trpc/server';
-import './___packages';
 import { waitError } from './___testHelpers';
+import { initTRPC, TRPCError } from '@trpc/server';
 
 test('middleware swap', async () => {
   const t = initTRPC.create();

diff --git a/packages/tests/server/getUntypedClient.test.ts b/packages/tests/server/getUntypedClient.test.ts
@@ -1,8 +1,7 @@
+import { routerToServerAndClientNew } from './___testHelpers';
 import { getUntypedClient, TRPCUntypedClient } from '@trpc/client';
 import { AnyRouter, initTRPC } from '@trpc/server';
 import { konn } from 'konn';
-import './___packages';
-import { routerToServerAndClientNew } from './___testHelpers';
 
 const ctx = konn()
   .beforeEach(() => {

diff --git a/packages/tests/server/headers.test.tsx b/packages/tests/server/headers.test.tsx
@@ -1,5 +1,5 @@
 import { routerToServerAndClientNew } from './___testHelpers';
-import { createTRPCClient, httpBatchLink, httpLink } from '@trpc/client/src';
+import { createTRPCClient, httpBatchLink, httpLink } from '@trpc/client';
 import { initTRPC } from '@trpc/server';
 import { Dict } from '@trpc/server/unstableInternalsExport';
 

diff --git a/packages/tests/server/index.test.ts b/packages/tests/server/index.test.ts
@@ -8,10 +8,10 @@ import {
   HTTPHeaders,
   TRPCClientError,
   wsLink,
-} from '@trpc/client/src';
+} from '@trpc/client';
 import { initTRPC, TRPCError } from '@trpc/server';
-import { CreateHTTPContextOptions } from '@trpc/server/src/adapters/standalone';
-import { observable } from '@trpc/server/src/observable';
+import { CreateHTTPContextOptions } from '@trpc/server/adapters/standalone';
+import { observable } from '@trpc/server/observable';
 import { Maybe } from '@trpc/server/unstableInternalsExport';
 import { z } from 'zod';
 

diff --git a/packages/tests/server/initTRPC.test.ts b/packages/tests/server/initTRPC.test.ts
@@ -2,7 +2,7 @@ import {
   DataTransformerOptions,
   DefaultDataTransformer,
   initTRPC,
-} from '@trpc/server/src';
+} from '@trpc/server';
 
 test('default transformer', () => {
   const t = initTRPC

diff --git a/packages/tests/server/isDev.test.ts b/packages/tests/server/isDev.test.ts
@@ -1,6 +1,6 @@
 import { routerToServerAndClientNew, waitError } from './___testHelpers';
-import { TRPCClientError } from '@trpc/client/src';
-import { initTRPC } from '@trpc/server/src';
+import { TRPCClientError } from '@trpc/client';
+import { initTRPC } from '@trpc/server';
 import { konn } from 'konn';
 
 const createTestContext = (opts: { isDev: boolean }) =>

diff --git a/packages/tests/server/links.test.ts b/packages/tests/server/links.test.ts
@@ -8,11 +8,11 @@ import {
   TRPCClientError,
   TRPCClientRuntime,
   unstable_httpBatchStreamLink,
-} from '@trpc/client/src';
-import { createChain } from '@trpc/client/src/links/internals/createChain';
-import { retryLink } from '@trpc/client/src/links/internals/retryLink';
-import { AnyRouter, initTRPC } from '@trpc/server/src';
-import { observable, observableToPromise } from '@trpc/server/src/observable';
+} from '@trpc/client';
+import { createChain } from '@trpc/client/links/internals/createChain';
+import { retryLink } from '@trpc/client/links/internals/retryLink';
+import { AnyRouter, initTRPC } from '@trpc/server';
+import { observable, observableToPromise } from '@trpc/server/observable';
 import { z } from 'zod';
 
 const mockRuntime: TRPCClientRuntime = {

diff --git a/packages/tests/server/meta.test.ts b/packages/tests/server/meta.test.ts
@@ -1,5 +1,5 @@
 import { routerToServerAndClientNew } from './___testHelpers';
-import { initTRPC } from '@trpc/server/src';
+import { initTRPC } from '@trpc/server';
 import { konn } from 'konn';
 
 test('meta is undefined in a middleware', () => {