@graphql-eslint/eslint-plugin 4.0.0-alpha-20220821140530-e968cfc → 4.0.0-alpha-20230801163310-8bc4340

package/parser.d.ts

@@ -1,2 +0,0 @@
-import { GraphQLESLintParseResult, ParserOptions } from './types';
-export declare function parseForESLint(code: string, options?: ParserOptions): GraphQLESLintParseResult;

package/processor.d.ts

@@ -1,7 +0,0 @@
-import type { Linter } from 'eslint';
-declare type Block = Linter.ProcessorFile & {
-    lineOffset: number;
-    offset: number;
-};
-export declare const processor: Linter.Processor<Block | string>;
-export {};

package/rules/alphabetize.d.ts

@@ -1,16 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const fieldsEnum: ('ObjectTypeDefinition' | 'InterfaceTypeDefinition' | 'InputObjectTypeDefinition')[];
-declare const valuesEnum: ['EnumTypeDefinition'];
-declare const selectionsEnum: ('OperationDefinition' | 'FragmentDefinition')[];
-declare const variablesEnum: ['OperationDefinition'];
-declare const argumentsEnum: ('FieldDefinition' | 'Field' | 'DirectiveDefinition' | 'Directive')[];
-export declare type AlphabetizeConfig = {
-    fields?: typeof fieldsEnum;
-    values?: typeof valuesEnum;
-    selections?: typeof selectionsEnum;
-    variables?: typeof variablesEnum;
-    arguments?: typeof argumentsEnum;
-    definitions?: boolean;
-};
-declare const rule: GraphQLESLintRule<[AlphabetizeConfig]>;
-export default rule;

package/rules/description-style.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare type DescriptionStyleRuleConfig = {
-    style: 'inline' | 'block';
-};
-declare const rule: GraphQLESLintRule<[DescriptionStyleRuleConfig]>;
-export default rule;

package/rules/graphql-js-validation.d.ts

@@ -1,2 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-export declare const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule>;

package/rules/index.d.ts

@@ -1,41 +0,0 @@
-export declare const rules: {
-    alphabetize: import("..").GraphQLESLintRule<[import("./alphabetize").AlphabetizeConfig], false>;
-    'description-style': import("..").GraphQLESLintRule<[{
-        style: "block" | "inline";
-    }], false>;
-    'input-name': import("..").GraphQLESLintRule<[{
-        checkInputType?: boolean;
-        caseSensitiveInputType?: boolean;
-        checkQueries?: boolean;
-        checkMutations?: boolean;
-    }], false>;
-    'match-document-filename': import("..").GraphQLESLintRule<[import("./match-document-filename").MatchDocumentFilenameRuleConfig], false>;
-    'naming-convention': import("..").GraphQLESLintRule<[import("./naming-convention").NamingConventionRuleConfig], false>;
-    'no-anonymous-operations': import("..").GraphQLESLintRule<any[], false>;
-    'no-case-insensitive-enum-values-duplicates': import("..").GraphQLESLintRule<any[], false>;
-    'no-deprecated': import("..").GraphQLESLintRule<[], true>;
-    'no-duplicate-fields': import("..").GraphQLESLintRule<any[], false>;
-    'no-hashtag-description': import("..").GraphQLESLintRule<any[], false>;
-    'no-root-type': import("..").GraphQLESLintRule<[{
-        disallow: ("mutation" | "subscription")[];
-    }], false>;
-    'no-scalar-result-type-on-mutation': import("..").GraphQLESLintRule<any[], false>;
-    'no-typename-prefix': import("..").GraphQLESLintRule<any[], false>;
-    'no-unreachable-types': import("..").GraphQLESLintRule<any[], false>;
-    'no-unused-fields': import("..").GraphQLESLintRule<any[], false>;
-    'relay-arguments': import("..").GraphQLESLintRule<[import("./relay-arguments").RelayArgumentsConfig], true>;
-    'relay-connection-types': import("..").GraphQLESLintRule<any[], false>;
-    'relay-edge-types': import("..").GraphQLESLintRule<[import("./relay-edge-types").EdgeTypesConfig], true>;
-    'relay-page-info': import("..").GraphQLESLintRule<any[], false>;
-    'require-deprecation-date': import("..").GraphQLESLintRule<[{
-        argumentName?: string;
-    }], false>;
-    'require-deprecation-reason': import("..").GraphQLESLintRule<any[], false>;
-    'require-description': import("..").GraphQLESLintRule<[import("./require-description").RequireDescriptionRuleConfig], false>;
-    'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
-    'require-id-when-available': import("..").GraphQLESLintRule<[import("./require-id-when-available").RequireIdWhenAvailableRuleConfig], true>;
-    'selection-set-depth': import("..").GraphQLESLintRule<[import("./selection-set-depth").SelectionSetDepthRuleConfig], false>;
-    'strict-id-in-types': import("..").GraphQLESLintRule<[import("./strict-id-in-types").StrictIdInTypesRuleConfig], false>;
-    'unique-fragment-name': import("..").GraphQLESLintRule<any[], false>;
-    'unique-operation-name': import("..").GraphQLESLintRule<any[], false>;
-};

