@graphql-eslint/alphabetize support autofix ?

[neviaumi]

https://github.com/dotansimha/graphql-eslint/blob/master/packages/plugin/src/rules/alphabetize.ts

It possible to make rules @graphql-eslint/alphabetize support autofix?

My case was i have 2000+ line graphql schema right now. manual fix it and apply the rules is terrible tasks.

Or some online tools can help me for initial setup ?

[neviaumi]

turnout i find my solution there

graphql/graphql-js#2036

And according to here, seem @graphql-eslint/alphabetize behaviour would difference to graphql utilities provided
cjoudrey/graphql-schema-linter@0e32302

[dimaMachina]

Sure, I will add autofix but only for cases where there are no comments between or around fields. And I'll change the order to lexicographic.
Nice catch!

[dimaMachina]

@davidNHK available in 3.8.0-alpha-db02c77.0 version, could you try it and give your feedback?

[neviaumi]

only for cases where there are no comments between or around fields

i said the original issue on graphql/graphql-js#2036

the code below can handle comment as well

const { lexicographicSortSchema,  buildSchema, printSchema } = require('graphql')
const fs = require('fs')
const schema = fs.readFileSync('./schema.graphql', { encoding: 'utf-8'})
const schemaV2 = buildSchema(schema)
printSchema(lexicographicSortSchema(schemaV2))

[dimaMachina]

I adjusted autofix to handle comments in 3.8.0-alpha-2d2b247.0 version

[dotansimha]

Fixed in @graphql-eslint/[email protected] 🎉

[neviaumi]

I tested with my production schema now

And open 1 issue (Not a big deal )
#955

One more suggestion would

Given

input Z {}
input A {}
input C {}

query {
 .....
}

It only able sort the field under Z,A,C and query

the input order didn't get sorted. it would perfect if input / type can sorted as well

[neviaumi]

Rules i configured , may be i just get wrong

 {     '@graphql-eslint/alphabetize': [
        'error',
        {
          arguments: [
            'FieldDefinition',
            'Field',
            'DirectiveDefinition',
            'Directive',
          ],
          fields: [
            'ObjectTypeDefinition',
            'InterfaceTypeDefinition',
            'InputObjectTypeDefinition',
          ],
          selections: ['OperationDefinition', 'FragmentDefinition'],
          values: ['EnumTypeDefinition'],
          variables: ['OperationDefinition'],
        },
      ],
}

[dimaMachina]

Hi @davidNHK. Currently it’s possible to sort only fields, but I can improve that in the next version. How do you think which configuration options will be the best for sorting definitions as well?

[neviaumi]

I think for the configuration, according to

https://spec.graphql.org/October2021/#sec-Documen

how about have extra config attributes named document ?
value i feel like just follow current conversion (array of string) and possible value only Definition is enough ?

so my updated config may be look like that

 {     '@graphql-eslint/alphabetize': [
        'error',
        {
          arguments: [
            'FieldDefinition',
            'Field',
            'DirectiveDefinition',
            'Directive',
          ],
          fields: [
            'ObjectTypeDefinition',
            'InterfaceTypeDefinition',
            'InputObjectTypeDefinition',
          ],
          selections: ['OperationDefinition', 'FragmentDefinition'],
          values: ['EnumTypeDefinition'],
          variables: ['OperationDefinition'],
          document: ['Definition']
        },
      ],
}

[dimaMachina]

@davidNHK available in @graphql-eslint/[email protected] 🚀

[gaving]

Thanks for this, was a bit confused how to order the definitions until I added definitions: true into my custom alphabetize rule.