eslint-plugin-graphql - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "eslint-plugin-graphql",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "GraphQL ESLint plugin.",
@@ -5,0 +5,0 @@ "author": "Sashko Stubailo",

README.md

 # eslint-plugin-graphql
 
-In progress - lint tagged template strings against a GraphQL schema!
+An ESLint plugin that checks tagged template strings against a GraphQL schema.
+
+```
+npm install eslint-plugin-graphql
+```
+
+![Screenshot from Atom](screenshot.png)
+
+**Coming soon:** You can use it now with the manual approach described below, but we are working on easier tooling so you can just pass a GraphQL server URL.
+
+### Configuring ESLint
+
+You'll need to import your [introspection query result](https://github.com/graphql/graphql-js/blob/master/src/utilities/introspectionQuery.js). This can be done if you define your ESLint config in a JS file:
+
+```js
+// In a file called .eslintrc.js
+module.exports = {
+  "parser": "babel-eslint",
+  "rules": {
+    "graphql/template-strings": ['error', {
+      // Import your schema JSON here
+      schemaJson: require('./schema.json'),
+
+      // Optional, the name of the template tag, defaults to 'gql'
+      tagName: 'gql'
+    }]
+  },
+  plugins: [
+    'graphql'
+  ]
+}
+```

No alert changes

Improved metrics

Total package byte prevSize

73566

124.96%

Number of package files

8

14.29%

Number of lines in readme file

35

775%

No dependency changes