@graphql-inspector/cli 0.0.0-PLACEHOLDER

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Kamil Kisiela
+
+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.

package/README.md

@@ -0,0 +1,264 @@
+# GraphQL Inspector
+
+[![npm version](https://badge.fury.io/js/%40graphql-inspector%2Fcli.svg)](https://npmjs.com/package/@graphql-inspector/cli)
+
+**GraphQL Inspector** ouputs a list of changes between two GraphQL schemas. Every change is precisely explained and marked as breaking, non-breaking or dangerous.
+It helps you validate documents and fragments against a schema and even find similar or duplicated types.
+
+![Example](./demo.gif)
+
+## Features
+
+Major features:
+
+- **Compares schemas**
+- **Finds breaking or dangerous changes**
+- **Validates documents against a schema**
+- **Finds similar / duplicated types**
+- **Schema coverage based on documents**
+- **Serves a GraphQL server with faked data and GraphQL Playground**
+- **GitHub Bot**
+- **GitHub Actions**
+
+GraphQL Inspector has a **CLI** and also a **programatic API**, so you can use it however you want to and even build tools on top of it.
+
+## Installation
+
+```bash
+# CLI
+yarn add @graphql-inspector/cli
+
+# Core API for programatic usage
+yarn add @graphql-inspector/core
+```
+
+### Compare schemas
+
+Compares schemas and finds breaking or dangerous changes.
+
+**CLI:**
+
+    $ graphql-inspector diff OLD_SCHEMA NEW_SCHEMA
+
+**API:**
+
+```typescript
+import { diff, Change } from '@graphql-inspector/core'
+
+const changes: Change[] = diff(schemaA, schemaB)
+```
+
+![Diff](https://raw.githubusercontent.com/kamilkisiela/graphql-inspector/master/assets/diff.jpg)
+
+### Find similar types
+
+Finds similar / duplicated types.
+
+**CLI:**
+
+    $ graphql-inspector similar SCHEMA
+
+**API:**
+
+```typescript
+import { similar, SimilarMap } from '@graphql-inspector/core'
+
+const similar: SimilarMap = similar(schema, typename, threshold)
+```
+
+![Similar](https://raw.githubusercontent.com/kamilkisiela/graphql-inspector/master/assets/similar.jpg)
+
+### Check coverage
+
+Schema coverage based on documents. Find out how many times types and fields are used in your application.
+
+**CLI:**
+
+    $ graphql-inspector coverage DOCUMENTS SCHEMA
+
+**API:**
+
+```typescript
+import { coverage, SchemaCoverage } from '@graphql-inspector/core'
+
+const schemaCoverage: SchemaCoverage = coverage(schema, documents)
+```
+
+![Coverage](https://raw.githubusercontent.com/kamilkisiela/graphql-inspector/master/assets/coverage.jpg)
+
+### Validate documents
+
+Validates documents against a schema and looks for deprecated usage.
+
+**CLI:**
+
+    $ graphql-inspector validate DOCUMENTS SCHEMA
+
+**API:**
+
+```typescript
+import { validate, InvalidDocument } from '@graphql-inspector/core'
+
+const invalid: InvalidDocument[] = validate(documentsGlob, schema)
+```
+
+![Validate](https://raw.githubusercontent.com/kamilkisiela/graphql-inspector/master/assets/validate.jpg)
+
+### Serve faked GraphQL API
+
+Serves a GraphQL server with faked data and GraphQL Playground
+
+**CLI:**
+
+    $ graphql-inspector serve SCHEMA
+
+```bash
+✅ Serving the GraphQL API on http://localhost:4000/
+```
+
+### Introspect GraphQL server
+
+Introspects a GraphQL Server and writes the result to a file
+
+**CLI:**
+
+    $ graphql-inspector introspect SCHEMA --write schema.json
+
+```bash
+✅ Introspection result saved to schema.json
+```
+
+### GitHub Bot and GitHub Actions
+
+Have a per-repository, self-hosted GraphQL Inspector service or deploy it with Docker.
+
+```bash
+# install
+yarn global add @graphql-inspector/actions
+
+# use
+
+$ graphql-inspector-github
+```
+
+```json
+{
+  "name": "app",
+  "scripts": {
+    "precommit": "graphql-inspector introspect schema.js --write schema.graphql && git add schema.graphql"
+  },
+  "graphql-inspector": {
+    "diff": true,
+    "schema": {
+      "ref": "master",
+      "path": "schema.graphql"
+    }
+  }
+}
+```
+
+Get GitHub annotations in your PRs.
+
+![GitHub](https://raw.githubusercontent.com/kamilkisiela/graphql-inspector/master/assets/github.jpg)
+
+### CLI in more details
+
+### `SCHEMA`
+
+**Path to a CommonJS or ES Module that exports an object**
+
+Example:
+
+    graphql-inspector coverage ./src/schema.js
+
+Example with TypeScript:
+
+    graphql-inspector coverage ./src/schema.ts --require ts-node/register
+
+```typescript
+// String
+export default `
+  type Query {
+    hello: String
+  }
+`
+
+// GraphQLSchema
+export default makeExecutableSchema({...});
+
+// GraphQL Document
+export default gql`
+  type Query {
+    hello: String
+  }
+`
+
+// IntrospectionQuery result
+export default {
+  data: {
+    __schema: {
+      ...
+    }
+  }
+}
+```
+
+**Pointer to a Git repository**
+
+Example:
+
+    graphql-inspector diff git:origin/master:schema.graphql
+
+Pattern:
+
+    git:ref:path/to/file
+
+**Pointer to a GitHub repository**
+
+Example:
+
+    graphql-inspector coverage github:kamilkisiela/graphql-inspector-example#master:schema.graphql
+
+Pattern:
+
+    github:owner/name#ref:path/to/file
+
+**GraphQL File**
+
+Example:
+
+    graphql-inspector coverage schema.graphql
+    graphql-inspector coverage schema.gql
+
+**JSON File**
+
+Example:
+
+    graphql-inspector coverage introspected-schema.json
+
+**URL to a GraphQL endpoint**
+
+Example:
+
+    graphql-inspector coverage https://localhost:3000/graphql
+
+### `DOCUMENTS`
+
+**Glob pattern**
+
+Example:
+
+    graphql-inspector validate ./src/**/*.{js,jsx,tsx,graphql} https://localhost:3000/graphql
+
+Supports TypeScript, JavaScript and GraphQL Files (_Extensions: ts,tsx,js,jsx,graphql,gql,graphqls_).
+
+### Help
+
+Find out what the CLI is capable of:
+
+    graphql-inspector --help
+    graphql-inspector similar --help
+
+## License
+
+[MIT](https://github.com/kamilkisiela/graphql-inspector/blob/master/LICENSE) © Kamil Kisiela

package/index.d.ts

@@ -0,0 +1 @@
+export {};

package/index.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+'use strict';
+
+function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
+
+const tslib = require('tslib');
+const commands = require('@graphql-inspector/commands');
+const loaders = require('@graphql-inspector/loaders');
+const yargs = _interopDefault(require('yargs'));
+
+function main() {
+    return tslib.__awaiter(this, void 0, void 0, function* () {
+        const config = {
+            loaders: ['code', 'git', 'github', 'graphql', 'json', 'url'],
+            commands: [
+                'docs',
+                'serve',
+                'diff',
+                'validate',
+                'coverage',
+                'introspect',
+                'similar',
+            ],
+        };
+        const loaders$1 = loaders.useLoaders(config);
+        const commands$1 = commands.useCommands({ config, loaders: loaders$1 });
+        const root = yargs
+            .scriptName('graphql-inspector')
+            .detectLocale(false)
+            .epilog('Visit https://graphql-inspector.com for more information')
+            .version()
+            .options({
+            r: {
+                alias: 'require',
+                describe: 'Require modules',
+                type: 'array',
+            },
+            t: {
+                alias: 'token',
+                describe: 'Access Token',
+                type: 'string',
+            },
+            h: {
+                alias: 'header',
+                describe: 'Http Header',
+                type: 'array',
+            },
+            hl: {
+                alias: 'left-header',
+                describe: 'Http Header - Left',
+                type: 'array',
+            },
+            hr: {
+                alias: 'right-header',
+                describe: 'Http Header - Right',
+                type: 'array',
+            },
+        });
+        commands$1
+            .reduce((cli, cmd) => cli.command(cmd), root)
+            .help()
+            .showHelpOnFail(false).argv;
+    });
+}
+main();

package/index.mjs

@@ -0,0 +1,60 @@
+import { __awaiter } from 'tslib';
+import { useCommands } from '@graphql-inspector/commands';
+import { useLoaders } from '@graphql-inspector/loaders';
+import yargs from 'yargs';
+
+function main() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = {
+            loaders: ['code', 'git', 'github', 'graphql', 'json', 'url'],
+            commands: [
+                'docs',
+                'serve',
+                'diff',
+                'validate',
+                'coverage',
+                'introspect',
+                'similar',
+            ],
+        };
+        const loaders = useLoaders(config);
+        const commands = useCommands({ config, loaders });
+        const root = yargs
+            .scriptName('graphql-inspector')
+            .detectLocale(false)
+            .epilog('Visit https://graphql-inspector.com for more information')
+            .version()
+            .options({
+            r: {
+                alias: 'require',
+                describe: 'Require modules',
+                type: 'array',
+            },
+            t: {
+                alias: 'token',
+                describe: 'Access Token',
+                type: 'string',
+            },
+            h: {
+                alias: 'header',
+                describe: 'Http Header',
+                type: 'array',
+            },
+            hl: {
+                alias: 'left-header',
+                describe: 'Http Header - Left',
+                type: 'array',
+            },
+            hr: {
+                alias: 'right-header',
+                describe: 'Http Header - Right',
+                type: 'array',
+            },
+        });
+        commands
+            .reduce((cli, cmd) => cli.command(cmd), root)
+            .help()
+            .showHelpOnFail(false).argv;
+    });
+}
+main();

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@graphql-inspector/cli",
+  "version": "0.0.0-PLACEHOLDER",
+  "description": "Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "@graphql-inspector/code-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/commands": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/coverage-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/diff-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/docs-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/git-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/github-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/graphql-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/introspect-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/json-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/loaders": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/serve-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/similar-command": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/url-loader": "0.0.0-PLACEHOLDER",
+    "@graphql-inspector/validate-command": "0.0.0-PLACEHOLDER",
+    "tslib": "^2.0.0",
+    "yargs": "17.2.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/cli"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-inspector",
+    "tools",
+    "cli"
+  ],
+  "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"
+    }
+  },
+  "bin": {
+    "graphql-inspector": "index.js"
+  }
+}