feat(tada): add Internal tools package (0no-co#149)

.changeset/two-mice-try.md

@@ -0,0 +1,7 @@
+---
+"@gql.tada/cli-utils": minor
+"@gql.tada/internal": minor
+"gql.tada": minor
+---
+
+Add `@gql.tada/internal` package to extract common logic between the CLI and the LSP

.gitignore

@@ -14,3 +14,4 @@ package-lock.json
 .netlify/
 /tsconfig.vitest-temp.json
 /cli
+/internal

package.json

@@ -32,11 +32,18 @@
       "require": "./dist/gql-tada-cli.js",
       "source": "./src/cli/index.ts"
     },
+    "./internal": {
+      "types": "./dist/gql-tada-internal.d.ts",
+      "import": "./dist/gql-tada-internal.mjs",
+      "require": "./dist/gql-tada-internal.js",
+      "source": "./src/internal/index.ts"
+    },
     "./package.json": "./package.json"
   },
   "dependencies": {
     "@0no-co/graphql.web": "^1.0.4",
-    "@gql.tada/cli-utils": "workspace:*"
+    "@gql.tada/cli-utils": "workspace:*",
+    "@gql.tada/internal": "workspace:*"
   },
   "public": true,
   "keywords": [

packages/cli-utils/package.json

@@ -41,14 +41,15 @@
   },
   "devDependencies": {
     "@types/node": "^20.11.0",
-    "comment-json": "^4.2.3",
+    "json5": "^2.2.3",
     "rollup": "^4.9.4",
     "sade": "^1.8.1",
     "type-fest": "^4.10.2",
     "typescript": "^5.3.3"
   },
   "dependencies": {
     "@urql/introspection": "^1.0.3",
+    "@gql.tada/internal": "workspace:*",
     "graphql": "^16.8.1"
   },
   "publishConfig": {

packages/cli-utils/src/index.ts

@@ -1,12 +1,11 @@
 import sade from 'sade';
-import { promises as fs, existsSync } from 'node:fs';
+import { promises as fs, existsSync, readFileSync } from 'node:fs';
 import path, { resolve } from 'node:path';
-// We use comment-json to parse the tsconfig as the default ones
-// have comment annotations in JSON.
-import { parse } from 'comment-json';
+import { parse } from 'json5';
 import type { IntrospectionQuery } from 'graphql';
 import { buildClientSchema, getIntrospectionQuery, printSchema } from 'graphql';
 import type { TsConfigJson } from 'type-fest';
+import { resolveTypeScriptRootDir } from '@gql.tada/internal';
 
 import type { GraphQLSPConfig } from './lsp';
 import { hasGraphQLSP } from './lsp';
@@ -126,7 +125,11 @@ export async function generateTadaTypes(cwd: string = process.cwd()) {
     return;
   }
 
-  const tsconfigContents = await fs.readFile(tsconfigpath, 'utf-8');
+  const root = resolveTypeScriptRootDir(
+    readFileSync as (path: string) => string | undefined,
+    tsconfigpath
+  );
+  const tsconfigContents = await fs.readFile(root || tsconfigpath, 'utf-8');
   let tsConfig: TsConfigJson;
   try {
     tsConfig = parse(tsconfigContents) as TsConfigJson;
@@ -140,7 +143,7 @@ export async function generateTadaTypes(cwd: string = process.cwd()) {
   }
 
   const foundPlugin = tsConfig.compilerOptions!.plugins!.find(
-    (plugin) => plugin.name === '@0no-co/graphqlsp'
+    (plugin) => plugin.name === '@0no-co/graphqlsp' || plugin.name === 'gql.tda/cli'
   ) as GraphQLSPConfig;
 
   await ensureTadaIntrospection(foundPlugin.schema, foundPlugin.tadaOutputLocation!, cwd);

packages/cli-utils/src/lsp.ts

@@ -18,7 +18,7 @@ export function hasGraphQLSP(tsconfig: TsConfigJson): boolean {
   }
 
   const foundPlugin = tsconfig.compilerOptions.plugins.find(
-    (plugin) => plugin.name === '@0no-co/graphqlsp'
+    (plugin) => plugin.name === '@0no-co/graphqlsp' || plugin.name === 'gql.tada/lsp'
   ) as GraphQLSPConfig | undefined;
   if (!foundPlugin) {
     console.warn('Missing @0no-co/graphqlsp plugin in tsconfig.json.');

packages/internal/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 0no.co
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/internal/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@gql.tada/internal",
+  "version": "0.0.0",
+  "public": true,
+  "description": "Internal logic for gql.tada’s CLI tool and GraphQLSP.",
+  "author": "0no.co <[email protected]>",
+  "sideEffects": false,
+  "source": "./src/index.ts",
+  "main": "./dist/gql-tada-internal",
+  "module": "./dist/gql-tada-internal.mjs",
+  "types": "./dist/gql-tada-internal.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/gql-tada-internal.d.ts",
+      "import": "./dist/gql-tada-internal.mjs",
+      "require": "./dist/gql-tada-internal.js",
+      "source": "./src/index.ts"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md",
+    "dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/0no-co/gql.tada.git",
+    "directory": "packages/internal"
+  },
+  "bugs": {
+    "url": "https://github.com/0no-co/gql.tada/issues"
+  },
+  "homepage": "https://gql-tada.0no.co/",
+  "license": "MIT",
+  "scripts": {
+    "build": "rollup -c ../../scripts/rollup.config.mjs",
+    "clean": "rimraf dist node_modules/.cache",
+    "prepublishOnly": "run-s clean build"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.0",
+    "json5": "^2.2.3",
+    "rollup": "^4.9.4",
+    "sade": "^1.8.1",
+    "type-fest": "^4.10.2",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@urql/introspection": "^1.0.3",
+    "graphql": "^16.8.1"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}

packages/internal/src/index.ts

@@ -0,0 +1 @@
+export { resolveTypeScriptRootDir } from './resolve';

packages/internal/src/resolve.ts

@@ -0,0 +1,33 @@
+import path from 'path';
+import JSON5 from 'json5';
+import type { TsConfigJson } from 'type-fest';
+
+export const resolveTypeScriptRootDir = (
+  readFile: (path: string) => string | undefined,
+  tsconfigPath: string
+): string | undefined => {
+  const tsconfigContents = readFile(tsconfigPath);
+  const parsed = JSON5.parse<TsConfigJson>(tsconfigContents!);
+
+  if (
+    parsed.compilerOptions &&
+    parsed.compilerOptions.plugins &&
+    parsed.compilerOptions.plugins.find(
+      (x) => x.name === '@0no-co/graphqlsp' || x.name === 'gql.tada/lsp'
+    )
+  ) {
+    return path.dirname(tsconfigPath);
+  } else if (Array.isArray(parsed.extends)) {
+    return parsed.extends.find((p) => {
+      const resolved = require.resolve(p, {
+        paths: [path.dirname(tsconfigPath)],
+      });
+      return resolveTypeScriptRootDir(readFile, resolved);
+    });
+  } else if (parsed.extends) {
+    const resolved = require.resolve(parsed.extends, {
+      paths: [path.dirname(tsconfigPath)],
+    });
+    return resolveTypeScriptRootDir(readFile, resolved);
+  }
+};

packages/internal/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src"]
+}

src/internal/index.ts

@@ -0,0 +1 @@
+export * from '@gql.tada/internal';