package/rules/input-name.d.ts

@@ -1,9 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare type InputNameRuleConfig = {
-    checkInputType?: boolean;
-    caseSensitiveInputType?: boolean;
-    checkQueries?: boolean;
-    checkMutations?: boolean;
-};
-declare const rule: GraphQLESLintRule<[InputNameRuleConfig]>;
-export default rule;

package/rules/match-document-filename.d.ts

@@ -1,18 +0,0 @@
-import { CaseStyle as _CaseStyle } from '../utils';
-import { GraphQLESLintRule } from '../types';
-declare type CaseStyle = _CaseStyle | 'matchDocumentStyle';
-declare const ACCEPTED_EXTENSIONS: ['.gql', '.graphql'];
-declare type PropertySchema = {
-    style?: CaseStyle;
-    suffix?: string;
-    prefix?: string;
-};
-export declare type MatchDocumentFilenameRuleConfig = {
-    fileExtension?: typeof ACCEPTED_EXTENSIONS[number];
-    query?: CaseStyle | PropertySchema;
-    mutation?: CaseStyle | PropertySchema;
-    subscription?: CaseStyle | PropertySchema;
-    fragment?: CaseStyle | PropertySchema;
-};
-declare const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]>;
-export default rule;

package/rules/naming-convention.d.ts

@@ -1,37 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const KindToDisplayName: {
-    ObjectTypeDefinition: string;
-    InterfaceTypeDefinition: string;
-    EnumTypeDefinition: string;
-    ScalarTypeDefinition: string;
-    InputObjectTypeDefinition: string;
-    UnionTypeDefinition: string;
-    FieldDefinition: string;
-    InputValueDefinition: string;
-    Argument: string;
-    DirectiveDefinition: string;
-    EnumValueDefinition: string;
-    OperationDefinition: string;
-    FragmentDefinition: string;
-    VariableDefinition: string;
-};
-declare type AllowedKind = keyof typeof KindToDisplayName;
-declare type AllowedStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE';
-declare type PropertySchema = {
-    style?: AllowedStyle;
-    suffix?: string;
-    prefix?: string;
-    forbiddenPrefixes?: string[];
-    forbiddenSuffixes?: string[];
-    ignorePattern?: string;
-};
-declare type Options = AllowedStyle | PropertySchema;
-export declare type NamingConventionRuleConfig = {
-    allowLeadingUnderscore?: boolean;
-    allowTrailingUnderscore?: boolean;
-    types?: Options;
-} & {
-    [key in `${AllowedKind}${string}`]?: Options;
-};
-declare const rule: GraphQLESLintRule<[NamingConventionRuleConfig]>;
-export default rule;

package/rules/no-anonymous-operations.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-case-insensitive-enum-values-duplicates.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-deprecated.d.ts

@@ -1,3 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule<[], true>;
-export default rule;

package/rules/no-duplicate-fields.d.ts

@@ -1,3 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-hashtag-description.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-root-type.d.ts

@@ -1,7 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const ROOT_TYPES: ('mutation' | 'subscription')[];
-declare type NoRootTypeConfig = {
-    disallow: typeof ROOT_TYPES;
-};
-declare const rule: GraphQLESLintRule<[NoRootTypeConfig]>;
-export default rule;

package/rules/no-scalar-result-type-on-mutation.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-typename-prefix.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-unreachable-types.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/no-unused-fields.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/relay-arguments.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-export declare type RelayArgumentsConfig = {
-    includeBoth?: boolean;
-};
-declare const rule: GraphQLESLintRule<[RelayArgumentsConfig], true>;
-export default rule;

package/rules/relay-connection-types.d.ts

@@ -1,5 +0,0 @@
-import { Kind } from 'graphql';
-import type { GraphQLESLintRule } from '../types';
-export declare const NON_OBJECT_TYPES: Kind[];
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/relay-edge-types.d.ts

@@ -1,8 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-export declare type EdgeTypesConfig = {
-    withEdgeSuffix?: boolean;
-    shouldImplementNode?: boolean;
-    listTypeCanWrapOnlyEdgeType?: boolean;
-};
-declare const rule: GraphQLESLintRule<[EdgeTypesConfig], true>;
-export default rule;

package/rules/relay-page-info.d.ts

@@ -1,3 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/require-deprecation-date.d.ts

