new structure (#2503)

* add new docs

* more

* more

* add

* more

* more

* more

* more

* more

* fix generate docs prettier, incorrectly formatted _meta.ts

* add baseUrl

* update eslint patch

* fix snapshots

* fix lint

* move

* more

* more

* more

* more

* more

* prettier

* more

* more

* more

* prettier

* more

* prettier

* more

* more

* more

* prettier

* fix for generate-configs

* pnpm dedupe

.prettierignore

@@ -1,4 +1,5 @@
 packages/plugin/__tests__/__snapshots__/
+packages/plugin/src/rules/*/snapshot.md
 examples/prettier/invalid.graphql
 examples/prettier/invalid.js
 pnpm-lock.yaml

packages/plugin/__tests__/eslint-directives.spec.ts

@@ -1,6 +1,6 @@
 import { join } from 'node:path';
-import { rule as noAnonymousOperations } from '../src/rules/no-anonymous-operations.js';
-import { rule as noTypenamePrefix } from '../src/rules/no-typename-prefix.js';
+import { rule as noAnonymousOperations } from '@/rules/no-anonymous-operations/index.js';
+import { rule as noTypenamePrefix } from '@/rules/no-typename-prefix/index.js';
 import { ruleTester } from './test-utils.js';
 
 ruleTester.run('no-typename-prefix', noTypenamePrefix, {

packages/plugin/__tests__/alphabetize.spec.ts → packages/plugin/src/rules/alphabetize/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/alphabetize.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 const GROUP_ORDER_TEST = /* GraphQL */ `
   type User {

packages/plugin/src/rules/alphabetize.ts → packages/plugin/src/rules/alphabetize/index.ts

@@ -20,9 +20,9 @@ import {
 } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
 import lowerCase from 'lodash.lowercase';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../types.js';
-import { ARRAY_DEFAULT_OPTIONS, displayNodeName, truthy } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../../types.js';
+import { ARRAY_DEFAULT_OPTIONS, displayNodeName, truthy } from '../../utils.js';
 
 const RULE_ID = 'alphabetize';
 

packages/plugin/__tests__/description-style.spec.ts → packages/plugin/src/rules/description-style/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/description-style.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 const INLINE_SDL = /* GraphQL */ `
   " Test "

packages/plugin/src/rules/description-style.ts → packages/plugin/src/rules/description-style/index.ts

@@ -1,8 +1,8 @@
 import { StringValueNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { getNodeName } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { getNodeName } from '../../utils.js';
 
 const schema = {
   type: 'array',

packages/plugin/src/rules/index.ts

@@ -2,41 +2,41 @@
  * 🚨 IMPORTANT! Do not manually modify this file. Run: `yarn generate-configs`
  */
 
-import { rule as alphabetize } from './alphabetize.js';
-import { rule as descriptionStyle } from './description-style.js';
+import { rule as alphabetize } from './alphabetize/index.js';
+import { rule as descriptionStyle } from './description-style/index.js';
 import { GRAPHQL_JS_VALIDATIONS } from './graphql-js-validation.js';
-import { rule as inputName } from './input-name.js';
-import { rule as loneExecutableDefinition } from './lone-executable-definition.js';
-import { rule as matchDocumentFilename } from './match-document-filename.js';
-import { rule as namingConvention } from './naming-convention.js';
-import { rule as noAnonymousOperations } from './no-anonymous-operations.js';
-import { rule as noDeprecated } from './no-deprecated.js';
-import { rule as noDuplicateFields } from './no-duplicate-fields.js';
-import { rule as noHashtagDescription } from './no-hashtag-description.js';
-import { rule as noOnePlaceFragments } from './no-one-place-fragments.js';
-import { rule as noRootType } from './no-root-type.js';
-import { rule as noScalarResultTypeOnMutation } from './no-scalar-result-type-on-mutation.js';
-import { rule as noTypenamePrefix } from './no-typename-prefix.js';
-import { rule as noUnreachableTypes } from './no-unreachable-types.js';
-import { rule as noUnusedFields } from './no-unused-fields.js';
-import { rule as relayArguments } from './relay-arguments.js';
-import { rule as relayConnectionTypes } from './relay-connection-types.js';
-import { rule as relayEdgeTypes } from './relay-edge-types.js';
-import { rule as relayPageInfo } from './relay-page-info.js';
-import { rule as requireDeprecationDate } from './require-deprecation-date.js';
-import { rule as requireDeprecationReason } from './require-deprecation-reason.js';
-import { rule as requireDescription } from './require-description.js';
-import { rule as requireFieldOfTypeQueryInMutationResult } from './require-field-of-type-query-in-mutation-result.js';
-import { rule as requireImportFragment } from './require-import-fragment.js';
-import { rule as requireNullableFieldsWithOneof } from './require-nullable-fields-with-oneof.js';
-import { rule as requireNullableResultInRoot } from './require-nullable-result-in-root.js';
-import { rule as requireSelections } from './require-selections.js';
-import { rule as requireTypePatternWithOneof } from './require-type-pattern-with-oneof.js';
-import { rule as selectionSetDepth } from './selection-set-depth.js';
-import { rule as strictIdInTypes } from './strict-id-in-types.js';
-import { rule as uniqueEnumValueNames } from './unique-enum-value-names.js';
-import { rule as uniqueFragmentName } from './unique-fragment-name.js';
-import { rule as uniqueOperationName } from './unique-operation-name.js';
+import { rule as inputName } from './input-name/index.js';
+import { rule as loneExecutableDefinition } from './lone-executable-definition/index.js';
+import { rule as matchDocumentFilename } from './match-document-filename/index.js';
+import { rule as namingConvention } from './naming-convention/index.js';
+import { rule as noAnonymousOperations } from './no-anonymous-operations/index.js';
+import { rule as noDeprecated } from './no-deprecated/index.js';
+import { rule as noDuplicateFields } from './no-duplicate-fields/index.js';
+import { rule as noHashtagDescription } from './no-hashtag-description/index.js';
+import { rule as noOnePlaceFragments } from './no-one-place-fragments/index.js';
+import { rule as noRootType } from './no-root-type/index.js';
+import { rule as noScalarResultTypeOnMutation } from './no-scalar-result-type-on-mutation/index.js';
+import { rule as noTypenamePrefix } from './no-typename-prefix/index.js';
+import { rule as noUnreachableTypes } from './no-unreachable-types/index.js';
+import { rule as noUnusedFields } from './no-unused-fields/index.js';
+import { rule as relayArguments } from './relay-arguments/index.js';
+import { rule as relayConnectionTypes } from './relay-connection-types/index.js';
+import { rule as relayEdgeTypes } from './relay-edge-types/index.js';
+import { rule as relayPageInfo } from './relay-page-info/index.js';
+import { rule as requireDeprecationDate } from './require-deprecation-date/index.js';
+import { rule as requireDeprecationReason } from './require-deprecation-reason/index.js';
+import { rule as requireDescription } from './require-description/index.js';
+import { rule as requireFieldOfTypeQueryInMutationResult } from './require-field-of-type-query-in-mutation-result/index.js';
+import { rule as requireImportFragment } from './require-import-fragment/index.js';
+import { rule as requireNullableFieldsWithOneof } from './require-nullable-fields-with-oneof/index.js';
+import { rule as requireNullableResultInRoot } from './require-nullable-result-in-root/index.js';
+import { rule as requireSelections } from './require-selections/index.js';
+import { rule as requireTypePatternWithOneof } from './require-type-pattern-with-oneof/index.js';
+import { rule as selectionSetDepth } from './selection-set-depth/index.js';
+import { rule as strictIdInTypes } from './strict-id-in-types/index.js';
+import { rule as uniqueEnumValueNames } from './unique-enum-value-names/index.js';
+import { rule as uniqueFragmentName } from './unique-fragment-name/index.js';
+import { rule as uniqueOperationName } from './unique-operation-name/index.js';
 
 export const rules = {
   ...GRAPHQL_JS_VALIDATIONS,

packages/plugin/__tests__/input-name.spec.ts → packages/plugin/src/rules/input-name/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/input-name.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 ruleTester.run<RuleOptions>('input-name', rule, {
   valid: [

packages/plugin/src/rules/input-name.ts → packages/plugin/src/rules/input-name/index.ts

@@ -9,8 +9,8 @@ import {
   ObjectTypeExtensionNode,
 } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../types.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener } from '../../types.js';
 
 const schema = {
   type: 'array',

packages/plugin/__tests__/lone-executable-definition.spec.ts → packages/plugin/src/rules/lone-executable-definition/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/lone-executable-definition.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 ruleTester.run<RuleOptions>('lone-executable-definition', rule, {
   valid: [

packages/plugin/src/rules/lone-executable-definition.ts → packages/plugin/src/rules/lone-executable-definition/index.ts

@@ -1,8 +1,8 @@
 import { ExecutableDefinitionNode, OperationTypeNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { ARRAY_DEFAULT_OPTIONS, getLocation, pascalCase } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { ARRAY_DEFAULT_OPTIONS, getLocation, pascalCase } from '../../utils.js';
 
 const RULE_ID = 'lone-executable-definition';
 

packages/plugin/__tests__/match-document-filename.spec.ts → packages/plugin/src/rules/match-document-filename/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/match-document-filename.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 ruleTester.run<RuleOptions>('match-document-filename', rule, {
   valid: [

packages/plugin/src/rules/match-document-filename.ts → packages/plugin/src/rules/match-document-filename/index.ts

@@ -1,14 +1,14 @@
 import { basename, extname } from 'node:path';
 import { FragmentDefinitionNode, Kind, OperationDefinitionNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
 import {
   CaseStyle as _CaseStyle,
   convertCase,
   REPORT_ON_FIRST_CHARACTER,
   VIRTUAL_DOCUMENT_REGEX,
-} from '../utils.js';
+} from '../../utils.js';
 
 type CaseStyle = _CaseStyle | 'matchDocumentStyle';
 

packages/plugin/__tests__/naming-convention.spec.ts → packages/plugin/src/rules/naming-convention/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/naming-convention.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 ruleTester.run<RuleOptions>('naming-convention', rule, {
   valid: [

packages/plugin/src/rules/naming-convention.ts → packages/plugin/src/rules/naming-convention/index.ts

@@ -1,14 +1,14 @@
 import { ASTKindToNode, Kind, NameNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule, GraphQLESLintRuleListener, ValueOf } from '../types.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule, GraphQLESLintRuleListener, ValueOf } from '../../types.js';
 import {
   ARRAY_DEFAULT_OPTIONS,
   convertCase,
   englishJoinWords,
   truthy,
   TYPES_KINDS,
-} from '../utils.js';
+} from '../../utils.js';
 
 const KindToDisplayName = {
   // types

packages/plugin/__tests__/no-anonymous-operations.spec.ts → packages/plugin/src/rules/no-anonymous-operations/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-anonymous-operations.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 ruleTester.run('no-anonymous-operations', rule, {
   valid: ['query myQuery { a }', 'mutation doSomething { a }', 'subscription myData { a }'],

packages/plugin/src/rules/no-anonymous-operations.ts → packages/plugin/src/rules/no-anonymous-operations/index.ts

@@ -1,7 +1,7 @@
 import { Kind, OperationDefinitionNode } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { getLocation } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { getLocation } from '../../utils.js';
 
 const RULE_ID = 'no-anonymous-operations';
 

packages/plugin/__tests__/no-deprecated.spec.ts → packages/plugin/src/rules/no-deprecated/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-deprecated.js';
-import { ParserOptionsForTests, ruleTester } from './test-utils.js';
+import { ParserOptionsForTests, ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 const TEST_SCHEMA = /* GraphQL */ `
   type Query {

packages/plugin/src/rules/no-deprecated.ts → packages/plugin/src/rules/no-deprecated/index.ts

@@ -1,7 +1,7 @@
 import { EnumValueNode, FieldNode, Kind } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { requireGraphQLSchemaFromContext } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { requireGraphQLSchemaFromContext } from '../../utils.js';
 
 const RULE_ID = 'no-deprecated';
 

packages/plugin/__tests__/no-duplicate-fields.spec.ts → packages/plugin/src/rules/no-duplicate-fields/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-duplicate-fields.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 ruleTester.run('no-duplicate-fields', rule, {
   valid: [],

packages/plugin/src/rules/no-duplicate-fields.ts → packages/plugin/src/rules/no-duplicate-fields/index.ts

@@ -1,6 +1,6 @@
 import { Kind, NameNode } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
 
 const RULE_ID = 'no-duplicate-fields';
 

packages/plugin/__tests__/no-hashtag-description.spec.ts → packages/plugin/src/rules/no-hashtag-description/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RULE_ID } from '../src/rules/no-hashtag-description.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RULE_ID } from './index.js';
 
 ruleTester.run('no-hashtag-description', rule, {
   valid: [

packages/plugin/src/rules/no-hashtag-description.ts → packages/plugin/src/rules/no-hashtag-description/index.ts

@@ -1,7 +1,7 @@
 import { DocumentNode, Token, TokenKind } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { getNodeName } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { getNodeName } from '../../utils.js';
 
 export const RULE_ID = 'HASHTAG_COMMENT';
 

packages/plugin/__tests__/no-one-place-fragments.spec.ts → packages/plugin/src/rules/no-one-place-fragments/index.test.ts

@@ -1,6 +1,7 @@
 import { join } from 'node:path';
-import { rule } from '../src/rules/no-one-place-fragments.js';
-import { ruleTester } from './test-utils.js';
+import { CWD } from '@/utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 ruleTester.run('no-one-place-fragments', rule, {
   valid: [
@@ -9,7 +10,7 @@ ruleTester.run('no-one-place-fragments', rule, {
       code: ruleTester.fromMockFile('no-one-place-fragments.graphql'),
       parserOptions: {
         graphQLConfig: {
-          documents: join(__dirname, 'mocks/no-one-place-fragments.graphql'),
+          documents: join(CWD, '__tests__/mocks/no-one-place-fragments.graphql'),
         },
       },
     },

packages/plugin/src/rules/no-one-place-fragments.ts → packages/plugin/src/rules/no-one-place-fragments/index.ts

@@ -1,8 +1,8 @@
 import { relative } from 'node:path';
 import { NameNode, visit } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { CWD, requireSiblingsOperations } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { CWD, requireSiblingsOperations } from '../../utils.js';
 
 const RULE_ID = 'no-one-place-fragments';
 

packages/plugin/__tests__/no-root-type.spec.ts → packages/plugin/src/rules/no-root-type/index.test.ts

@@ -1,5 +1,5 @@
-import { rule, RuleOptions } from '../src/rules/no-root-type.js';
-import { ParserOptionsForTests, ruleTester } from './test-utils.js';
+import { ParserOptionsForTests, ruleTester } from '../../../__tests__/test-utils.js';
+import { rule, RuleOptions } from './index.js';
 
 const useSchema = (code: string, schema = '') => ({
   code,

packages/plugin/src/rules/no-root-type.ts → packages/plugin/src/rules/no-root-type/index.ts

@@ -1,8 +1,8 @@
 import { NameNode } from 'graphql';
 import { FromSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchemaFromContext, truthy } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { ARRAY_DEFAULT_OPTIONS, requireGraphQLSchemaFromContext, truthy } from '../../utils.js';
 
 const schema = {
   type: 'array',

packages/plugin/__tests__/no-scalar-result-type-on-mutation.spec.ts → packages/plugin/src/rules/no-scalar-result-type-on-mutation/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-scalar-result-type-on-mutation.js';
-import { ParserOptionsForTests, ruleTester } from './test-utils.js';
+import { ParserOptionsForTests, ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 const useSchema = (code: string) => ({
   code,

packages/plugin/src/rules/no-scalar-result-type-on-mutation.ts → packages/plugin/src/rules/no-scalar-result-type-on-mutation/index.ts

@@ -1,7 +1,7 @@
 import { isScalarType, Kind, NameNode } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
-import { getNodeName, requireGraphQLSchemaFromContext } from '../utils.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
+import { getNodeName, requireGraphQLSchemaFromContext } from '../../utils.js';
 
 const RULE_ID = 'no-scalar-result-type-on-mutation';
 

packages/plugin/__tests__/no-typename-prefix.spec.ts → packages/plugin/src/rules/no-typename-prefix/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-typename-prefix.js';
-import { ruleTester } from './test-utils.js';
+import { ruleTester } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 ruleTester.run('no-typename-prefix', rule, {
   valid: [

packages/plugin/src/rules/no-typename-prefix.ts → packages/plugin/src/rules/no-typename-prefix/index.ts

@@ -4,8 +4,8 @@ import {
   ObjectTypeDefinitionNode,
   ObjectTypeExtensionNode,
 } from 'graphql';
-import { GraphQLESTreeNode } from '../estree-converter/index.js';
-import { GraphQLESLintRule } from '../types.js';
+import { GraphQLESTreeNode } from '../../estree-converter/index.js';
+import { GraphQLESLintRule } from '../../types.js';
 
 const NO_TYPENAME_PREFIX = 'NO_TYPENAME_PREFIX';
 

packages/plugin/__tests__/no-unreachable-types.spec.ts → packages/plugin/src/rules/no-unreachable-types/index.test.ts

@@ -1,5 +1,5 @@
-import { rule } from '../src/rules/no-unreachable-types.js';
-import { ruleTester, withSchema } from './test-utils.js';
+import { ruleTester, withSchema } from '../../../__tests__/test-utils.js';
+import { rule } from './index.js';
 
 ruleTester.run('no-unreachable-types', rule, {
   valid: [