Skip to content

GraphQL enforce `.` at end of description strings [RUN AS-IF-FOSS]

Luke Duncalfe requested to merge ld-graphql-description-cop-periods into master

What does this MR do?

Previously our GraphQL styleguide stated that description strings should not end in periods. Descriptions provided by ruby-graphql objects all do end in periods, so our overall API is inconsistent in how it presents its schema descriptions.

This change switches our description styleguide to recommend that we add periods to the end of description strings due to this being the standard that types from graphql-ruby follow.

It also adds to the existingGraphQL/Descriptions cop to enforce this and corrects all offenses.

There is a despairingly large amount of changes in this MR due to correcting the existing offenses. To help review the code changes that are not the offense corrections, collapse the app/graphql and ee/app/graphql directories in the diff file viewer !45731 (diffs).

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Edited by Luke Duncalfe

Merge request reports

Loading