@@ -1,5 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule<[{
-    argumentName?: string;
-}]>;
-export default rule;

package/rules/require-deprecation-reason.d.ts

@@ -1,3 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/require-description.d.ts

@@ -1,11 +0,0 @@
-import { Kind } from 'graphql';
-import type { GraphQLESLintRule } from '../types';
-declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
-declare type AllowedKind = typeof ALLOWED_KINDS[number];
-export declare type RequireDescriptionRuleConfig = {
-    types?: boolean;
-} & {
-    [key in AllowedKind]?: boolean;
-};
-declare const rule: GraphQLESLintRule<[RequireDescriptionRuleConfig]>;
-export default rule;

package/rules/require-field-of-type-query-in-mutation-result.d.ts

@@ -1,3 +0,0 @@
-import type { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/require-id-when-available.d.ts

@@ -1,6 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-export declare type RequireIdWhenAvailableRuleConfig = {
-    fieldName: string | string[];
-};
-declare const rule: GraphQLESLintRule<[RequireIdWhenAvailableRuleConfig], true>;
-export default rule;

package/rules/selection-set-depth.d.ts

@@ -1,7 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-export declare type SelectionSetDepthRuleConfig = {
-    maxDepth: number;
-    ignore?: string[];
-};
-declare const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]>;
-export default rule;

package/rules/strict-id-in-types.d.ts

@@ -1,11 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-export declare type StrictIdInTypesRuleConfig = {
-    acceptedIdNames?: string[];
-    acceptedIdTypes?: string[];
-    exceptions?: {
-        types?: string[];
-        suffixes?: string[];
-    };
-};
-declare const rule: GraphQLESLintRule<[StrictIdInTypesRuleConfig]>;
-export default rule;

package/rules/unique-fragment-name.d.ts

@@ -1,6 +0,0 @@
-import { ExecutableDefinitionNode } from 'graphql';
-import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
-import { GraphQLESTreeNode } from '../estree-converter';
-export declare const checkNode: (context: GraphQLESLintRuleContext, node: GraphQLESTreeNode<ExecutableDefinitionNode>, ruleId: string) => void;
-declare const rule: GraphQLESLintRule;
-export default rule;

package/rules/unique-operation-name.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;

package/schema.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLProjectConfig } from 'graphql-config';
-import type { ParserOptions, Schema } from './types';
-export declare function getSchema(projectForFile: GraphQLProjectConfig, options?: ParserOptions): Schema;

package/sibling-operations.d.ts

@@ -1,21 +0,0 @@
-import { FragmentDefinitionNode, OperationDefinitionNode, SelectionSetNode, OperationTypeNode } from 'graphql';
-import { GraphQLProjectConfig } from 'graphql-config';
-export declare type FragmentSource = {
-    filePath: string;
-    document: FragmentDefinitionNode;
-};
-export declare type OperationSource = {
-    filePath: string;
-    document: OperationDefinitionNode;
-};
-export declare type SiblingOperations = {
-    available: boolean;
-    getFragment(fragmentName: string): FragmentSource[];
-    getFragments(): FragmentSource[];
-    getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
-    getOperation(operationName: string): OperationSource[];
-    getOperations(): OperationSource[];
-    getOperationByType(operationType: OperationTypeNode): OperationSource[];
-};
-export declare function getSiblingOperations(projectForFile: GraphQLProjectConfig): SiblingOperations;

package/testkit.d.ts

