adjust packages

initial README

Author: dotansimha

README.md

@@ -1,2 +1,79 @@
-# graphql-eslint
-graphql-eslint
+This project integrates GraphQL AST parser and ESLint.
+
+## Key Features:
+
+🚀 Integrates with ESLint core (as a ESTree parser).
+🚀 Works on `.graphql` files, `gql` usages and `/* GraphQL */` magic comments.
+🚀 Lints both GraphQL schema and GraphQL operations.
+🚀 Extended type info for more advanced usages
+🚀 Supports ESLint directives (for example: `disable-next-line`)
+🚀 Easily extendable - supports custom rules.
+
+## Getting Started
+
+### Installation
+
+Start by installing the plugin package, which includes everything you need:
+
+```
+yarn add -D @graphql-eslint/eslint-plugin
+```
+
+Or, with NPM:
+
+```
+npm install --save-dev @graphql-eslint/eslint-plugin
+```
+
+> Also, make sure you have `graphql` dependency in your project.
+
+### Configuration
+
+To get started, create an override configuration for your ESLint, while applying it to to `.graphql` files (do that even if you are declaring your operations in code files):
+
+```json
+{
+  "overrides": [
+    {
+      "files": ["*.graphql"],
+      "parser": "@graphql-eslint/eslint-plugin",
+      "plugins": ["@graphql-eslint"],
+      "rules": {
+        ...
+      }
+    }
+  ]
+}
+```
+
+If you are using code files to store your GraphQL schema or your GraphQL operations, you can extend the behaviour of ESLint and extract those, by adding the following to your setup:
+
+```json
+{
+  "processor": "@graphql-eslint/graphql",
+  "overrides": [ ... ]
+}
+```
+
+#### Extended linting with GraphQL Schema
+
+If you are using [`graphql-config`](https://graphql-config.com/) - you are good to go. This package integrates with it automatically, and will use it to load your schema!
+
+Linting process can be enriched and extended with GraphQL type information, if you are able to provide your GraphQL schema.
+
+The parser allow you to specify a json file / graphql files(s) / url / raw string to locate your schema (We are using `graphql-tools` to do that). Just add `parserOptions.schema` to your configuration file:
+
+```json
+{
+  "files": ["*.graphql"],
+  "parser": "@graphql-eslint/eslint-plugin",
+  "plugins": ["@graphql-eslint"],
+  "parserOptions": {
+    "schema": "./schema.graphql"
+  }
+}
+```
+
+> Some rules requires type information to operate, it's marked in the docs of each plugin!
+
+### Available Rules

example/.eslintrc.json

@@ -1,9 +1,9 @@
-{
+{  
   "processor": "@graphql-eslint/graphql",
   "overrides": [
     {
-      "files": ["./**/*.graphql"],
-      "parser": "@graphql-eslint/parser",
+      "files": ["*.graphql"],
+      "parser": "@graphql-eslint/eslint-plugin",
       "parserOptions": {
         "schema": "./**/schema.graphql"
       },

example/package.json

@@ -10,7 +10,6 @@
   },
   "dependencies": {
     "eslint": "7.8.1",
-    "@graphql-eslint/parser": "0.0.1",
     "@graphql-eslint/eslint-plugin": "0.0.1",
     "graphql": "15.3.0",
     "typescript": "4.0.2"

example/query.js

@@ -11,11 +11,6 @@ const myQuery = gql`
 `;
 
 const myOther2Query = /* GraphQL */ `
-
-
-
-
-
   query {
     user {
       name

packages/graphql-estree/package.json

@@ -16,8 +16,13 @@
     "prepack": "bob prepack"
   },
   "dependencies": {
-    "@graphql-eslint/types": "0.0.1",
-    "@graphql-tools/graphql-tag-pluck": "6.2.5"
+    "@graphql-tools/utils": "~6.0.0",
+    "@graphql-tools/load": "~6.0.0",
+    "@graphql-tools/graphql-file-loader": "~6.0.0",
+    "@graphql-tools/json-file-loader": "~6.0.0",
+    "@graphql-tools/url-loader": "~6.0.0",
+    "@graphql-tools/graphql-tag-pluck": "6.2.5",
+    "graphql-config": "^3.0.0"
   },
   "devDependencies": {
     "@types/eslint": "7.2.2",

packages/graphql-estree/src/index.ts

@@ -1,17 +1,16 @@
 import {
   convertDescription,
-  GraphQLESTreeNode,
-  SafeGraphQLType,
   convertLocation,
   convertRange,
-} from "@graphql-eslint/types";
+  extractCommentsFromAst,
+} from "./utils";
+import { GraphQLESTreeNode, SafeGraphQLType } from "./estree-ast";
 import {
   ASTNode,
   TypeNode,
   TypeInfo,
   visit,
   visitWithTypeInfo,
-  TokenKind,
   Location,
 } from "graphql";
 import { Comment } from "estree";
@@ -100,39 +99,3 @@ const convertNode = (typeInfo?: TypeInfo) => <T extends ASTNode>(
     return estreeNode;
   }
 };
-
-export function extractCommentsFromAst(node: ASTNode): Comment[] {
-  const loc = node.loc;
-
-  if (!loc) {
-    return [];
-  }
-
-  const comments: Comment[] = [];
-  let token = loc.startToken;
-
-  while (token !== null) {
-    if (token.kind === TokenKind.COMMENT) {
-      const value = String(token.value);
-      comments.push({
-        type: "Block",
-        value: " " + value + " ",
-        loc: {
-          start: {
-            line: token.line,
-            column: token.column,
-          },
-          end: {
-            line: token.line,
-            column: token.column,
-          },
-        },
-        range: [token.start, token.end],
-      });
-    }
-
-    token = token.next;
-  }
-
-  return comments;
-}