@graphql-inspector/introspect-command 0.0.0-PLACEHOLDER

package/index.d.ts

@@ -0,0 +1,14 @@
+import { GlobalArgs, CommandFactory } from '@graphql-inspector/commands';
+import { GraphQLSchema } from 'graphql';
+export { CommandFactory };
+export declare function handler({ schema: unsortedSchema, output, comments, }: {
+    schema: GraphQLSchema;
+    output: string;
+    comments: boolean;
+}): void;
+declare const _default: CommandFactory<{}, {
+    schema: string;
+    write?: string | undefined;
+    comments?: boolean | undefined;
+} & GlobalArgs>;
+export default _default;

package/index.js

@@ -0,0 +1,83 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const tslib = require('tslib');
+const commands = require('@graphql-inspector/commands');
+const logger = require('@graphql-inspector/logger');
+const fs = require('fs');
+const path = require('path');
+const graphql = require('graphql');
+
+function handler({ schema: unsortedSchema, output, comments, }) {
+    const schema = graphql.lexicographicSortSchema(unsortedSchema);
+    const introspection = graphql.introspectionFromSchema(schema);
+    const filepath = path.resolve(process.cwd(), output);
+    let content;
+    switch (path.extname(output.toLowerCase())) {
+        case '.graphql':
+        case '.gql':
+        case '.gqls':
+        case '.graphqls':
+            content = graphql.printSchema(schema, {
+                commentDescriptions: comments,
+            });
+            break;
+        case '.json':
+            content = JSON.stringify(introspection, null, 2);
+            break;
+        default:
+            throw new Error('Only .graphql, .gql and .json files are supported');
+    }
+    fs.writeFileSync(output, content, {
+        encoding: 'utf-8',
+    });
+    logger.Logger.success(`Saved to ${filepath}`);
+}
+const index = commands.createCommand((api) => {
+    const { loaders } = api;
+    return {
+        command: 'introspect <schema>',
+        describe: 'Introspect a schema',
+        builder(yargs) {
+            return yargs
+                .positional('schema', {
+                describe: 'Point to a schema',
+                type: 'string',
+                demandOption: true,
+            })
+                .options({
+                w: {
+                    alias: 'write',
+                    describe: 'Write to a file',
+                    type: 'string',
+                },
+                comments: {
+                    describe: 'Use preceding comments as the description',
+                    type: 'boolean',
+                },
+            })
+                .default('w', 'graphql.schema.json');
+        },
+        handler(args) {
+            var _a;
+            return tslib.__awaiter(this, void 0, void 0, function* () {
+                const { headers, token } = commands.parseGlobalArgs(args);
+                const output = args.write;
+                const comments = args.comments || false;
+                const apolloFederation = args.federation || false;
+                const aws = args.aws || false;
+                const method = ((_a = args.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'POST';
+                const schema = yield loaders.loadSchema(args.schema, {
+                    token,
+                    headers,
+                    method,
+                }, apolloFederation, aws);
+                return handler({ schema, output, comments });
+            });
+        },
+    };
+});
+
+exports.default = index;
+exports.handler = handler;

package/index.mjs

@@ -0,0 +1,79 @@
+import { __awaiter } from 'tslib';
+import { createCommand, parseGlobalArgs } from '@graphql-inspector/commands';
+import { Logger } from '@graphql-inspector/logger';
+import { writeFileSync } from 'fs';
+import { resolve, extname } from 'path';
+import { lexicographicSortSchema, introspectionFromSchema, printSchema } from 'graphql';
+
+function handler({ schema: unsortedSchema, output, comments, }) {
+    const schema = lexicographicSortSchema(unsortedSchema);
+    const introspection = introspectionFromSchema(schema);
+    const filepath = resolve(process.cwd(), output);
+    let content;
+    switch (extname(output.toLowerCase())) {
+        case '.graphql':
+        case '.gql':
+        case '.gqls':
+        case '.graphqls':
+            content = printSchema(schema, {
+                commentDescriptions: comments,
+            });
+            break;
+        case '.json':
+            content = JSON.stringify(introspection, null, 2);
+            break;
+        default:
+            throw new Error('Only .graphql, .gql and .json files are supported');
+    }
+    writeFileSync(output, content, {
+        encoding: 'utf-8',
+    });
+    Logger.success(`Saved to ${filepath}`);
+}
+const index = createCommand((api) => {
+    const { loaders } = api;
+    return {
+        command: 'introspect <schema>',
+        describe: 'Introspect a schema',
+        builder(yargs) {
+            return yargs
+                .positional('schema', {
+                describe: 'Point to a schema',
+                type: 'string',
+                demandOption: true,
+            })
+                .options({
+                w: {
+                    alias: 'write',
+                    describe: 'Write to a file',
+                    type: 'string',
+                },
+                comments: {
+                    describe: 'Use preceding comments as the description',
+                    type: 'boolean',
+                },
+            })
+                .default('w', 'graphql.schema.json');
+        },
+        handler(args) {
+            var _a;
+            return __awaiter(this, void 0, void 0, function* () {
+                const { headers, token } = parseGlobalArgs(args);
+                const output = args.write;
+                const comments = args.comments || false;
+                const apolloFederation = args.federation || false;
+                const aws = args.aws || false;
+                const method = ((_a = args.method) === null || _a === void 0 ? void 0 : _a.toUpperCase()) || 'POST';
+                const schema = yield loaders.loadSchema(args.schema, {
+                    token,
+                    headers,
+                    method,
+                }, apolloFederation, aws);
+                return handler({ schema, output, comments });
+            });
+        },
+    };
+});
+
+export default index;
+export { handler };

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@graphql-inspector/introspect-command",
+  "version": "0.0.0-PLACEHOLDER",
+  "description": "Introspects GraphQL Schema",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "@graphql-inspector/commands": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/core": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/logger": "0.0.0-PLACEHOLDER",
+    "tslib": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/commands/introspect"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-inspector",
+    "graphql-inspector-command",
+    "tools"
+  ],
+  "author": {
+    "name": "Kamil Kisiela",
+    "email": "kamil.kisiela@gmail.com",
+    "url": "https://github.com/kamilkisiela"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}