@sanity/groq-lint 0.0.1

package/dist/schema.js

@@ -0,0 +1,57 @@
+// src/schema.ts
+import { readSchema } from "@sanity/codegen";
+import { existsSync } from "fs";
+import { resolve } from "path";
+async function loadSchema(path) {
+  return readSchema(path);
+}
+var SCHEMA_CANDIDATES = [
+  "schema.json",
+  "sanity.schema.json",
+  ".sanity/schema.json",
+  "studio/schema.json"
+];
+function findSchemaPath(root = process.cwd()) {
+  for (const candidate of SCHEMA_CANDIDATES) {
+    const fullPath = resolve(root, candidate);
+    if (existsSync(fullPath)) {
+      return fullPath;
+    }
+  }
+  return null;
+}
+async function tryLoadSchema(root = process.cwd()) {
+  const schemaPath = findSchemaPath(root);
+  if (!schemaPath) {
+    return null;
+  }
+  try {
+    return await loadSchema(schemaPath);
+  } catch {
+    return null;
+  }
+}
+function getDocumentTypes(schema) {
+  return schema.filter((item) => item.type === "document").map((doc) => doc.name);
+}
+function getDocumentByType(schema, typeName) {
+  return schema.find(
+    (item) => item.type === "document" && item.name === typeName
+  );
+}
+function getFieldsForType(schema, typeName) {
+  const doc = getDocumentByType(schema, typeName);
+  if (!doc) {
+    return [];
+  }
+  return Object.keys(doc.attributes);
+}
+export {
+  findSchemaPath,
+  getDocumentByType,
+  getDocumentTypes,
+  getFieldsForType,
+  loadSchema,
+  tryLoadSchema
+};
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schema.ts"],"sourcesContent":["/**\n * Schema loading utilities for schema-aware GROQ linting.\n *\n * Uses @sanity/codegen's readSchema to load schema.json files\n * generated by `sanity schema extract`.\n */\n\nimport { readSchema } from '@sanity/codegen'\nimport type { SchemaType } from 'groq-js'\nimport { existsSync } from 'node:fs'\nimport { resolve } from 'node:path'\n\n/**\n * Load a schema from a JSON file path.\n *\n * @param path - Path to schema.json file\n * @returns The parsed schema\n * @throws If the file doesn't exist or is invalid\n */\nexport async function loadSchema(path: string): Promise<SchemaType> {\n  return readSchema(path)\n}\n\n/**\n * Common locations to look for schema.json files\n */\nconst SCHEMA_CANDIDATES = [\n  'schema.json',\n  'sanity.schema.json',\n  '.sanity/schema.json',\n  'studio/schema.json',\n]\n\n/**\n * Auto-discover a schema.json file in a project directory.\n *\n * Looks in common locations for schema files generated by\n * `sanity schema extract`.\n *\n * @param root - Project root directory (defaults to cwd)\n * @returns Path to schema file, or null if not found\n */\nexport function findSchemaPath(root: string = process.cwd()): string | null {\n  for (const candidate of SCHEMA_CANDIDATES) {\n    const fullPath = resolve(root, candidate)\n    if (existsSync(fullPath)) {\n      return fullPath\n    }\n  }\n  return null\n}\n\n/**\n * Try to load a schema from common locations.\n *\n * @param root - Project root directory (defaults to cwd)\n * @returns The schema if found, or null\n */\nexport async function tryLoadSchema(root: string = process.cwd()): Promise<SchemaType | null> {\n  const schemaPath = findSchemaPath(root)\n  if (!schemaPath) {\n    return null\n  }\n\n  try {\n    return await loadSchema(schemaPath)\n  } catch {\n    return null\n  }\n}\n\n/**\n * Get document type names from a schema.\n *\n * @param schema - The schema to extract document types from\n * @returns Array of document type names\n */\nexport function getDocumentTypes(schema: SchemaType): string[] {\n  return schema\n    .filter((item): item is Extract<typeof item, { type: 'document' }> => item.type === 'document')\n    .map((doc) => doc.name)\n}\n\n/**\n * Get a document definition by name from a schema.\n *\n * @param schema - The schema to search\n * @param typeName - The document type name (e.g., 'post')\n * @returns The document definition, or undefined\n */\nexport function getDocumentByType(\n  schema: SchemaType,\n  typeName: string\n): Extract<SchemaType[number], { type: 'document' }> | undefined {\n  return schema.find(\n    (item): item is Extract<typeof item, { type: 'document' }> =>\n      item.type === 'document' && item.name === typeName\n  )\n}\n\n/**\n * Get field names for a document type.\n *\n * @param schema - The schema to search\n * @param typeName - The document type name\n * @returns Array of field names, or empty array if type not found\n */\nexport function getFieldsForType(schema: SchemaType, typeName: string): string[] {\n  const doc = getDocumentByType(schema, typeName)\n  if (!doc) {\n    return []\n  }\n  return Object.keys(doc.attributes)\n}\n"],"mappings":";AAOA,SAAS,kBAAkB;AAE3B,SAAS,kBAAkB;AAC3B,SAAS,eAAe;AASxB,eAAsB,WAAW,MAAmC;AAClE,SAAO,WAAW,IAAI;AACxB;AAKA,IAAM,oBAAoB;AAAA,EACxB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAWO,SAAS,eAAe,OAAe,QAAQ,IAAI,GAAkB;AAC1E,aAAW,aAAa,mBAAmB;AACzC,UAAM,WAAW,QAAQ,MAAM,SAAS;AACxC,QAAI,WAAW,QAAQ,GAAG;AACxB,aAAO;AAAA,IACT;AAAA,EACF;AACA,SAAO;AACT;AAQA,eAAsB,cAAc,OAAe,QAAQ,IAAI,GAA+B;AAC5F,QAAM,aAAa,eAAe,IAAI;AACtC,MAAI,CAAC,YAAY;AACf,WAAO;AAAA,EACT;AAEA,MAAI;AACF,WAAO,MAAM,WAAW,UAAU;AAAA,EACpC,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAQO,SAAS,iBAAiB,QAA8B;AAC7D,SAAO,OACJ,OAAO,CAAC,SAA6D,KAAK,SAAS,UAAU,EAC7F,IAAI,CAAC,QAAQ,IAAI,IAAI;AAC1B;AASO,SAAS,kBACd,QACA,UAC+D;AAC/D,SAAO,OAAO;AAAA,IACZ,CAAC,SACC,KAAK,SAAS,cAAc,KAAK,SAAS;AAAA,EAC9C;AACF;AASO,SAAS,iBAAiB,QAAoB,UAA4B;AAC/E,QAAM,MAAM,kBAAkB,QAAQ,QAAQ;AAC9C,MAAI,CAAC,KAAK;AACR,WAAO,CAAC;AAAA,EACV;AACA,SAAO,OAAO,KAAK,IAAI,UAAU;AACnC;","names":[]}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@sanity/groq-lint",
+  "version": "0.0.1",
+  "description": "GROQ linting engine, rules, and CLI for Sanity Lint",
+  "author": "Sanity.io <hello@sanity.io>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sanity-io/sanity-lint.git",
+    "directory": "packages/groq-lint"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.ts",
+      "import": "./dist/schema.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "groq-lint": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@sanity/codegen": "^5.1.0",
+    "groq-js": "^1.14.0",
+    "@sanity/groq-wasm": "0.0.1",
+    "@sanity/lint-core": "0.0.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "keywords": [
+    "sanity",
+    "groq",
+    "lint",
+    "linter"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  }
+}