Merge pull request #161 from captbaritone/clean-up

Clean up legacy lint rules

Author: captbaritone

README.md

@@ -18,9 +18,7 @@ module.exports = {
   // Other eslint properties here
   rules: {
     'relay/graphql-syntax': 'error',
-    'relay/compat-uses-vars': 'warn',
     'relay/graphql-naming': 'error',
-    'relay/generated-flow-types': 'warn',
     'relay/must-colocate-fragment-spreads': 'warn',
     'relay/no-future-added-value': 'warn',
     'relay/unused-fields': 'warn',
@@ -42,6 +40,18 @@ Add `plugin:relay/recommended` or `plugin:relay/strict` in `extends`:
 }
 ```
 
+### Rule Descriptions
+
+Brief descriptions for each rule:
+
+- `relay/graphql-syntax`: Ensures each `graphql\`\`` tagged template literal contains syntactically valid GraphQL. This is also validated by the Relay Compiler, but the ESLint plugin can often provide faster feedback.
+- `relay/graphql-naming`: Ensures GraphQL fragments and queries follow Relay's naming conventions. This is also validated by the Relay Compiler, but the ESLint plugin can often provide faster feedback.
+- `relay/no-future-added-value`: Ensures code does not try to explicitly handle the `"%future added value"` enum variant which Relay inserts as a placeholder to ensure you handle the possibility that new enum variants may be added by the server after your application has been deployed.
+- `relay/unused-fields`: Ensures that every GraphQL field referenced is used within the module that includes it. This helps enable Relay's [optimal data fetching](https://relay.dev/blog/2023/10/24/how-relay-enables-optimal-data-fetching/)
+- `relay/function-required-argument`: Ensures that `readInlineData` is always passed an explicit argument even though that argument is allowed to be `undefined` at runtime.
+- `relay/hook-required-argument`: Ensures that Relay hooks are always passed an explicit argument even though that argument is allowed to be `undefined` at runtime.
+- `relay/must-colocate-fragment-spreads`: Ensures that when a fragment spread is added within a module, that module directly imports the module which defines that fragment. This prevents the anti-pattern when one component fetches a fragment that is not used by a direct child component. **Note**: This rule leans heavily on Meta's globally unique module names. It likely won't work well in other environments.
+
 ### Suppressing rules within graphql tags
 
 The following rules support suppression within graphql tags:

eslint-plugin-relay.js

@@ -10,9 +10,7 @@
 module.exports = {
   rules: {
     'graphql-syntax': require('./src/rule-graphql-syntax'),
-    'compat-uses-vars': require('./src/rule-compat-uses-vars'),
     'graphql-naming': require('./src/rule-graphql-naming'),
-    'generated-flow-types': require('./src/rule-generated-flow-types'),
     'generated-typescript-types': require('./src/rule-generated-typescript-types'),
     'no-future-added-value': require('./src/rule-no-future-added-value'),
     'unused-fields': require('./src/rule-unused-fields'),
@@ -24,9 +22,7 @@ module.exports = {
     recommended: {
       rules: {
         'relay/graphql-syntax': 'error',
-        'relay/compat-uses-vars': 'warn',
         'relay/graphql-naming': 'error',
-        'relay/generated-flow-types': 'warn',
         'relay/no-future-added-value': 'warn',
         'relay/unused-fields': 'warn',
         'relay/must-colocate-fragment-spreads': 'warn',
@@ -37,7 +33,6 @@ module.exports = {
     'ts-recommended': {
       rules: {
         'relay/graphql-syntax': 'error',
-        'relay/compat-uses-vars': 'warn',
         'relay/graphql-naming': 'error',
         'relay/generated-typescript-types': 'warn',
         'relay/no-future-added-value': 'warn',
@@ -50,9 +45,7 @@ module.exports = {
     strict: {
       rules: {
         'relay/graphql-syntax': 'error',
-        'relay/compat-uses-vars': 'error',
         'relay/graphql-naming': 'error',
-        'relay/generated-flow-types': 'error',
         'relay/no-future-added-value': 'error',
         'relay/unused-fields': 'error',
         'relay/must-colocate-fragment-spreads': 'error',
@@ -63,7 +56,6 @@ module.exports = {
     'ts-strict': {
       rules: {
         'relay/graphql-syntax': 'error',
-        'relay/compat-uses-vars': 'error',
         'relay/graphql-naming': 'error',
         'relay/generated-typescript-types': 'error',
         'relay/no-future-added-value': 'error',