{"id":17835,"library":"node-graphqxl","title":"GraphQXL Node Wrapper","description":"node-graphqxl is a JavaScript/TypeScript development dependency that provides a Node.js wrapper for the GraphQXL compiler. GraphQXL itself is an extension of the GraphQL Schema Definition Language (SDL) designed to facilitate the creation of large and scalable server-side GraphQL schemas by introducing features like inheritance, generics, and imports, which are typically found in programming languages. This package (currently at version 0.40.2) makes the `graphqxl` command-line interface (CLI) binary available within Node.js projects, allowing developers to compile `.graphqxl` schema files into standard GraphQL SDL. It is a build-time tool, not a runtime library for executing GraphQL queries. The primary use case is in schema-first GraphQL development workflows, enabling enhanced schema modularity and reusability. As a 0.x.x versioned project, it should be noted that the API and behavior may evolve rapidly.","status":"active","version":"0.40.2","language":"javascript","source_language":"en","source_url":null,"tags":["javascript"],"install":[{"cmd":"npm install node-graphqxl","lang":"bash","label":"npm"},{"cmd":"yarn add node-graphqxl","lang":"bash","label":"yarn"},{"cmd":"pnpm add node-graphqxl","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[],"quickstart":{"code":"{\n  \"name\": \"my-graphqxl-project\",\n  \"version\": \"1.0.0\",\n  \"description\": \"A project using GraphQXL for schema definition.\",\n  \"main\": \"index.js\",\n  \"scripts\": {\n    \"generate:schema\": \"graphqxl src/schema.graphqxl > dist/schema.graphql\",\n    \"start\": \"node src/server.js\"\n  },\n  \"keywords\": [],\n  \"author\": \"\",\n  \"license\": \"ISC\",\n  \"devDependencies\": {\n    \"node-graphqxl\": \"^0.40.2\"\n  }\n}\n// src/schema.graphqxl (example content)\n// type User {\n//   id: ID!\n//   name: String!\n// }\n//\n// type Query {\n//   users: [User!]\n// }\n\n// To run this example, save the above JSON in package.json and the commented out content in src/schema.graphqxl.\n// Then run: npm install && npm run generate:schema","lang":"javascript","description":"Demonstrates how to integrate the GraphQXL compiler into your project's build scripts to generate a GraphQL schema file."},"warnings":[{"fix":"Always invoke `graphqxl` via the CLI (e.g., `npx graphqxl` or `npm run script_name`). Do not attempt to `import { compile } from 'node-graphqxl'` as such an API does not exist.","message":"node-graphqxl is primarily a CLI wrapper. It provides the `graphqxl` executable to your `node_modules/.bin` path and is intended for use in `package.json` scripts or direct CLI calls. There is no public programmatic JavaScript API for compiling GraphQXL schemas directly within your Node.js code.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Pin exact versions (e.g., `\"node-graphqxl\": \"0.40.2\"`) or use caret ranges carefully (`^0.40.2`) and review release notes thoroughly before updating. Consider using a lockfile (npm-lockfile.json or yarn.lock) to ensure consistent builds.","message":"As a pre-1.0.0 project (version 0.x.x), `node-graphqxl` and the underlying GraphQXL language are subject to frequent breaking changes between minor and patch releases. Always check release notes when upgrading.","severity":"breaking","affected_versions":">=0.1.0"},{"fix":"Understand that `node-graphqxl` is a build step. Your application still requires a GraphQL execution engine (like `@apollo/server` or `graphql-yoga`) to serve the compiled schema.","message":"GraphQXL is a compile-time language extension for GraphQL SDL, not a runtime library. It compiles `.graphqxl` files into standard `.graphql` SDL, which then needs to be used by a separate GraphQL server library (e.g., Apollo Server, Express GraphQL) to serve an API.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"last_verified":"2026-04-23T00:00:00.000Z","next_check":"2026-07-22T00:00:00.000Z","problems":[{"fix":"Ensure you are running the command through `npx graphqxl` or define it as a script in your `package.json` (e.g., `\"scripts\": { \"compile\": \"graphqxl src/schema.graphqxl\" }`) and then execute with `npm run compile` or `yarn compile`.","cause":"The `graphqxl` executable is installed as a `devDependency` and is typically accessed via `npx` or `package.json` scripts. It's not added to your global PATH by default.","error":"command not found: graphqxl"},{"fix":"Carefully review the specified line and column in your `.graphqxl` file. Consult the GraphQXL documentation (github.com/gabotechs/graphqxl) for correct syntax, especially for features like inheritance, generics, or imports.","cause":"This indicates a syntax error or a semantic issue within your `.graphqxl` schema file that prevents the compiler from converting it to valid GraphQL SDL.","error":"Error: Failed to compile GraphQXL schema: ... (followed by parsing errors)"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}