@@ -1,27 +0,0 @@
-import { RuleTester } from 'eslint';
-import type { ASTKindToNode } from 'graphql';
-import type { GraphQLESTreeNode } from './estree-converter';
-import type { GraphQLESLintRule, ParserOptions } from './types';
-export declare type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = {
-    [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
-} & Record<string, any>;
-export declare type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {
-    options?: Options;
-    parserOptions?: ParserOptions;
-};
-export declare type GraphQLInvalidTestCase<T> = GraphQLValidTestCase<T> & {
-    errors: number | (RuleTester.TestCaseError | string)[];
-    output?: string | null;
-};
-export declare class GraphQLRuleTester extends RuleTester {
-    config: {
-        parser: string;
-        parserOptions: ParserOptions;
-    };
-    constructor(parserOptions?: ParserOptions);
-    fromMockFile(path: string): string;
-    runGraphQLTests<Options, WithTypeInfo extends boolean = false>(ruleId: string, rule: GraphQLESLintRule<Options, WithTypeInfo>, tests: {
-        valid: (string | GraphQLValidTestCase<Options>)[];
-        invalid: GraphQLInvalidTestCase<Options>[];
-    }): void;
-}

package/types.d.ts

@@ -1,79 +0,0 @@
-import type { Rule, AST, Linter } from 'eslint';
-import type * as ESTree from 'estree';
-import type { GraphQLSchema } from 'graphql';
-import type { IExtensions, IGraphQLProject } from 'graphql-config';
-import type { GraphQLParseOptions } from '@graphql-tools/utils';
-import type { GraphQLESLintRuleListener } from './testkit';
-import type { SiblingOperations } from './sibling-operations';
-export declare type Schema = GraphQLSchema | Error | null;
-export declare type Pointer = string | string[];
-export interface ParserOptions {
-    schema?: Pointer | Record<string, {
-        headers: Record<string, string>;
-    }>;
-    documents?: Pointer;
-    operations?: Pointer;
-    extensions?: IExtensions;
-    include?: Pointer;
-    exclude?: Pointer;
-    projects?: Record<string, IGraphQLProject>;
-    schemaOptions?: Omit<GraphQLParseOptions, 'assumeValidSDL'> & {
-        headers: Record<string, string>;
-    };
-    graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
-    skipGraphQLConfig?: boolean;
-    filePath?: string;
-}
-export declare type ParserServices = {
-    schema: Schema;
-    siblingOperations: SiblingOperations;
-};
-export declare type GraphQLESLintParseResult = Linter.ESLintParseResult & {
-    services: ParserServices;
-};
-declare type Location = AST.SourceLocation | ESTree.Position;
-declare type ReportDescriptorLocation = {
-    node: {
-        loc: Location;
-    };
-} | {
-    loc: Location;
-};
-export declare type ReportDescriptor = Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions & ReportDescriptorLocation;
-export declare type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'parserServices' | 'report' | 'options'> & {
-    options: Options;
-    report(descriptor: ReportDescriptor): void;
-    parserServices?: ParserServices;
-};
-export declare type CategoryType = 'Schema' | 'Operations';
-export declare type RuleDocsInfo<T> = {
-    docs: Omit<Rule.RuleMetaData['docs'], 'category'> & {
-        category: CategoryType | CategoryType[];
-        requiresSchema?: true;
-        requiresSiblings?: true;
-        examples?: {
-            title: string;
-            code: string;
-            usage?: T;
-        }[];
-        configOptions?: T | {
-            schema?: T;
-            operations?: T;
-        };
-        graphQLJSRuleName?: string;
-        isDisabledForAllConfig?: true;
-    };
-};
-export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
-    create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
-    meta: Omit<Rule.RuleMetaData, 'docs'> & RuleDocsInfo<Options>;
-};
-export declare type ValueOf<T> = T[keyof T];
-declare type Id<T> = {} & {
-    [P in keyof T]: T[P];
-};
-declare type OmitDistributive<T, K extends PropertyKey> = T extends object ? Id<OmitRecursively<T, K>> : T;
-export declare type OmitRecursively<T extends object, K extends PropertyKey> = Omit<{
-    [P in keyof T]: OmitDistributive<T[P], K>;
-}, K>;
-export {};

package/utils.d.ts

@@ -1,39 +0,0 @@
-import type { GraphQLSchema } from 'graphql';
-import { Kind } from 'graphql';
-import type { AST } from 'eslint';
-import type { Position } from 'estree';
-import type { GraphQLESLintRuleContext } from './types';
-import type { SiblingOperations } from './sibling-operations';
-export declare function requireSiblingsOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
-export declare function requireGraphQLSchemaFromContext(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
-export declare const logger: {
-    error: (...args: any[]) => void;
-    warn: (...args: any[]) => void;
-};
-export declare const normalizePath: (path: string) => string;
-/**
- * https://github.com/prettier/eslint-plugin-prettier/blob/76bd45ece6d56eb52f75db6b4a1efdd2efb56392/eslint-plugin-prettier.js#L71
- * Given a filepath, get the nearest path that is a regular file.
- * The filepath provided by eslint may be a virtual filepath rather than a file
- * on disk. This attempts to transform a virtual path into an on-disk path
- */
-export declare const getOnDiskFilepath: (filepath: string) => string;
-export declare const getTypeName: (node: any) => string;
-export declare const TYPES_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION];
-export declare type CaseStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE' | 'kebab-case';
-export declare const camelCase: (str: string) => string;
-export declare const convertCase: (style: CaseStyle, str: string) => string;
-export declare function getLocation(start: Position, fieldName?: string): AST.SourceLocation;
-export declare const REPORT_ON_FIRST_CHARACTER: {
-    column: number;
-    line: number;
-};
-export declare const ARRAY_DEFAULT_OPTIONS: {
-    readonly type: "array";
-    readonly uniqueItems: true;
-    readonly minItems: 1;
-    readonly items: {
-        readonly type: "string";
-    };
-};
-export declare const englishJoinWords: (words: any) => string;