Added 'literal' option to env

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ### vNEXT
 
-- ...
+- Added `'literal'` option to `env` for when working with `.graphql` and `.gql` files, by [jtmthf in
 
 ### v0.4.1
 

README.md

@@ -52,10 +52,10 @@ Note: the linter rule could be extended to identify calls to various specific AP
 ### GraphQL literal files
 
 This plugin also lints GraphQL literal files ending on `.gql` or `.graphql`.
-In order to do so just tell eslint to check these files as well.
+In order to do so set `env` to `'literal'` in your `.eslintrc.js` and tell eslint to check these files as well.
 
 ```BASH
-eslint . --ext js,gql,graphql
+eslint . --ext .js --ext .gql --ext .graphql
 ```
 
 ### Example config for Apollo
@@ -67,7 +67,7 @@ module.exports = {
   rules: {
     "graphql/template-strings": ['error', {
       // Import default settings for your GraphQL client. Supported values:
-      // 'apollo', 'relay', 'lokka'
+      // 'apollo', 'relay', 'lokka', 'literal'
       env: 'apollo',
 
       // Import your schema JSON here
@@ -94,7 +94,7 @@ module.exports = {
   rules: {
     "graphql/template-strings": ['error', {
       // Import default settings for your GraphQL client. Supported values:
-      // 'apollo', 'relay', 'lokka'
+      // 'apollo', 'relay', 'lokka', 'literal'
       env: 'relay',
 
       // Import your schema JSON here
@@ -121,7 +121,7 @@ module.exports = {
   rules: {
     "graphql/template-strings": ['error', {
       // Import default settings for your GraphQL client. Supported values:
-      // 'apollo', 'relay', 'lokka'
+      // 'apollo', 'relay', 'lokka', 'literal'
       env: 'lokka',
 
       // Import your schema JSON here
@@ -140,6 +140,33 @@ module.exports = {
 }
 ```
 
+### Example config for literal graphql files
+
+```js
+// In a file called .eslintrc.js
+module.exports = {
+  parser: "babel-eslint",
+  rules: {
+    "graphql/template-strings": ['error', {
+      // Import default settings for your GraphQL client. Supported values:
+      // 'apollo', 'relay', 'lokka', 'literal'
+      env: 'literal',
+
+      // Import your schema JSON here
+      schemaJson: require('./schema.json'),
+
+      // OR provide absolute path to your schema JSON
+      // schemaJsonFilepath: path.resolve(__dirname, './schema.json'),
+
+      // tagName is set automatically
+    }]
+  },
+  plugins: [
+    'graphql'
+  ]
+}
+```
+
 ### Additional Schemas or Tags
 
 This plugin can be used to validate against multiple schemas by identifying them with different tags. This is useful for applications interacting with multiple GraphQL systems. Additional schemas can simply be appended to the options list:

src/index.js

@@ -135,8 +135,8 @@ function parseOptions(optionGroup) {
   }
 
   // Validate env
-  if (env && env !== 'lokka' && env !== 'relay' && env !== 'apollo') {
-    throw new Error('Invalid option for env, only `apollo`, `lokka`, and `relay` supported.')
+  if (env && env !== 'lokka' && env !== 'relay' && env !== 'apollo' && env !== 'literal') {
+    throw new Error('Invalid option for env, only `apollo`, `lokka`, `relay`, and `literal` supported.')
   }
 
   // Validate tagName and set default
@@ -145,6 +145,8 @@ function parseOptions(optionGroup) {
     tagName = tagNameOption;
   } else if (env === 'relay') {
     tagName = 'Relay.QL';
+  } else if (env === 'literal') {
+    tagName = internalTag;
   } else {
     tagName = 'gql';
   }